SDK for Java Reference Guide

Server-Side で Java SDK を使用すると、UID2 を使用してクライアント ID を生成または確立し、ビッドストリームで使用する Advertising Token を取得し、UID2 Token を自動的にリフレッシュするプロセスを簡素化できます。適用可能な権限がある場合、共有のために暗号化および復号化し、DII を raw UID2 にマップすることもできます。

Functionality

この SDK は、Server-Side のコーディングに Java を使用しているパブリッシャー、DSP、広告主、データプロバイダー、UID2 Sharers のために、UID2 とのインテグレーションを簡素化します。次の表に、この SDK がサポートする機能を示します。

Encrypt Raw UID2 to UID2 Token for Sharing	Decrypt UID2 Token to Raw UID2	Generate UID2 Token from DII	Refresh UID2 Token	Map DII to Raw UID2s	Monitor Rotated Salt Buckets
✅	✅	✅	✅	✅	—

UID2 Account Setup

UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、最初に Account Setup ページの手順に従ってください。

API Permissions

アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、UID2 Portal にアクセスするための手順とリンクが送信されます。以下の操作が可能です:

アカウント用の credentials を生成します。
オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。

SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、API Permissions を参照してください。

DSP の場合は、資格情報を送信します。

Version

この SDK には Java version 1.8 以降が必要です。

GitHub Repository/Binary

この SDK は以下のオープンソースの GitHub リポジトリにあります:

SDK for Java

バイナリは Maven リポジトリで公開されています:

https://central.sonatype.com/artifact/com.uid2/uid2-client

Initialization

初期化ステップは、次の表に示すように、役割によって異なります。

Role	Create Instance of Class	Link to Instructions
Publisher	`PublisherUid2Client`	Usage for Publishers
Advertiser/Data Provider	`IdentityMapClient`	Usage for Advertisers/Data Providers
DSP	`BidstreamClient`	Usage for DSPs
Sharer	`SharingClient`	Usage for UID2 Sharers

SDK が UID2 Service で認証するために必要な値を提供する必要があります。

Parameter	Description
`baseUrl/uid2BaseUrl`	The endpoint for the UID2 service. See Environments.
`clientApiKey`	The API key. See UID2 Credentials.
`base64SecretKey`	The client secret. See UID2 Credentials.

Interface

BidstreamClient クラスを利用すると UID2 Token を raw UID2 に復号化できます。

ユーザーのオプトアウトを処理する入札ロジックの詳細は DSP Integration Guide を参照してください。

SharingClient クラスを利用すると、raw UID2 を UID2 Token に暗号化し、UID2 Token を raw UID2 に復号化することができます。

注記

SDK を使用する際に、復号鍵を保存したり管理したりする必要はありません。

Encryption Response Content

SharingClient クラスで暗号化する場合、SDK は次の表に示す情報を返します。

Method	Description
`getStatus()`	暗号化結果のステータス。取り得る値のリストと定義は、Encryption Response Statuses を参照してください。
`getEncryptedData()`	暗号化された UID2 token。

Encryption Response Statuses

暗号化レスポンスコードとその意味は次の表の通りです。

Value	Description
`SUCCESS`	raw UID2 は正常に暗号化され、UID2 Token が返されました。
`NOT_AUTHORIZED_FOR_KEY`	呼び出し元は暗号化キーを使用する権限を持っていません。
`NOT_AUTHORIZED_FOR_MASTER_KEY`	呼び出し元はマスターキーを使用する権限を持っていません。
`NOT_INITIALIZED`	クライアントライブラリは初期化待ちです。
`KEYS_NOT_SYNCED`	クライアントが UID2 Service との鍵の同期に失敗しました。
`ENCRYPTION_FAILURE`	一般的な暗号化に失敗しました。

Decryption Response Content

BidstreamClient クラスと SharingClient クラスのどちらで復号化しても、SDK は次の表に示す情報を返します。

Methods	Description
`getStatus()`	復号結果のステータス。取り得る値のリストと定義は、Decryption Response Statuses を参照してください。
`getUid()`	UID2 Token に対応する raw UID2
`getEstablished()`	ユーザーがパブリッシャーと最初に UID2 を確立した時のタイムスタンプ。

Decryption Response Statuses

復号化レスポンスコードとその意味は次の表の通りです。

Value	Description
`SUCCESS`	UID2 Token は正常に復号化され、raw UID2が返されました。
`NOT_AUTHORIZED_FOR_KEY`	呼び出し元はこの UID2 Token を復号化する権限を持っていません。
`NOT_INITIALIZED`	クライアントライブラリは初期化待ちです。
`INVALID_PAYLOAD`	受信した UID2 Token は有効なペイロードではありません。
`EXPIRED_TOKEN`	受信した UID2 Token の有効期限が切れました。
`KEYS_NOT_SYNCED`	クライアントが UID2 Service との鍵の同期に失敗しました。
`VERSION_NOT_SUPPORTED`	クライアントライブラリが暗号化トークンのバージョンをサポートしていません。
`INVALID_TOKEN_LIFETIME`	トークンのタイムスタンプが無効です。

Usage for Publishers

パブリッシャーとして、SDK for Java を使用するには 2 つの方法があります:

Basic Usage は、この SDK の HTTP 実装 (synchronous OkHttp) を使いたいパブリッシャー向けです。
Advanced Usage は、独自の HTTP ライブラリを使用したいパブリッシャー向けです。

Basic と Advanced 両方の使い方を示すサンプルアプリケーションは、Java UID2 Integration Example を参照してください。

Basic Usage

SDK の HTTP 実装を使用している場合は、以下の手順に従ってください。

インスタンス変数として PublisherUid2Client のインスタンスを作成します:

private final PublisherUid2Client publisherUid2Client = new PublisherUid2Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

ユーザーのメールアドレスまたは電話番号を入力として受け取り、TokenGenerateResponse オブジェクトを生成する関数を呼び出します。以下の例では、メールアドレスを使用しています:
```
TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail("user@example.com").doNotGenerateTokensForOptedOut());
```
important
常に doNotGenerateTokensForOptedOut() を適用します。これは POST /token/generate エンドポイントの呼び出しで optout_check=1 を設定するのと同様のパラメータを適用します(Unencrypted JSON Body Parameters) を参照してください。

Basic Usage, Client-Server Integration

Standard Integration (Client and Server) を使用している場合(Client-Server Integration Guide for JavaScript を参照)、このステップに従ってください：

この ID を JSON 文字列としてクライアントに送り返します (identity field で使用するため):
```
tokenGenerateResponse.getIdentityJsonString()
```
注記
ユーザーがオプトアウトした場合、このメソッドは null を返しますので、必ず処理してください。

Basic Usage, Server-Side Integration

Server-Side Integration (Publisher Integration Guide, Server-Side を参照) を使用している場合は、以下の手順に従ってください:

tokenGenerateResponse.getIdentityJsonString() 関数を使用して、この ID をユーザーのセッションに JSON 文字列として格納します。

ユーザーがオプトアウトした場合、このメソッドは null を返します。

ユーザーの UID2 Token を取得するには、以下を使用します:

IdentityTokens identity = tokenGenerateResponse.getIdentity();
if (identity != null) { String advertisingToken = identity.getAdvertisingToken(); }

ユーザーが別のページにアクセスしたときや、タイマーで、更新が必要かどうかを判断します:
1. ユーザーのセッションから ID の JSON 文字列を取得し、ID 情報を入力として受け取って IdentityTokens オブジェクトを生成する以下の関数を呼び出します：
```
IdentityTokens identity = IdentityTokens.fromJsonString(identityJsonString);
```
2. ID をリフレッシュできるかどうか (Refresh Token の有効期限が切れていないかどうか) を判断します:
```
if (identity == null || !identity.isRefreshable()) { 
    // we must no longer use this identity (for example, remove this identity from the user's session) 
}
```
3. リフレッシュが必要かどうかを判断します:
```
if (identity.isDueForRefresh()) {..}
```

必要であれば、トークンと関連する値をリフレッシュします:

TokenRefreshResponse tokenRefreshResponse = publisherUid2Client.refreshToken(identity);

ユーザーのセッションに tokenRefreshResponse.getIdentityJsonString() を格納します。

ユーザーがオプトアウトした場合、このメソッドは null を返し、ユーザーの ID をセッションから削除する必要があることを示します。オプトアウトを確認するには、tokenRefreshResponse.isOptout() 関数を使用します。

Advanced Usage

インスタンス変数として PublisherUid2Helper のインスタンスを作成します:

private final PublisherUid2Helper publisherUid2Helper = new PublisherUid2Helper(UID2_SECRET_KEY);

ユーザーのメールアドレスまたは電話番号を入力として受け取り、安全なリクエストデータエンベロープを作成する関数を呼び出します。Encrypting requests を参照してください。以下の例ではメールアドレスを使用しています:
```
EnvelopeV2 envelope = publisherUid2Helper.createEnvelopeForTokenGenerateRequest(TokenGenerateInput.fromEmail("user@example.com").doNotGenerateTokensForOptedOut());
```
選択した HTTP クライアントライブラリを使用して、ヘッダーとボディを含むこのエンベロープを POST token/generate エンドポイントにポストします:
1. Headers: HTTP ライブラリによっては、以下のようになります:
  
  .putHeader("Authorization", "Bearer " + UID2_API_KEY)
  .putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHttpHeader())
2. Body: envelope.getEnvelope()
important
に doNotGenerateTokensForOptedOut() を適用してください。これは POST /token/generate エンドポイントの呼び出しで optout_check=1 を設定するのと同様のパラメータを適用します (Unencrypted JSON Body Parameters を参照)。
HTTP レスポンスステータスコードが 200 でない場合は、Response Status Codes を参照して次のステップを決定します。そうでない場合は、UID2 ID レスポンスの内容を TokenGenerateResponse オブジェクトに変換します:
```
TokenGenerateResponse tokenGenerateResponse = publisherUid2Helper.createTokenGenerateResponse({response body}, envelope);
```

Advanced Usage, Client-Server Integration

Standard Integration (client and server) を使用している場合 (Client-Server Integration Guide for JavaScript を参照)、以下の手順に従ってください:

この ID を JSON 文字列としてクライアントに送り返します (identity field で使用するため):
```
tokenGenerateResponse.getIdentityJsonString()
```
注意
ユーザーがオプトアウトした場合、このメソッドは null を返しますので、必ず処理してください。

Advanced Usage, Server-Side Integration

Server-Side Integration (Publisher Integration Guide, Server-Side を参照) を使用している場合は、以下の手順に従ってください:

tokenGenerateResponse.getIdentityJsonString() を使用して、この ID をユーザーのセッションに JSON 文字列として保存します。

このメソッドは、ユーザーがオプトアウトした場合は null を返すので、必ず処理してください。

ユーザーの UID2 Token を取得するには、以下を使用します:

IdentityTokens identity = tokenGenerateResponse.getIdentity();
if (identity != null) { String advertisingToken = identity.getAdvertisingToken(); }

ユーザーが別のページにアクセスしたときや、タイマーで、更新が必要かどうかを判断します:
1. ユーザーのセッションから ID JSON 文字列を取得し、IDentityTokens オブジェクトを生成する以下の関数を呼び出します:
```
IdentityTokens identity = IdentityTokens.fromJsonString(identityJsonString);
```
2. ID をリフレッシュできるかどうか (Refresh Token の有効期限が切れていないかどうか) を判断します:
```
if (identity == null || !identity.isRefreshable()) { 
    // we must no longer use this identity (for example, remove this identity from the user's session) 
}
```
3. リフレッシュが必要かどうかを判断します:
```
if (identity.isDueForRefresh()) {..}
```
リフレッシュが必要な場合は、POST token/refreshエンドポイントを、以下のように呼び出します:
1. Headers: HTTPライブラリによっては、次のようになります:
  
  .putHeader("Authorization", "Bearer " + UID2_API_KEY)
  .putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHttpHeader()).
2. Body: identity.getRefreshToken()

Refresh HTTP レスポンスステータスコードが 200 の場合:

TokenRefreshResponse tokenRefreshResponse = PublisherUid2Helper.createTokenRefreshResponse({response body}, identity);

ユーザーのセッションに tokenRefreshResponse.getIdentityJsonString() を格納します。

ユーザーがオプトアウトした場合、このメソッドは null を返し、ユーザーの ID をセッションから削除する必要があることを示します。オプトアウトを確認するには、tokenRefreshResponse.isOptout() 関数を使用します。

Usage for Advertisers/Data Providers

IdentityMapClient のインスタンスをインスタンス変数として作成します:

final private IdentityMapV3Client identityMapV3Client = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

メールアドレスまたは電話番号を入力として受け取り、IdentityMapResponse オブジェクトを生成する関数を呼び出します。以下の例では、メールアドレスを使用しています:

IdentityMapV3Input input = IdentityMapV3Input.fromEmails(Arrays.asList("user@example.com", "user2@example.com"));

複数の ID タイプを組み合わせることもできます:

IdentityMapV3Input input = new IdentityMapV3Input()
    .withEmail("user@example.com")
    .withPhone("+12345678901")
    .withHashedEmail("preHashedEmail")
    .withHashedPhone("preHashedPhone");

input を受け取り、IdentityMapV3Response オブジェクトを生成する関数を呼び出します:
```
IdentityMapV3Response identityMapResponse = identityMapV3Client.generateIdentityMap(input);
```

マッピングされた結果とマッピングされていない結果を取得します:

HashMap<String, IdentityMapV3Response.MappedIdentity> mappedIdentities = identityMapResponse.getMappedIdentities();
HashMap<String, IdentityMapV3Response.UnmappedIdentity> unmappedIdentities = identityMapResponse.getUnmappedIdentities();

結果を処理します。マッピングされた ID が成功した場合は、以下のようにします:

IdentityMapV3Response.MappedIdentity mappedIdentity = mappedIdentities.get("user@example.com");
if (mappedIdentity != null) {
    String currentUid = mappedIdentity.getCurrentRawUid();     // Current raw UID2
    String previousUid = mappedIdentity.getPreviousRawUid();   // Previous raw UID2 (nullable, only available for 90 days after rotation)
    Instant refreshFrom = mappedIdentity.getRefreshFrom();     // When to refresh this identity
} else {
    IdentityMapV3Response.UnmappedIdentity unmappedIdentity = unmappedIdentities.get("user@example.com");
    UnmappedIdentityReason reason = unmappedIdentity.getReason(); // OPTOUT, INVALID_IDENTIFIER, or UNKNOWN
}

Note: SDKは、メールアドレスの正規化とハッシュ化を自動的に処理し、生のメールアドレスや電話番号がサーバーから送信されないようにします。

Usage Example

IdentityMapV3Client client = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

// Example 1: Single identity type
IdentityMapV3Input emailInput = IdentityMapV3Input.fromEmails(
    Arrays.asList("user@example.com", "optout@example.com")
);
IdentityMapV3Response emailResponse = client.generateIdentityMap(emailInput);

// Process email results
emailResponse.getMappedIdentities().forEach((email, identity) -> {
    System.out.println("Email: " + email);
    System.out.println("Current UID: " + identity.getCurrentRawUid());
    System.out.println("Previous UID: " + identity.getPreviousRawUid());
    System.out.println("Refresh from: " + identity.getRefreshFrom());
});

emailResponse.getUnmappedIdentities().forEach((email, identity) -> {
    System.out.println("Unmapped email: " + email + " - Reason: " + identity.getReason());
});

// Example 2: Mixed identity types in single request
IdentityMapV3Input mixedInput = new IdentityMapV3Input()
    .withEmail("user1@example.com")
    .withPhone("+12345678901")
    .withHashedEmail("preHashedEmailValue")
    .withHashedPhone("preHashedPhoneValue");

IdentityMapV3Response mixedResponse = client.generateIdentityMap(mixedInput);

Migration From Version Using v2 Identity Map

以下のセクションでは、この SDK の最新バージョンへの移行に関する一般的な情報とガイダンスを提供します。最新バージョンは POST /identity/map バージョン 3 を参照しています:

Version 3 Improvements
Required Changes
Recommended Changes

Version 3 Improvements

POST /identity/map エンドポイントのバージョン 3 では、v2 から以下の改善が行われています:

Support for multiple identity types: 1 回のリクエストでメールアドレスと電話番号の両方を処理できます。
Simpler refresh management: ソルトバケットを監視する代わりに、リフレッシュのタイムスタンプに達した raw UID2 を再マッピングするだけで済みます。ソルトバケットの監視は、別の API 呼び出しです。
Availability of previous raw UID2: ローテーション後90日間、以前の UID2 を見ることができます。
Improved performance: 新しい API バージョンでは、同じ量の個人データに対して必要な帯域幅が大幅に削減されています。

Required Changes

アップグレードするには、以下の手順に従ってください:

Update dependency version
Change client class
Update import statements

1. Update dependency version

コード内で参照されている依存関係のバージョンを、次の例のように更新します。

<dependency>
  <groupId>com.uid2</groupId>
  <artifactId>uid2-client</artifactId>
  <version>4.8.0</version>
</dependency>

2. Change client class

コード内で参照されているクライアントクラスを更新します。以下の例を参照してください。

// Before
IdentityMapClient identityMapClient = new IdentityMapClient(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

// After
IdentityMapV3Client identityMapClient = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

3. Update import statements

以下の例のように、インポートステートメントを更新します。

import com.uid2.client.IdentityMapV3Client;
import com.uid2.client.IdentityMapV3Input;
import com.uid2.client.IdentityMapV3Response;
import com.uid2.client.UnmappedIdentityReason;

Recommended Changes

以下の変更はオプションですが、新しい v3 機能を活用できます。必須の変更で基本的な機能は十分ですが、これらの推奨される変更により、機能が向上します。

Mix identity types in a single request - 1 回のリクエストでメールアドレスと電話番号の両方を処理します:

// Before - single identity type only
IdentityMapInput input = IdentityMapInput.fromEmails(Arrays.asList("user@example.com"));

// After - can mix identity types (new v3 capability)
IdentityMapV3Input input = new IdentityMapV3Input()
    .withEmail("user@example.com")
    .withPhone("+12345678901")
    .withHashedEmail("preHashedEmail")
    .withHashedPhone("preHashedPhone");

Access previous UID2s - 90 日間の測定継続性のために、現在の UID2 と以前の UID2 の両方を取得します:

// Before - only current UID2 available
IdentityMapResponse response = client.generateIdentityMap(input);
MappedIdentity mapped = response.getMappedIdentities().get("user@example.com");
String uid = mapped.getRawUid();

// After - access to both current and previous UID2s
IdentityMapV3Response response = client.generateIdentityMap(input);
IdentityMapV3Response.MappedIdentity mapped = response.getMappedIdentities().get("user@example.com");
String currentUid = mapped.getCurrentRawUid();
String previousUid = mapped.getPreviousRawUid();  // Available for 90 days after rotation
Instant refreshFrom = mapped.getRefreshFrom();

Use structured error reasons - マッピングされない理由を文字列ではなく、肩安全な列挙方として取得します:

// Before - string-based error reasons
IdentityMapResponse.UnmappedIdentity unmapped = identityMapResponse.getUnmappedIdentities().get("user@example.com");
String reason = unmapped.getReason();

// After - structured enum-based error reasons
IdentityMapV3Response.UnmappedIdentity unmapped = response.getUnmappedIdentities().get("user@example.com");
UnmappedIdentityReason reason = unmapped.getReason(); // Enum: OPTOUT, INVALID_IDENTIFIER, UNKNOWN

// Or continue using string reasons if preferred
String rawReason = unmapped.getRawReason();

Previous SDK Version (using POST /identity/map v2)

注記

下位互換性のために、POST /identity/map v2 エンドポイントを参照する SDK for Java の以前のバージョンも利用可能です。パフォーマンスの向上、複数の ID タイプのサポート、UID ローテーション管理の改善のために、現在の SDK に移行してください。新しいインテグレーションではこのバージョンを使用しないでください。詳細は Migration From Version Using v2 Identity Map を参照してください。

以前のバージョンを使用するには、以下の手順に従ってください。

IdentityMapClient のインスタンスをインスタンス変数として作成します:

final private IdentityMapClient identityMapClient = new IdentityMapClient(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

メールアドレスまたは電話番号を入力として受け取り、IdentityMapResponse オブジェクトを生成する関数を呼び出します。以下の例ではメールアドレスを使用しています:
```
IdentityMapResponse identityMapResponse = identityMapClient.generateIdentityMap(IdentityMapInput.fromEmails(Arrays.asList("email1@example.com", "email2@example.com")));
```
Note: SDK は、送信する前に入力値をハッシュ化します。これにより、生のメールアドレスや電話番号がサーバーから出ることはありません。

マッピングされた結果とマッピングされていない結果を次のように取得します:

Map<String, IdentityMapResponse.MappedIdentity> mappedIdentities = identityMapResponse.getMappedIdentities();
Map<String, IdentityMapResponse.UnmappedIdentity> unmappedIdentities = identityMapResponse.getUnmappedIdentities();

マッピングされた結果とマッピングされていない結果を反復処理するか、ルックアップを行います。次の例ではルックアップを行います:

IdentityMapResponse.MappedIdentity mappedIdentity = mappedIdentities.get("email1@example.com");
if (mappedIdentity != null) {
     String rawUid = mappedIdentity.getRawUid();
} else {
     IdentityMapResponse.UnmappedIdentity unmappedIdentity = unmappedIdentities.get("email1@example.com");
     String reason = unmappedIdentity.getReason();
}

Usage for DSPs

以下の手順は、DSP が SDK for Java を使用して bidstream のトークンを復号化する方法の例を示しています。

BidstreamClient のインスタンスを作成します:

BidstreamClient client = new BidstreamClient(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

起動時に 1 回リフレッシュし、その後定期的にリフレッシュします (推奨されるリフレッシュ間隔は 1 時間ごとです):

client.refresh();

トークンを raw UID2 に復号化します。トークンを渡し、次のいずれかを行います:
- ビッドリクエストがパブリッシャーのウェブサイトから発信された場合は、ドメイン名を渡します。ドメイン名はすべて小文字で、スペースやサブドメインなしで指定する必要があります。たとえば、Subdomain.DOMAIN.com の場合は、代わりに domain.com を渡します。
- ビッドリクエストがモバイルアプリから発信された場合は、アプリ名を渡します。
- それ以外の場合は、null を渡します。

DecryptionResponse decrypted = client.decryptTokenIntoRawUid(uidToken, domainOrAppName); 
//If decryption succeeded, use the raw UID2.
if (decrypted.isSuccess()) 
{
    //Use decrypted.getUid()
}
else 
{
    // Check decrypted.getStatus() for the failure reason.
}

詳細な例は、test/IntegrationExamples.java を参照してください。

Usage for UID2 Sharers

UID2 共有参加者は、送信者または受信者として共有に参加し、他の参加者と UID2 を共有する企業です。

広告主およびデータプロバイダーは、この SDK を使用して、他の承認された UID2 共有参加者と UID2 を共有できます (トークン化された共有)。彼らは raw UID2 を UID2 Token に暗号化し、それを共有のために別の参加者に送信できます (ピクセルでの Tokenized Sharing in Pixelsを参照)。ピクセルでデータを送信しない場合は、Security Requirements for UID2 Sharingに記載されている要件に従う限り、UID2 共有に参加できます。

important

このプロセスで生成される UID2 Token は共有専用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります: Tokenized Sharing in the Bidstreamを参照してください。

以下の手順は、SDK for Java を使用して、送信者または受信者として共有を実装する方法の例を示しています。

インスタンス変数として SharingClient のインスタンスを作成します:

SharingClient client = new SharingClient(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

起動時に 1 回リフレッシュし、その後定期的にリフレッシュします (推奨されるリフレッシュ間隔は 1 時間ごとです):

client.refresh();

送信者の場合は、encryptRawUidIntoToken を呼び出します:

EncryptionDataResponse encrypted = client.encryptRawUidIntoToken(raw_uid);
// If encryption succeeded, send the UID2 token to the receiver.
if (encrypted.isSuccess())
{
        // Send encrypted.getEncryptedData() to receiver
}
else
{
        // Check encrypted.getStatus() for the failure reason.
}

受信者である場合は、decryptTokenIntoRawUid を呼び出します:

DecryptionResponse decrypted = client.decryptTokenIntoRawUid(uid_token);
// If decryption succeeded, use the raw UID2.
if (decrypted.isSuccess())
{
    //  Use decrypted.getUid()
}
else
{
    // Check decrypted.getStatus() for the failure reason.
}

詳細な例は、test/IntegrationExamples.java の ExampleSharingClient メソッドを参照してください。

Functionality​

UID2 Account Setup​

API Permissions​

Version​

GitHub Repository/Binary​

Initialization​

Interface​

Encryption Response Content​

Encryption Response Statuses​

Decryption Response Content​

Decryption Response Statuses​

Usage for Publishers​

Basic Usage​

Basic Usage, Client-Server Integration​

Basic Usage, Server-Side Integration​

Advanced Usage​

Advanced Usage, Client-Server Integration​

Advanced Usage, Server-Side Integration​

Usage for Advertisers/Data Providers​

Usage Example​

Migration From Version Using v2 Identity Map​

Version 3 Improvements​

Required Changes​

1. Update dependency version​

2. Change client class​

3. Update import statements​

Recommended Changes​

Previous SDK Version (using POST /identity/map v2)​

Usage for DSPs​

Usage for UID2 Sharers​