Protected Audience でカスタム オーディエンス委任に参加する

fetchAndJoinCustomAudience API を使用すると、購入者はパートナーの MMP または SSP のデバイス上のプレゼンスを利用して、カスタム オーディエンスへの参加を委任できます。

概要

大まかな仕組みとして、デバイス上の呼び出し元（MMP または SSP SDK）が次のような fetchAndJoinCustomAudienceRequest を作成します。

Kotlin

/**
 * @param fetchUri The URL to retrieve the CA from.
 * (optional)@param name The name of the CA to join.
 * (optional)@param activationTime The time when the CA will activate.
 * (optional)@param expirationTime The time when the CA will expire,
    must be a time in the future otherwise this will fail
 * (optional)@param userBiddingSignals The user bidding signals used at auction.
*/

val request = FetchAndJoinCustomAudienceRequest.Builder(fetchUri)
    .setName(name)
    .setActivationTime(activationTime)
    .setExpirationTime(expirationTime)
    .setUserBiddingSignals(userBiddingSignals)
    .build()

Java

/**
 * @param fetchUri The URL to retrieve the CA from.
 * (optional)@param name The name of the CA to join.
 * (optional)@param activationTime The time when the CA will activate.
 * (optional)@param expirationTime The time when the CA will expire,
    must be a time in the future otherwise this will fail
 * (optional)@param userBiddingSignals The user bidding signals used at auction.
*/

FetchAndJoinCustomAudienceRequest request =
 new FetchAndJoinCustomAudienceRequest.Builder(fetchUri)
  .setName(name) //Optional
  .setActivationTime(activationTime) //Optional
  .setExpirationTime(expirationTime) //Optional
  .setUserBiddingSignals(userBiddingSignals) //Optional
  .build();

すべてのオプション パラメータに関する重要な注意事項: フェッチ リクエストの内部でパラメータが設定されている場合、購入者から返されたデータによってパラメータのデータをオーバーライドできないため、カスタム オーディエンスに対するデバイス上の呼び出し元の追加制御は保持されます。

fetchUri は、以下に示されている形式に一致するカスタム オーディエンス JSON オブジェクトを返すサーバー エンドポイント（購入者によって運用されているもの）を指している必要があります。

//Return a 200 response with data matching the format of the following in the body
{
  "daily_update_uri": "https://js.example.com/bidding/daily",
  "bidding_logic_uri": "https://js.example.com/bidding",
  "user_bidding_signals": {
    "valid": true,
    "arbitrary": "yes"
  },
  "trusted_bidding_data": {
    "trusted_bidding_uri": "https://js.example.com/bidding/trusted",
    "trusted_bidding_keys": [
      "key1",
      "key2"
    ]
  },
  "ads": [
    {
      "render_uri": "https://js.example.com/render/fetch_and_join_ad1",
      "metadata": {
        "valid": 1
      }
    },
    {
      "render_uri": "https://js.example.com/render/fetch_and_join_ad2",
      "metadata": {
        "valid": 2
      }
    }
  ]
}

これを API で解決する方法について詳しくは、Join CA 委任の設計案をご覧ください。

テスト

クライアント コード内にフェッチ呼び出しを実装し、カスタム オーディエンス データを返すように DSP 側でエンドポイントを設定したら、カスタム オーディエンスへの参加の委任をテストできます。アプリを実行する前に、次のコマンドを実行して UI を開き、プライバシー サンドボックスを有効にする必要があります。

adb shell am start -n com.google.android.adservices.api/com.android.adservices.ui.settings.activities.AdServicesSettingsMainActivity

UI が表示されたら、プライバシー サンドボックスが有効になっているか確認してから、次の ADB コマンドを実行して、テスト用デバイスのセットアップを完了します。

adb shell device_config set_sync_disabled_for_tests persistent
adb shell device_config put adservices ppapi_app_signature_allow_list \"\*\"
adb shell device_config put adservices ppapi_app_allow_list \"\*\"
adb shell device_config put adservices adservice_system_service_enabled true
adb shell device_config put adservices adservice_enabled true
adb shell device_config put adservices adservice_enable_status true
adb shell device_config put adservices global_kill_switch false
adb shell device_config put adservices fledge_js_isolate_enforce_max_heap_size false
adb shell device_config put adservices fledge_custom_audience_service_kill_switch false
adb shell device_config put adservices fledge_select_ads_kill_switch false
adb shell device_config put adservices adid_kill_switch false
adb shell setprop debug.adservices.disable_fledge_enrollment_check true
adb shell device_config put adservices fledge_fetch_custom_audience_enabled true

これらのコマンドを実行すると、Fetch API を使用した呼び出しを開始できるようになります。

GitHub のプライバシー サンドボックス サンプル リポジトリのデベロッパー プレビュー ブランチにフェッチ呼び出しが追加されており、このフローの例を確認できます。