UID2 Client-Server Integration Guide for Mobile
このガイドは、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 を自動的にリフレッシュします。
このガイドの、UID2 mobile SDKs は、SDK for Android と SDK for iOS の両方を含むグループ用語です。
モバイルパブリッシャーインテグレーションに関する FAQs については、FAQs for Mobile Integrations を参照してください。
以下の手順を完了する必要があります:
- Complete the UID2 account setup and configure account.
- 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.
Mobile SDK Version
このガイドは、次のいずれかの 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 を参照してください。
Integrating with Single Sign-On (SSO)
シングルサインオン(SSO)プロバイダーとのインテグレーションに関する情報は、Publisher Integration with SSO Providers を参照してください。
Complete UID2 Account Setup and Configure Account
UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず Account Setup ページの手順に従ってください。
アカウントの初期設定が完了すると、UID2 Portal にアクセスするための手順とリンクが送信されます。ここで、本番環境用の credentials を作成し、必要に応じて追加の値を設定できます。詳細は、Getting Started with the UID2 Portal を参照してください。
Client-Server インテグレーションには、UID2 Portal の API Keys ページでこれらの値を設定する必要があります:
- API key、Client key とも呼ばれます
- Client secret、参加者と UID2 Service のみが知っている値
これらの値を安全に保管することが非常に重要です。詳細は、Security of API Key and Client Secret を参照してください。
Client-Server Mobile Integration Data Flow Overview
下記の図は、UID2 Client-Server モバイルインテグレーションを実装するためにパブリッシャーが実装する必要があるデータフローを示しています。
この例では、Client-Side のモバイルアプリで SDK for Android を使用し、Server-Side で SDK for Java を使用しています。
Implement Server-Side Token Generation
モバイル向けの Client-Server UID2 インテグレーションの場合、最初のステップは、サーバーで UID2 Token を生成できるようにすることです。その後、トークンをモバイルアプリに渡して RTB ビッドストリームに送信できます。
手順や例については、Server-Side Token Generation を参照してください。
Identity
レスポンスをモバイルアプリに渡す必要があります: Configure the UID2 Mobile SDK を参照してください。
セキュリティ上の理由から、トークン生成に使用される API キーとシークレットはサーバーサイドで呼び出す必要があります。これらの値をモバイルアプリ内に保存しないでください。
Server-Side Token Refresh
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
値をモバイルアプリに渡します。
Add the UID2 Mobile SDK to Your Mobile App
インストール方法については、以下のいずれかを参照してください:
この時点で、Server-Side で生成された UID2 Identity をモバイル SDK で使用する準備が整いました。
Using the UID2 Integration Environment
デフォルトでは、この SDK は UID2 本番環境: https://prod.uidapi.com
で動作するように構成されています。代わりに UID2 インテグレーション環境を使用する場合は、UID2Manager の初期化時に次の URL を指定してください。
各環境の認証情報を取得する方法については、Getting Your Credentials を参照してください。
- Android
- iOS
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")!
)
次のような環境間の違いに注意してください:
- UID2 インテグレーション環境のトークンは、ビッドストリームに渡しても有効ではありません。
- 各環境(インテグレーションおよび本番)には異なる API Key とクライアントシークレット値があります。各環境で正しい値を使用してください。
Optional: Specifying the API Base URL to Reduce Latency
デフォルトでは、この SDK は米国の UID2 本番環境サーバーにリクエストを送信します。
ユースケースに最適な URL を選択する方法と、有効なベース URL の完リストについては、Environments を参照してください。
異なる UID2 サーバーを指定す るには、init
呼び出しで変更してください:
- Android
- iOS
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")!
)
Configure the UID2 Mobile SDK
モバイルアプリで UID2Manager
を正しくインスタンス化した後、Server-Side で生成された UID2 identity を渡し (Implement server-side token generation を参照)、以下のようにモバイルアプリに渡してください:
- Android
- iOS
UID2Manager.getInstance().setIdentity()