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

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

私たちのデータ管理プラットフォームは、Roktが任意の頻度でカスタムオーディエンスデータを受け取ることを可能にします。Roktと広告主として協力している場合、これらのリストはキャンペーンで特定の顧客にターゲットを絞ったり、オファーを見せないように抑制するために使用できます。Roktとパートナーとして協力している場合、これらのリストは、あなたのサイトでRoktエクスペリエンスを見る顧客を決定するために使用できます。

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

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

エンドポイント​

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

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

認証​

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

コンバージョンイベントを送信したいアカウントのために、Roktアカウントマネージャーに連絡して、公開鍵と秘密鍵のペアを作成してください。受け取る鍵は次の通りです:

名前値
Rokt Public Keyrpub-*****-*****
Rokt Secret Keyrsec-*****-*****

これは、Basic HTTP Auth を使用して、ユーザー名とパスワードとして使用する必要があります - これは文字列 "Basic " + base64 エンコードされた rpub-*:rsec-* の文字列です。

リクエストボディ​

リクエストボディには、次のキーのうち正確に1つが存在する必要があります。

ハッシュ化されたメールを使用する場合は、ハッシュ化する前に必ず空白を削除し、メールアドレスを小文字にしてください。

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

追加のパラメータには以下が含まれます:

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

制限​

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

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

レスポンス処理​

HTTPステータスコードボディ説明
201Createdメールがカスタムオーディエンスリストに正常に追加または削除されました。
400Bad Request必須フィールドが欠落している場合や、リクエストが誤った形式で送信された場合に400 Bad Requestを受け取ります。

コマンドライン例​

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

cURL

curl -X POST https://data.rokt.com/v3/import/suppression \
    --user "rpub-aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:rsec-aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \
    --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 \
    --user "rpub-aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:rsec-aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \
    --header "Content-Type: application/json" \
    --data '{"accountId": "REPLACE_ME", "list":"US_Customers","sha256":"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206","action":"exclude"}'

認証 (レガシー)​

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

注記

既存のユーザーおよび特定のカスタマーデータプラットフォーム (CDP) (具体的にはHightouchおよびmParticle) にオンボーディングするユーザーのみ対象です。 カスタムオーディエンスAPIの新規ユーザーおよびその他すべての統合は、よりシンプルな認証体験のために最新のエンドポイントを使用する必要があります。

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

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

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

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

Linux または Mac OS X システムで curl コマンドがインストールされている場合、以下のコマンドは、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"}'

以下のコマンドは、単一の SHA256 ハッシュ "1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206" を US_Customers というカスタムオーディエンスリストにインポートします。この文字列は hello@example.com の SHA256 ハッシュです（小文字のメールアドレスのハッシュを期待しているため、HELLO@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 '{"list":"US_Customers","sha256":"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206","action":"exclude"}'

テスト​

上記の例は、私たちの本番システムを指していますので注意してください。したがって、alice@example.com のようなメールアドレスでテストを行うと、実際の顧客に加えて、alice@example.com もRoktのカスタムオーディエンスリストのメンバーと見なされます。例えば、このリストを除外ターゲティングに使用する場合、alice@example.com をメールアドレスとして入力した人にはRoktウィジェットを表示しません。

この記事は役に立ちましたか？
Last updated Oct 29, 2025