カスタムオーディエンスインポートAPI
当社のデータ管理プラットフォームでは、Roktが好みの頻度でカスタムオーディエンスデータを受け取ることができます。広告主としてRoktと連携している場合、これらのリストはキャンペーンで使用され、特定の顧客をターゲットにしたり、オファーを表示しないようにするために使用できます。パートナーとしてRoktと連携している場合、これらのリストは、お客様のサイトでRoktのエクスペリエンスを表示する顧客を決定するために使用できます。
Roktへのカスタムオーディエンスデータの配信方法として、APIの使用が一般的です。
Roktに送信する前に、リクエストをバッチ処理することをおすすめします（リクエストごとに最大100万件の連絡先）。これを1日に複数回（または好みの頻度で）行うことができます。
エンドポイント
| エンドポイントURL | https://data.rokt.com/api/1.0/import/suppression |
|---|
APIはJSONペイロードを受け入れます。Content-Typeヘッダをapplication/jsonに設定する必要があります。
認証
APIは、リクエストの一部として認証ヘッダーを期待しています。これは、Roktプラットフォームのアカウントにデータを送信するための適切な権限を持っていることを確認するためです。認証ヘッダーの値は、アカウントの固有のAPIキーである必要があります。この値を取得するには、アカウントマネージャーに連絡してください。
パラメーター
リクエストボディには、以下のいずれかのキーが必ず存在している必要があります。
ハッシュ化されたメールアドレスを使用する場合は、ハッシュ化する前にメールアドレスからすべての空白を削除し、小文字に変換してください。
| パラメーター | 説明 |
|---|---|
| 単一のメールアドレス | |
| emails | メールアドレスの配列 |
| sha256 | 単一のSHA-256ハッシュされたメールアドレス |
| sha256s | SHA-256ハッシュされたメールアドレスの配列 |
追加のパラメーターは次のとおりです。
| パラメーター | タイプ | 説明 | 例 |
|---|---|---|---|
| action | 必須 | 指定されたリストに誰かを追加する場合はincludeを使用します。 指定されたリストから誰かを削除する場合はexcludeを使用します。 | include exclude |
| list | オプション | 使用するカスタムオーディエンスリストの名前。 listの値が指定されていない場合、デフォルトでメールアドレスはAdvertiserDatabaseリストにインポートされます。 | US_Customers |
制限
| タイプ | 制限 |
|---|---|
| リクエストサイズ | 1リクエストあたり1000通のメール |
| レート制限 | 1秒あたり1回 |
| 同時実行制限 | 1 |
上記の制限は、このAPIにおいて推奨されています。より大きな数値でも成功することがありますが、推奨されていません。
レスポンスの処理
| HTTPステータスコード | ボディ | 説明 |
|---|---|---|
| 201 | 作成 | メールがカスタムオーディエンスリストに正常に追加または削除されました。 |
| 400 | 不正なリクエスト | 必須フィールドが欠落しているか、リクエストが間違った形式で送信された場合、400 Bad Requestが返されます。 |
コマンドラインの例
curlコマンドがインストールされているLinuxまたはMac OS Xシステムでは、次のコマンドを使用してメールアドレスalice@example.comとbob@example.comをインポートします。API_KEY環境変数がAPIキーに設定されていることを前提としています:
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"}'
次のコマンドは、単一のSHA256ハッシュ「1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206」をUS_Customersというカスタムオーディエンスリストにインポートします。この文字列はhello@example.comのSHA256ハッシュです（ハッシュは小文字のメールアドレスのものと想定しているため、カスタムオーディエンスリストに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ウィジェットを表示しません。