| title | sidebar_label | pagination_label | description | hide_table_of_contents | sidebar_position |
|---|---|---|---|---|---|
UID2 Client-Server Integration Guide for Mobile |
Client-Server Integration for Mobile |
UID2 Client-Server Integration Guide for Mobile |
トークンをサーバーで生成し、クライアントで更新するモバイルインテグレーションの設定。 |
false |
4 |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Link from '@docusaurus/Link'; import ExampleAdvertisingToken from '../snippets/_example-advertising-token.mdx'; import EnableLogging from '../snippets/_mobile-docs-enable-logging.mdx'; import GMAIMA_Plugins from '../snippets/_mobile_docs_gmaima-plugin-gss.mdx'; import PrebidMobileSDK from '../snippets/_mobile_docs_prebid-mobile.mdx'; import ErrorResponseStates from '../snippets/_mobile-docs-error-response-states.mdx';
このガイドは、Public Operator または Private Operator を介して Server-Side で UID2 Token を生成し、そのトークンとユーザー ID をモバイルアプリに渡して UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けです。モバイルアプリは、そのトークンを ビッドストリーム に使用するために渡します。
これは Client-Server インテグレーションと呼ばれます。これは、いくつかのインテグレーションステップがクライアントサイドで行われ、いくつかがサーバーサイドで行われるためです。
Client-Side のみの変更で UID2 とインテグレーションしたい場合 (つまり、すべてのインテグレーション変更がモバイルアプリ内で行われる場合) は、代わりに UID2 Client-Side Integration Guide for Mobile を参照してください。
このページでは、インテグレーション手順の概要と、追加のドキュメントへのリンクを提供します。
UID2 は、Android および iOS 向けのモバイル SDK を提供しています。各 SDK には、次の機能があります:
- UID2 identity (UID2 Token と関連する値) を生成し、モバイルアプリに渡すためのメソッドを提供します。
- UID2 Token を自動的にリフレッシュします。
:::note このガイドの、UID2 mobile SDKs は、SDK for Android と SDK for iOS の両方を含むグループ用語です。 :::
モバイルパブリッシャーインテグレーションに関する FAQs については、FAQs for Mobile Integrations を参照してください。
以下の手順を完了する必要があります:
- Complete the UID2 account setup.
- Implement server-side token generation.
- Add the UID2 mobile SDK to your mobile app.
- Configure the UID2 mobile SDK.
- Check that the token was successfully generated and then pass it for bidstream use.
- Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration.
このガイドは、次のいずれかの UID2 mobile SDK を使用する方法について説明します:
- SDK for Android (version 1.6.0 以降)
- SDK for iOS (version 1.7.0 以降)
正しい SDK/バージョンをモバイルアプリにインストールする手順については、Add the UID2 Mobile SDK to Your Mobile App を参照してください。
アカウントの設定を完了するには、Account Setup に記載されている手順に従ってください。
アカウントの設定が完了すると、ユニークな API Key とクライアントシークレットが送信されます。これらの値はあなたに固有であり、安全に保管することが重要です。詳細は API Key and Client Secret を参照してください。
下記の図は、UID2 Client-Server モバイルインテグレーションを実装するためにパブリッシャーが実装する必要があるデータフローを示しています。
この例では、Client-Side のモバイルアプリで SDK for Android を使用し、Server-Side で SDK for Java を使用しています。
モバイル向けの Client-Server UID2 インテグレーションの場合、最初のステップは、サーバーで UID2 Token を生成できるようにすることです。その後、トークンをモバイルアプリに渡して RTB ビッドストリームに送信できます。
手順や例については、Server-Side Token Generation を参照してください。
Identity レスポンスをモバイルアプリに渡す必要があります: Configure the UID2 Mobile SDK を参照してください。
:::warning セキュリティ上の理由から、トークン生成に使用される API キーとシークレットはサーバーサイドで呼び出す必要があります。これらの値をモバイルアプリ内に保存しないでください。 :::
UID2 mobile SDK では Token Refresh が自動的に有効になっています。Server-Side で明示的に管理する必要はありません。
モバイルアプリでの変更をできるだけシンプルにしたい場合は、Server-Side で Token Refresh を行うこともできます。
Token Refresh を Server-Side で管理し、クライアント/モバイルサイドではなく行いたい場合は、次のいずれかを使用してください:
-
POST /token/refresh エンドポイントを呼び出します。
-
UID2 Server-Side SDK のいずれかの Publisher Client クラスを使用します。これらのクラスは、リクエストを単一のメソッド呼び出しに簡素化します。
手順については、SDK for Java, Usage for Publishers, Basic Usage Server-Side Integration section または SDK for Python, Usage for Publishers, Server-Side Integration section を参照してください。
その後、このガイドの残りの部分に従って、新しくリフレッシュされた Identity 値をモバイルアプリに渡します。
インストール方法については、以下のいずれかを参照してください:
この時点で、Server-Side で生成された UID2 Identity をモバイル SDK で使用する準備が整いました。
デフォルトでは、SDK は UID2 本番環境で動作するように構成されています: https://prod.uidapi.com。代わりに UID2 インテグレーション環境を使用する場合は、UID2Manager の初期化に次の URL を指定してください:
UID2Manager.init(
context = this,
UID2Manager.Environment.Custom("https://operator-integ.uidapi.com")
)// Must be set before UID2Manager.shared is accessed
UID2Settings.shared.uid2Environment = .custom(
url: URL(string: "https://operator-integ.uidapi.com")!
):::note 次のような環境間の違いに注意してください:
- UID2 インテグレーション環境のトークンは、ビッドストリームに渡しても有効ではありません。
- 各環境（インテグレーションおよび本番）には異なる API Key とクライアントシークレット値があります。各環境で正しい値を使用してください。 :::
デフォルトでは、この SDK は米国の UID2 本番環境サーバーにリクエストを送信します。
ユースケースに最適な URL を選択する方法と、有効なベース URL の完リストについては、Environments を参照してください。
異なる UID2 サーバーを指定するには、init 呼び出しで変更してください:
UID2Manager.init(
context = this,
UID2Manager.Environment.Signapore
)
// or
UID2Manager.init(
context = this,
UID2Manager.Environment.Custom("https://global.prod.uidapi.com")
)UID2Settings.shared.uid2Environment = .singapore
// or
UID2Settings.shared.uid2Environment = .custom(
url: URL(string: "https://global.prod.uidapi.com")!
)モバイルアプリで UID2Manager を正しくインスタンス化した後、Server-Side で生成された UID2 identity を渡し (Implement server-side token generation を参照してください)、以下のようにモバイルアプリに渡してください:
UID2Manager.getInstance().setIdentity()UID2Manager.shared.setIdentity()setIdentity メソッドを呼び出すと、UID2 identity がローカルファイルストレージに永続化されます。
:::warning ローカルファイルストレージに保存されたファイルの形式、またはファイル名自体が予告なく変更される可能性があります。ファイルを直接読み取ったり更新したりしないことを勧めます。 :::
トークンを取得するには、モバイルアプリで次のように呼び出します:
UID2Manager.getInstance().getAdvertisingToken()UID2Manager.shared.getAdvertisingToken()UID2Manager への ID の追加が成功した場合、このメソッドは次のような文字列を返します:
この identity をダウンストリームに渡して RTB ビッドストリームに送信できます。
getAdvertisingToken() メソッドが null を返す場合、identity または有効なトークンが生成されていません。これにはいくつかの理由が考えられ、トラブルシューティングするためにできることは次のとおりです:
- Identity が無効です。この場合、いくつかのオプションがあります:
- 前の
setIdentity()呼び出しでエラーがあるかどうかを確認します。 - 以下のいずれかを使用して、identity のステータスを確認します:
- Android Java:
UID2Manager.getInstance().getCurrentIdentityStatus() - Android Kotlin:
UID2Manager.getInstance().currentIdentityStatus() - iOS:
UID2Manager.shared.identityStatus
- Android Java:
- 前の
- ロギングを有効にして詳細情報を取得します: Enable Logging を参照してください。
- UID2 identity 内の Advertising Token の有効期限が切れていて、Refresh Token も有効期限が切れているため、SDK がトークンをリフレッシュできません。
ID が無効の場合、Implement Server-Side Token Generation に従って新しい identity を生成し、その結果をモバイルアプリの UID2Manager に再度渡してください。
UID2 SDK が新しい UID2 identity を再度必要とするかどうかを判断するための最良の方法は、すべてのケースで getAdvertisingToken() メソッドを呼び出すことです:
UID2Manager.getInstance().getAdvertisingToken()UID2Manager.shared.getAdvertisingToken()アプリの起動/再開時に、getAdvertisingToken() が null を返す場合、Implement Server-Side Token Generation の手順に従ってサーバーで、新しい identity を生成してください。その後、モバイルアプリの UID2Manager に結果を再度渡してください: Configure the UID2 Mobile SDK を参照してください。
デフォルトでは、有効な UID2 ID が UID2Manager に渡されると、自動的にトークンリフレッシュが実行されます。トークンリフレッシュが無効になっていた場合、次のメソッド呼び出しで有効にできます:
Android Java:
UID2Manager.getInstance().setAutomaticRefreshEnabled(false)Android Kotlin:
UID2Manager.getInstance().automaticRefreshEnabled = falseUID2Manager.shared.automaticRefreshEnabled = false<GMAIMA_Plugins />
:::important UID2 Prebid Mobile SDK インテグレーションは、UID2 SDK for Android version 1.6.0 または UID2 SDK for iOS version 1.7.0 が必要です。 :::