プライバシーリクエスト

Audience

このAPIは、Roktネットワーク上に構築する統合パートナー向けです。独自のチェックアウトに配置を統合するRoktのeコマースパートナーは、代わりにRokt Ecommerce開発者ドキュメントを使用してください。

Partnerships APIは2つのプライバシーリクエストのインターフェースを公開しています。それらは異なる対象に作用し、異なる下流システムを使用するため、別々になっています。

使用ケース	エンドポイント	対象	冪等性
ネットワークのオプトアウトまたはネットワークデータ削除	POST /v1/partnership/network-privacy-requests	Roktネットワークのエンドユーザー、メール、電話、またはハッシュ化されたメールで識別	Idempotency-Keyなし; バックオフ後にのみ再試行
アカウントレベルのデータ削除	POST /v1/partnership/accounts/{account_id}/data-deletion-requests	親アカウントが所有する管理された商人アカウント	Idempotency-Keyが必要; 同じキーで安全に再試行可能

Choose the surface by subject

Rokt Adsからのオプトアウトを要求する消費者や、その識別子に結びついたRoktネットワークデータを削除するためには、network-privacy-requestsを使用してください。あなたのプラットフォームが管理する商人アカウントに結びついたデータを削除するためには、accounts/{account_id}/data-deletion-requestsを使用してください。

ネットワークプライバシーリクエスト

APIトークンと親アカウントIDを使用して、ネットワークのオプトアウトおよびネットワークデータ削除リクエストを送信します:

curl -X POST "https://accounts.rokt.com/v1/partnership/network-privacy-requests?parent_account_id=$PARENT_ACCOUNT_ID" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requestType": "NETWORK_OPT_OUT",
    "email": "consumer@example.com"
  }'

エンドポイントは、Roktがリクエストを下流に送信した後、202 Acceptedを返します。パートナーシップ操作を作成せず、標準の応答エンベロープを返しません。

X-Network-Privacy-Request-Iduuid

サポートおよび監査のためのRokt生成のプライバシーリクエストID。

request_iduuid

応答本文内の同じリクエストID。

statusstring

現在のライフサイクル状態。今日の提出状態はsubmittedです。

識別子ルール

requestType	受け入れられる識別子	拒否される識別子	下流アクション
NETWORK_OPT_OUT	emailまたはphoneのいずれか一つ	sha256Email; emailとphoneの両方を送信	Roktのプライバシー/コンセントサービスにOPT_OUTを提出
NETWORK_DATA_DELETION	emailまたはsha256Emailのいずれか一つ	phone; emailとsha256Emailの両方を送信	削除されたネットワークユーザーデータに対してRoktが使用する同じネットワーク抑制アクションを送信

sha256Emailは、16進文字列ではなく、base64エンコードされたSHA256ダイジェストでなければなりません。

curl -X POST "https://accounts.rokt.com/v1/partnership/network-privacy-requests?parent_account_id=$PARENT_ACCOUNT_ID" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requestType": "NETWORK_DATA_DELETION",
    "sha256Email": "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  }'

消費者が同じメールに対して削除とオプトアウトの両方を要求する場合、1つのネットワーク削除提出で十分です。Roktは削除されたネットワークユーザーデータを将来の広告適格性から抑制されたものとみなします。

アカウントレベルのデータ削除

管理された商人アカウントのアカウントレベル削除を、管理されたaccount_id、親アカウントヘッダー、および冪等性キーを渡して送信します:

curl -X POST "https://accounts.rokt.com/v1/partnership/accounts/$ACCOUNT_ID/data-deletion-requests" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "X-Platform-Parent-Account-Id: $PARENT_ACCOUNT_ID" \
  -H "Idempotency-Key: $(uuidgen)"

Roktは、親アカウントが管理されたアカウントを所有していることを確認した後、データ削除アカウントAPIにリクエストを送信します。リクエストボディは空であり、ターゲットアカウントはパスから取得されます。

応答は標準のパートナーシップエンベロープを使用し、202 Acceptedを返します:

{
  "status": 202,
  "error": null,
  "message": "accepted",
  "request_id": "0e3a1b9c-1234-4abc-9def-aaaabbbbcccc",
  "data": {
    "request_id": "dad24980-de21-43e5-839b-cf66f840d9d1",
    "account_id": "<your-account-id>",
    "status": "submitted",
    "downstream_request_id": "delete-account-1",
    "message": "Partnership account data deletion request submitted to the Data Deletion API."
  }
}

両方の応答ヘッダーをキャプチャします:

X-Operation-Iduuid

パートナーシップ操作ID。クライアントが応答を失った場合や完了を確認する必要がある場合は、GET /v1/partnership/operations/{operation_id}をポーリングします。

X-Partnership-Account-Data-Deletion-Request-Iduuid

Rokt生成のアカウントデータ削除リクエストID。

Dry-run

下流の削除サービスに送信せずに、認証、所有権、冪等性、およびリクエストルーティングを検証するために、?dry_run=true を追加します:

curl -X POST "https://accounts.rokt.com/v1/partnership/accounts/$ACCOUNT_ID/data-deletion-requests?dry_run=true" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "X-Platform-Parent-Account-Id: $PARENT_ACCOUNT_ID" \
  -H "Idempotency-Key: $(uuidgen)"

Dry-run のレスポンスには dry_run: true が含まれ、downstream_request_id は省略され、X-Operation-Id は含まれません。なぜなら、操作は永続化されないからです。Dry-run は冪等性キーを消費するため、実際の削除リクエストには新しいキーを使用してください。

データ処理

Accounts API は認証された入口層として機能します。ネットワークプライバシーリクエストのために生の消費者識別子を永続化せず、プライバシー下流からのレスポンスボディを永続化しません。

関連

Idempotency Keys

アカウントレベルの削除は通常のパートナーシップ冪等性契約を使用します。

Operation Polling

アカウントレベルの削除結果を回復するために X-Operation-Id を使用します。