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

Event API

Event APIは、Roktとコンバージョンデータを統合したい広告主に別のオプションを提供します。Event APIを使用すると、バックエンドサーバーがRoktのサーバーと安全に接続し、リアルタイムでコンバージョンデータを送信できます。

コンバージョンデータのスタンドアロン統合としてEvent APIを使用することには、複数の利点があります：

  • 速度: 完全に自動化された、ほぼリアルタイムのデータ交換を可能にし、Roktの自動化された最適化ツールの可能性を最大化します。
  • カバレッジ: すべてのチャネルとデバイスにわたるイベントの統合を許可し、ウェブ、モバイル、店内でのコンバージョンをカバーします。
  • 信頼性: サーバー間の統合として、Event APIはブラウザや広告ブロッキングなどのウェブ技術による干渉を受けません。また、エラーハンドリングをサポートし、データが失われることがないようにします。

認証​

コンバージョンイベントを送信したいアカウントのために、公開鍵と秘密鍵のペアを作成するには、Roktのアカウントマネージャーに連絡してください。これらの鍵はそれぞれrpub-とrsec-の形式を取ります。

リクエストヘッダーを構築する​

名前値必須説明
Content-Typeapplication/jsonはいN/A
Charsetutf-8はいN/A
Rokt-Version2020-05-21はいRoktのAPIバージョン。現在の最新バージョンは2020-05-21です。
注意: このヘッダーを空にすると、最新のバージョンが適用され、後方互換性がない可能性があります。無効な値は400 bad requestを返します。
AuthorizationBasic base64(rpub-...:rsec-...)はい標準の基本認証ヘッダーで、認証情報の値はrpub-とrsec-をコロンで結合したものをbase64エンコードしたものです。
エンドポイントの完全なリファレンス

Event APIの完全なリファレンス詳細を表示します。

サンプル​

POST /v2/events
{
    "accountId": "12345",
    "events": [
        {
            "clientEventId": "ff3bd69c-ca74-4337-af91-4d5d0bd00e38",
            "eventTime": "2020-05-22T10:21:29.339Z",
          	"eventType": "conversion",
            "objectData": [
                {
                    "name": "email",
                    "value": "email123@emailserver.com"
                },
                {
                    "name": "transactionid",
                    "value": "123456789"
                },
                {
                    "name": "amount",
                    "value": "99.80"
                },
             	  {
                    "name": "currency",
                    "value": "USD"
                },
                {
                    "name": "quantity",
                    "value": "2"
                },
                {
                    "name": "conversiontype",
                    "value": "hotel_booking"
                },
                {
                    "name": "margin",
                    "value": "10"
                },
            ]
        }
    ]

推奨される objectData フィールド​

objectData オブジェクトは、イベントに関するメタデータを含むキーと値のペアで構成されています。コンバージョンを正しく帰属させるためには、objectData に email (email)、SHA-256 ハッシュ化された email (emailsha256)、または Rokt ID (passbackconversiontrackingid) のいずれかを含める必要があります。これにより、Rokt は顧客を識別できます。

コンバージョンレポートのユースケースでは、以下の属性を含めることをお勧めします。

フィールド名説明例
emailプレーンテキストで渡されたメールアドレス、小文字で末尾にスペースがないものjohn@email.com
emailsha256メールアドレスの SHA256 ハッシュ。ハッシュ化する前に、小文字で末尾にスペースがないもの。fab1e2e699b3b927cbf875046a64f222 5df02d5cb306f3857424c2bbb87be61f
passbackconversiontrackingidRokt ID とも呼ばれます。コンバージョンイベントを元のクリックにマッチさせるために使用される Rokt が生成した ID。 別の統合 が必要です。1bc29b36f623ba82aaf6724fd3b16718
amount取引の金額（小数点を許可）100.25
currency通貨コードUSD
quantity特定のコンバージョン内のアイテムの数量（整数）4
conversiontype異なるコンバージョンイベントを区別するために使用されます。注意: デフォルトのコンバージョンイベントタイプが提供されている場合にのみ適用されます。ticketpurchase, seatupgrade signup
productname購入された製品の名前。複数のアイテムをカンマで区切ることができます。Maroon 5 t-shirt, Warriors vs. Raptors
sku購入された製品の識別子（注意: 1 つの SKU のみを受け入れます）230847, tshirt-blue-39487, 398fhdnff
paymenttype取引時に使用された支払い方法VISA, American Express
marginコンバージョンの利益率を絶対値で表します。例: $10.12 の利益率の場合は 10.12。10.12
transactionidトランザクション ID。ユニークなトランザクションを識別するために使用されます。注意: 提供された場合、Rokt はこの識別子を使用してチャネル間でコンバージョンイベントを重複排除します。ABC789
confirmationref確認参照 ID。ユニークなトランザクションを識別および/または注文確認を追跡するために使用される代替識別子。注意: 提供された場合、Rokt はこの識別子を使用してコンバージョンイベントを重複排除し、transactionid が利用できない場合に使用されます。XYZ123
firstname顧客の名前John
lastname顧客の姓Smith
mobileコンバージョンした顧客の携帯電話番号3053211654, +1 (323) 867-5309
ipaddress顧客のIPアドレス172.3.51.182
カスタム属性​

Roktには、提供されたフィールド名を内部データフィールドにマッピングするデータマッピングシステムがありますが、この記事の後半で推奨されるフィールド名とフォーマット要件をいくつか示しています。別のフィールド名を使用したい場合は、お知らせいただければ、フィールドが適切に管理されるようにします。さらに、レポート目的で提供したい追加フィールドがある場合、受け入れることができます。

プレミアム統合: Web SDKとEvent APIの組み合わせ​

可能であれば、Web SDKとEvent APIの両方を通じてコンバージョンレポートを設定することをお勧めします。これにより、異常を特定し、フロントエンドまたはバックエンドで問題が発生した場合の冗長性が提供されます。

両方の統合を設定する場合は、Web SDKとEvent APIの統合の両方にtransactionidまたはconfirmationrefのいずれかを入力するようにしてください。これにより、Roktはこれらの変数を使用してコンバージョンイベントを重複排除し、レポートの正確性を確保します。

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