カスタムオーディエンスインポートAPI
私たちのデータ管理プラットフォームは、任意の頻度でRoktにカスタムオーディエンスデータを受信させる機能を提供します。Roktと広告主として協力している場合、これらのリストはキャンペーンで特定の顧客にオファーを表示するか抑制するために使用できます。Roktとパートナーとして協力している場合、これらのリストはあなたのサイトでRoktのエクスペリエンスを表示する顧客を決定するために使用できます。
カスタムオーディエンスデータをRoktに提供する一般的な方法は、APIを使用することです。
リクエストをバッチ処理（リクエストごとに最大1千件の連絡先）してからRoktに送信することをお勧めします。これを1日に複数回（または任意の頻度で）行うことができます。
エンドポイント
| エンドポイントURL | https://data.rokt.com/api/1.0/import/suppression |
|---|
APIはJSONペイロードを受け入れます。Content-Typeヘッダーをapplication/jsonに設定する必要があります。
認証
APIはリクエストの一部として認証ヘッダーを期待しています。これは、Roktプラットフォームのアカウントにデータを送信するための適切な権限を持っていることを確認するためです。認証ヘッダーの値は、アカウントの一意のAPIキーである必要があります。この値を取得するには、アカウントマネージャーに連絡してください。
パラメータ
リクエストボディには、次のキーのうち正確に1つが存在する必要があります。
ハッシュ化されたメールを使用する場合は、最初に空白を削除し、メールアドレスを小文字にしてからハッシュ化することを確認してください。
| パラメータ | 説明 |
|---|---|
| 単一のメールアドレス | |
| emails | メールアドレスの配列 |
| sha256 | 単一のSHA-256ハッシュ化されたメール |
| sha256s | SHA-256ハッシュ化されたメールの配列 |
追加のパラメータには以下が含まれます:
| パラメータ | タイプ | 説明 | 例 |
|---|---|---|---|
| action | 必須 | 指定されたリストに誰かを追加したい場合はincludeを使用します。このリストはターゲティングまたは抑制のために使用される可能性があります。 指定されたリストから誰かを削除したい場合はexcludeを使用します。 | include exclude |
| list | 任意 | 使用するカスタムオーディエンスリストの名前。 リスト値が提供されない場合、メールアドレスはデフォルトでAdvertiserDatabaseリストにインポートされます。 | US_Customers |
制限
| タイプ | 制限 |
|---|---|
| リクエストサイズ | 1リクエストあたり2000通のメール。 |
| レート制限 | 1秒あたり4回。 |
| 同時実行制限 | 4 |
上記の制限はこのAPIに推奨されるものです。より大きな量も成功する可能性がありますが、推奨されません。
レスポンス処理
| HTTPステータスコード | 本文 | 説明 |
|---|---|---|
| 201 | Created | メールがカスタムオーディエンスリストに正常に追加または削除されました。 |
| 400 | Bad Request | 必須フィールドが欠落している場合や、リクエストが間違った形式で送信された場合に400 Bad Requestを受け取ります。 |
コマンドラインの例
curlコマンドがインストールされたLinuxまたはMac OS Xシステムで、以下のコマンドは、API_KEY環境変数がAPIキーに設定されていると仮定して、alice@example.comおよびbob@example.comのメールアドレスのインポートを実行します:
cURL
curl https://data.rokt.com/api/1.0/import/suppression --header "Authorization: $API_KEY" --header "Content-Type: application/json" --data '{"emails":["alice@example.com","bob@example.com"],"action":"include"}'
以下のコマンドは、hello@example.comのSHA256ハッシュである"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206"をUS_Customersというカスタムオーディエンスリストにインポートします（小文字のメールアドレスのハッシュを期待しているため、HELLO@EXAMPLE.COMがカスタムオーディエンスリストに含まれているかどうかを判断するためにこのハッシュを探します）:
cURL
curl https://data.rokt.com/api/1.0/import/suppression --header "Authorization: $API_KEY" --header "Content-Type: application/json" --data '{"list":"US_Customers","sha256":"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206","action":"exclude"}'
テスト
上記の例は、私たちのライブプロダクションシステムを指しています。そのため、alice@example.comのようなメールアドレスでテストすると、実際の顧客に加えて、alice@example.comもRoktのカスタムオーディエンスリストのメンバーと見なされます。例えば、このリストを除外ターゲティングに使用する場合、alice@example.comをメールアドレスとして入力した人にはRoktウィジェットを表示しません。