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

イベントAPI

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

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

  • スピード：完全に自動化されたほぼリアルタイムのデータ交換を可能にし、Roktの自動最適化ツールの潜在能力を最大限に活用します。
  • カバレッジ：すべてのチャネルとデバイスでイベントを統合できるため、Web、モバイル、店舗でのコンバージョンのカバレッジが向上します。
  • 信頼性：サーバー間の統合であるため、イベントAPIはブラウザや広告ブロックなどのWebテクノロジーによる干渉の影響を受けません。また、エラーハンドリングもサポートしており、データが失われることはありません。

イベントAPIの追加​

  1. Roktのmy.rokt.comにログインできること、およびアカウントIDを取得できることを確認してください。アカウントを持っていない場合は、アカウントマネージャーに連絡してください。

  2. my.rokt.comからApp IDとApp Secretを取得します。これらの情報は、イベントAPIの認証に必要です。資格情報の取得手順を参照してください。

  3. イベントAPIのペイロードを組み立てます。POST /v1/eventsエンドポイントを使用して、任意のタイプのコンバージョンイベントをRoktに送信できます。

    1. このユースケースでは、常にeventTypeをconversionに設定して、Roktがコンバージョンの帰属プロセスをトリガーするようにします。

    2. objectDataに関連するキーと値のペアを含めます。関連するコンテキストデータを提供することで、Roktは将来のキャンペーンをより良く最適化できます。

      Roktは、少なくともメール（email）、SHA-256ハッシュ化されたメール（emailsha256）、またはRokt ID（passbackconversiontrackingid）のいずれかを要求し、顧客を識別できるようにします。推奨されるobjectDataフィールドは、以下の表で利用できます。

    フルエンドポイントリファレンス

    イベントAPIの詳細なリファレンス詳細を表示します。

サンプル​

POST /v1/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)、SHA-256 ハッシュ化されたメールアドレス (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
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 はこれらの変数を使用して受信する変換イベントを重複排除し、レポートが正確であることを保証します。

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