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

イベント API

概要​

RoktのイベントAPIは、任意のタイプのクライアントイベント（例：購入、アプリのオープン、店舗訪問）および関連する属性（例：メールアドレス、購入金額、クレジットカードBIN）をサポートできる柔軟で堅牢なインターフェースです。

Rokt Ecommerce パートナーは、異常検出のためにWeb SDKと併用してイベントAPIを使用し、配置動作の不整合を検出するのに役立てることができます。

Rokt Ads クライアントは、イベントAPIを使用してRoktとコンバージョンデータを統合し、キャンペーンのパフォーマンスと最適化を向上させることができます。

認証​

イベントAPIは、クライアント統合にOAuth 2.0アプローチを活用します。詳細については、OAuth 2.0 クレデンシャルフローを参照してください。RoktイベントAPIにアクセスするには、RoktアプリIDとアプリシークレットが必要です。

これらの同じ手順でRoktレポートAPIのクレデンシャルを生成できます。

RoktイベントAPIの任意のエンドポイントを呼び出すにはアクセストークンが必要です。アクセストークンは、Roktがクライアントアプリを識別し、各クライアントアプリがアクセスしているデータの種類を特定し、悪意のあるアプリがアクセス権のないデータにアクセスするのを防ぐのに役立ちます。

アプリIDとアプリシークレットの生成​

  1. One Platform にサインインします。

  2. 左下のアカウントアイコンの下にある プロフィール設定 に移動します。

img

  1. 個人用API資格情報の生成 セクションまでスクロールします。

  2. アプリの名前を入力します。

  3. 生成 をクリックします。

  4. イベントAPIとレポートAPIの資格情報がすぐに生成され、次のようになります:

    AppId: "40svbin0d194subpohl079rhck"
    AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"

  5. アプリIDとアプリシークレットを安全な場所に保管してください。このセッション後はアプリシークレットにアクセスできなくなります。

  6. これらの資格情報はすぐに使用できます。

アカウントを保護するために資格情報を機密に保つ必要があり、メールで送信してはいけません。Roktからの問い合わせであっても、組織外に共有しないでください。Roktを正当に代表する者がアプリシークレットを尋ねることは決してありません。

呼び出すタイミング​

このエンドポイントを呼び出して、1時間イベントAPIと対話するためのアクセストークンを生成します。1時間以上APIと対話する必要がある場合は、新しいアクセストークンを取得するために再度このエンドポイントを呼び出してください。

リクエスト​

サンプル​

curl -vX POST  https://api.rokt.com/auth/oauth2/token \
    -H 'Authorization: Basic ${AuthToken}' \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -d 'grant_type=client_credentials'

フィールド​

キー場所説明必須?例
Authorizationheaderapp_id と app_secret はBasic HTTP認証を通じて認証ヘッダーに渡され、One Platformの Profile Settings で生成できます。ヘッダーの内容は Basic base64encode(app_id:app_secret) です。はいBasic base64encocde(12345:abcde)
Content-Typeheaderリクエストのメディアタイプは常に application/x-www-form-urlencoded でなければなりません。はいapplication/x-www-form-urlencoded
grant_typebodyclient_credentials でなければなりません。はいclient_credentials

レスポンス​

例​

{
"access_token":
"eyJraWQiOiJPVUpHT1RjM09FWXROakkzUlMwME5UUkJMVGxCTkRrdFJqWXdOVVV3UkRNNE1FTTJDZz09IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiJkZW1vIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJyZXBvcnQtYXBpL3JlYWQtcmVwb3J0LWFwaSIsImF1dGhfdGltZSI6MTU4NTExMDA0MSwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS91cy13ZXN0LTJfZG93Tlp1elRYIiwiZXhwIjoxNTg1MTEzNjQxLCJpYXQiOjE1ODUxMTAwNDEsInZlcnNpb24iOjIsImp0aSI6IkYwNzY5RDVDLTRDNTAtNDVDOC04OTcyLTI4MkUwODlDMkFFOSIsImNsaWVudF9pZCI6ImRlbW8ifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA"
"expires_in": 3600,
"token_type": "Bearer"
}

API エンドポイント​

POST イベント​

イベント API を使用すると、クライアントは 1 つ以上のイベントを Rokt プラットフォームと統合できます。イベント は通常、コンバージョンまたはトランザクション イベントを指しますが、使用方法は柔軟です。

イベント API には、異常検出（パートナー向け）とコンバージョン レポート（広告主向け）の 2 つの主な使用例があります。

POST /v1/events

リクエスト​

ヘッダー​
名前値必須説明
Content-Typeapplication/jsonはいN/A
Charsetutf-8はいN/A
AuthorizationBearer ${access-token}はい/auth/oauth2/token エンドポイントから取得したアクセストークン
Rokt-Version2020-05-21はいRokt の API バージョン。現在の最新バージョンは 2020-05-21 です。
注: このヘッダーを空のままにすると、最新バージョンが適用されるため、後方互換性がない可能性があります。無効な値は 400 bad request を返します。
パラメータ​

リクエストには、イベントおよび関連する詳細がJSON形式で含まれています。

レベル 1レベル 2レベル 3必須タイプ説明
accountIdはいString; 最大64文字Rokt Account ID
eventsはいList[EventObject]; 1回の呼び出しにつき最大100項目取り込むイベントのリスト
clientEventIdはいString; 最大36文字イベントを一意に識別するために使用される識別子
eventTypeはいString; 最大128文字イベントの種類
eventTimeはいStringイベントの時間はUTCおよびRFC 3339でなければなりません。イベントAPIが受信した時点から18か月以上前または5分以上未来のタイムスタンプを含むイベントがある場合、リクエストは拒否されます。この範囲外のタイムスタンプを持つイベントは処理されません。
metaDataいいえList[metaData]イベントに関するビジネスに重要でない情報を提供
nameはいString; 最大256文字フィールド名; プレフィックス rokt. (大文字小文字を区別しない) はRokt専用に保存されています
valueはいString; 最大65536文字フィールド値; バイナリ値の場合はBase64でエンコード
objectDataいいえList[objectData]イベントの文脈的な詳細を含む
nameはいString; 最大256文字プレフィックス rokt. (大文字小文字を区別しない) はRokt専用に保存されています
valueはいString; 最大65536文字フィールド値; バイナリ値の場合はBase64でエンコード
標準 objectData フィールド​

以下は、Event API を通じて Rokt が受け入れる標準 objectData フィールドのリストです。使用ケースに基づいて、いくつかのフィールドは他のフィールドよりも関連性があります。使用ケースに基づいた特定のペイロードサンプルについては、異常検出 または コンバージョンレポート を参照してください。

追加のデータフィールドを追加したり、特定のフィールドに異なる名前を使用したりしたい場合は、アカウントマネージャーに知らせてください。

名前説明例の値
emailプレーンテキストとして渡されたメールアドレス、小文字で末尾にスペースがないことjohn@email.com
emailsha256メールアドレスの SHA-256 ハッシュ。ハッシュ化する前に、小文字で末尾にスペースがないこと。fab1e2e699b3b927cbf875046a64f222
5df02d5cb306f3857424c2bbb87be61f
passbackconversiontrackingidコンバージョンイベントを元のクリックに一致させるために使用される 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
ccbinコンバージョン支払いのクレジットカードBIN123456
marginコンバージョンの利益率10
transactionid取引ID、ユニークな取引を識別するために使用されます。
ABC789
confirmationref確認参照ID。ユニークな取引を識別および注文確認を追跡するために使用される別の識別子。
注: 提供された場合、Roktはこの識別子を使用してコンバージョンイベントを重複排除します。		XYZ123
firstname顧客の名前John
firstnamesha256名前のSHA-256ハッシュ。ハッシュ化する前に、小文字に変換し、末尾のスペースをすべて削除します。fab1e2e699b3b927cbf875046a64f222
5df02d5cb306f3857424c2bbb87be61f
lastname顧客の苗字Smith
lastnamesha256苗字のSHA-256ハッシュ。ハッシュ化する前に、小文字に変換し、末尾のスペースをすべて削除します。fab1e2e699b3b927cbf875046a64f222
5df02d5cb306f3857424c2bbb87be61f
mobileコンバージョン顧客の携帯電話番号3053211654, +1 (323) 867-5309
mobilesha256携帯電話番号のSHA-256ハッシュ。
注: 携帯電話番号はハッシュ化する前に特定の形式にフォーマットする必要があります: 5551234567（ダッシュやスペースを含まない）。		fab1e2e699b3b927cbf875046a64f222
5df02d5cb306f3857424c2bbb87be61f
ipaddress顧客のIPアドレス172.3.51.182
ipaddresssha256IPアドレスのSHA-256ハッシュ。fab1e2e699b3b927cbf875046a64f222
5df02d5cb306f3857424c2bbb87be61f
useragentコンバージョン顧客のブラウザユーザーエージェントMozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0
DeviceTypeデバイスタイプDesktop, Mobile, Tablet
osデバイスのオペレーティングシステムiOS
osversionオペレーティングシステムのバージョン8.1
browserブラウザSafari
browserversionブラウザのバージョン11.1
title顧客の称号Mr, Mrs, Ms, Miss
gender顧客の性別M, Male, F, Female
dobフォーマット yyyymmdd19851220
age顧客の年齢33
language購入に関連する言語en, en-US
unitno住所に関連するユニット番号Unit A
address1住所の第一行123 Sesame St
address2住所の第二行 (アパート番号、階など)Alphabet Boulevard
zipcode顧客の郵便番号90210, SW1W 0DT
city顧客の都市San Francisco
state顧客の州CA, California, NY, New York
country顧客の国US, United States, AU, Australia
サンプル​

これは、2つの予約イベントを含むJSONペイロードを使用したサンプルのイベントAPI呼び出しです。 

POST /v1/events
{
    "accountId": "12345",
    "events": [
        {
            "clientEventId": "ff3bd69c-ca74-4337-af91-4d5d0bd00e38",
            "eventType": "booking",
            "eventTime": "2020-05-22T10:21:29.339Z",
            "metaData": [
                {
                    "name": "sourceServer",
                    "value": "192.0.0.1"
                }
            ],
            "objectData": [
                {
                    "name": "email",
                    "value": "email123@emailserver.com"
                },
                {
                    "name": "amount",
                    "value": "85.00"
                }
            ]
        },
        {
            "clientEventId": "fff4deeb-cdee-49ff-9aad-61b1c4256ca6",
            "eventType": "booking",
            "eventTime": "2020-05-22T10:21:29.339Z",
            "metaData": [
                {
                    "name": "sourceServer",
                    "value": "192.0.0.1"
                }
            ],
            "objectData": [
                {
                    "name": "email",
                    "value": "email456@emailserver.com"
                },
                {
                    "name": "amount",
                    "value": "99.99"
                }
            ]
        }
    ]
}

レスポンス​

名前説明
X-Rokt-Trace-Idトラブルシューティングのために使用される、リクエストに関連付けられた一意の識別子。
本文​

Event API への成功した呼び出しは 200 ステータスを返します。unprocessedRecords オブジェクトは空であるべきで、これはすべてのイベントが正常に処理されたことを示します。

サンプル​

以下のコードサンプルは、Event API への成功した呼び出しを表しています。

{
    "data": {
        "unprocessedRecords": []
    }
}
200 レスポンスと潜在的なエラー

200 レスポンスを検証する際には、unprocessedRecords にイベントが返されていないことを確認してください。unprocessedRecords にレコードがある場合、1つ以上のイベントが正しく処理されなかった可能性があります。

応答​

HTTP Response Codeエラーコード説明
200N/A通常はOKですが、以下の200エラーシナリオの例を参照してください。
400RequestBodyReadErrorリクエストボディの読み取り中にエラーが発生しました。
400RequestJsonUnmarshalErrorEvent APIがリクエストボディをアンマーシャルできませんでした。
400RequestValidationErrorリクエストボディの内容が検証チェックに失敗しました。 パラメータ要件を正しく守っているか確認してください。
401UnauthorizedError認証トークンが無効または不正です。
403Forbidden提供されたアクセストークンはあなたのアカウントで認可されていません。
500, 502, 503InternalServerError, ServiceUnavailableErrorRokt側で予期しないエラーが発生しました。指数バックオフを使用して再試行するか、Roktサポートチームに連絡してください。
サンプル​
{
    "data": {
        "code": "RequestJsonUnmarshalError",
        "message": "リクエストボディをアンマーシャルできません"
    }
}

200 エラーシナリオ​

HTTP Status 200 は通常、呼び出しが成功したことを示します。しかし、Event API はバッチ API であるため、200 の応答が必ずしもリクエスト全体が正しく処理されたことを意味するわけではありません。開発者は応答ペイロードを確認して、すべてのレコードが処理されたことを確認する必要があります。応答ペイロードにはエラーメッセージと失敗した特定のイベントオブジェクトが含まれています。

レベル 1レベル 2レベル 3レベル 4タイプ説明
dataBulkResponseItemObject
unprocessedRecordsList[BulkResponseItemObject]処理に失敗したレコードを含むオブジェクトのリスト。
errorErrorObjectレコードに関連するエラーを説明します。
codeStringエラーコード
messageString詳細なエラーメッセージ
recordEventObject失敗した元のレコードを含むフィールド。
{
    "data": {
        "unprocessedRecords": [
            {
                "error": {
                    "code": "ValidationError",
                        "message": "Invalid content"
                },
                "record": {
                    "clientEventId": "fff4deeb-cdee-49ff-9aad-61b1c4256ca6",
                    "eventType": "conversion",
                    "eventTime": "2020-05-22T10:21:29.339Z",
                    "objectData": [
                        {
                            "name": "firstname",
                            "value": "john"
                        }
                    ]
                }
            }
        ]
    }
}
この記事は役に立ちましたか？