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

イベントAPI

イベントAPIは、Roktとコンバージョンデータを統合したい広告主にとって、もう一つの選択肢を提供します。イベントAPIを使用することで、あなたのバックエンドサーバーはRoktに安全に接続でき、リアルタイムでコンバージョンデータを送信します。

イベントAPIをコンバージョンデータのスタンドアロン統合として使用することは、いくつかの利点をもたらします:

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

認証​

コンバージョンイベントを送信したいアカウントのために公開鍵と秘密鍵のペアを作成するために、あなたの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 オブジェクトは、イベントに関するメタデータを含むキーと値のペアで構成されています。コンバージョンを正しく属性付けするためには、Rokt が顧客を特定できるように、objectData にメール (email)、SHA-256 ハッシュ化されたメール (emailsha256)、または Rokt ID (passbackconversiontrackingid) のいずれかを含める必要があります。

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

フィールド名説明例
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とイベントAPIの統合​

可能であれば、Web SDKとイベントAPIの両方を通じてコンバージョン報告の設定を推奨します。これにより、異常を特定し、フロントエンドやバックエンドに問題がある場合の冗長性を提供します。

両方の統合を設定することを選択した場合は、Web SDKとイベントAPIの両方で transactionid または confirmationref のいずれかを必ず記入してください。これにより、Roktはこれらの変数を使用してコンバージョンイベントの重複を排除し、報告が正確であることを保証します。

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