メインコンテンツまでスキップ

カスタムオーディエンスインポートAPI

私たちのデータ管理プラットフォームは、Roktが任意の頻度でカスタムオーディエンスデータを受信する能力を提供します。あなたがRoktと広告主として協力している場合、これらのリストはキャンペーンで特定の顧客をターゲティングしたり、オファーを見ることを抑制したりするために使用できます。あなたがRoktとパートナーとして協力している場合、これらのリストは、どの顧客があなたのサイトでRoktの体験を見るかを判断するために使用できます。

カスタムオーディエンスデータをRoktに届ける一般的な方法は、APIを使用することです。

リクエストをRoktに送信する前にバッチ処理することをお勧めします。これを一日に複数回（または任意の頻度）行うことができます。

エンドポイント​

エンドポイントURLhttps://data.rokt.com/v3/import/suppression

APIはJSONペイロードを受け付けます。Content-Typeヘッダーをapplication/jsonに設定する必要があります。

認証​

注意: 現在パブリックベータ中です

Roktのアカウントマネージャーに連絡して、変換イベントを送信したいアカウントの公開鍵と秘密鍵のペアを作成してもらってください。受け取る鍵は以下の通りです：

名前値
Rokt公開鍵rpub-*****-*****
Rokt秘密鍵rsec-*****-*****

リクエストボディ​

リクエストボディには、以下の鍵のいずれかが必ず一つ含まれていなければなりません。

ハッシュ化されたメールを使用する場合は、最初に空白を取り除き、メールアドレスを小文字にしてからハッシュ化してください。

パラメータ説明
email単一のメールアドレス
emailsメールアドレスの配列
sha256単一のSHA-256ハッシュ化されたメール
sha256sSHA-256ハッシュ化されたメールの配列

追加のパラメータには次が含まれます：

パラメータタイプ説明例
accountId必須OnePlatformで見えるRoktアカウントID。123456789
action必須指定されたリストに誰かを追加したい場合は_include_を使用してください。ターゲティングまたは抑制に使用できます。
指定されたリストから誰かを削除したい場合は_exclude_を使用してください。		include
exclude
list任意使用するカスタムオーディエンスリストの名前。
リスト値が提供されない場合、メールアドレスはデフォルトでAdvertiserDatabaseリストにインポートされます。		US_Customers

限界​

種類限界
リクエストサイズ100,000 通のメールごとのリクエスト。
レート制限1 秒あたり 4 回。
同時実行制限4
注記

上記の制限はこのAPIに推奨されます。より大きな量のリクエストは成功する可能性がありますが、推奨されません。

レスポンス処理​

HTTP ステータスコード本文説明
201作成されましたメールがカスタムオーディエンスリストに正常に追加または削除されました。
400不正なリクエスト必要なフィールドが欠けている場合や、リクエストが間違った形式で送信された場合には、400 不正なリクエストが返されます。

コマンドラインの例​

curl コマンドがインストールされている Linux または Mac OS X システムで、以下のコマンドは、API_KEY 環境変数があなたの API キーに設定されていると仮定して、メールアドレス alice@example.com と bob@example.com をインポートします。

cURL

curl -X POST https://data.rokt.com/v3/import/suppression \
    --header "Authorization: Basic base64(rpub-*:rsec-*)" \
    --header "Content-Type: application/json" \
    --data '{"accountId": "REPLACE_ME", "emails":["alice@example.com","bob@example.com"],"action":"include"}'

次のコマンドは、SHA256 ハッシュ "1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206" を US_Customers というカスタムオーディエンスリストにインポートします。この文字列は hello@example.com の SHA256 ハッシュです（小文字のメールアドレスのハッシュであることを期待しているため、メールアドレス HELLO@EXAMPLE.COM がカスタムオーディエンスリストに存在するかどうかを判断するために探すべきハッシュです）：

cURL

curl -X POST https://data.rokt.com/v3/import/suppression \
    --header "Authorization: Basic base64(rpub-*:rsec-*)" \
    --header "Content-Type: application/json" \
    --data '{"accountId": "REPLACE_ME", "list":"US_Customers","sha256":"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206","action":"exclude"}'

認証 (レガシー)​

APIはリクエストの一部として認証ヘッダーを期待します。これは、Roktプラットフォームにデータを送信するための適切な権限を持っていることを確認するためです。認証ヘッダーの値は、あなたのアカウントのユニークなAPIキーである必要があります。レガシーAPIをまだ使用している場合は、この値を取得するためにアカウントマネージャーに連絡してください。

エンドポイント (レガシー)​

エンドポイントURLhttps://data.rokt.com/api/1.0/import/suppression

APIはJSONペイロードを受け入れます。Content-Typeヘッダーをapplication/jsonに設定する必要があります。リクエストボディ、API制限、およびレスポンス処理は、POST /v3/import/suppression APIとまったく同じです。

コマンドラインの例 (レガシー)​

curlコマンドがインストールされたLinuxまたはMac OS Xシステムで、次のコマンドは、環境変数API_KEYがあなたのAPIキーに設定されていることを前提として、メールアドレス alice@example.com と bob@example.com をインポートします：

cURL

curl -X POST 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"}'

次のコマンドは、"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206"という単一のSHA256ハッシュを、US_Customersというカスタムオーディエンスリストにインポートします。この文字列は、hello@example.comのSHA256ハッシュです（私たちはハッシュが小文字のメールアドレスであることを期待しているため、このメールアドレスがカスタムオーディエンスリストに含まれているかどうかを判断するために探すハッシュです）：

cURL

curl -X POST 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 のようなメールアドレスでテストを行うと、実際の顧客に加えて、Roktのカスタムオーディエンスリストのメンバーとして alice@example.com を考慮します。たとえば、このリストを除外ターゲティングに使用した場合、alice@example.com をメールアドレスとして入力した人にはRoktウィジェットを表示しません。

この記事は役に立ちましたか？