送信イベント

!注直接HTTPリクエストを使う代わりに、Engage SDKを使ってイベントを送信することを推奨します。Engage SDKを使うと、このセクションで説明されているイベントデータのフォーマットや送信方法とは異なる必要があります。「 送信イベント」を参照してください。

GET /v1.2/event/create.json?client_key=client_key&message=event

VIEWイベントなど直接HTTPリクエストを使ってSitecore CDPにイベントを送信するには、Event API(Stream API型)を使ってGETリクエストを行います。イベントオブジェクトをmessageパラメータで渡します。イベントオブジェクトのフォーマットを正しくし、必要な属性をすべて含めるようにしてください。

サイドバー。パラメータ

パラメータ

種類

概要

例

client_key

ストリング

あなたのクライアントキーです。

ZpHxO9WvLOfQRVPlvo0BqB8YjGYuFfNe

event

JSON オブジェクト

すべてのイベントの詳細。

{"key1":"value","key2":"value"}

サイドバー。イベントオブジェクトのフォーマット

イベントデータはURL内のJSONオブジェクトとして送信されます。以下の点に注意してください:

• {}
• すべてのキーと値をダブルクォートで囲 ""。
• 改行は付けないでください。
• キーや値の周りにスペースを入れないでください。

例30。VIEWイベントの正しくフォーマットされたイベントオブジェクト

{"channel":"MOBILE_APP","type":"VIEW","language":"EN","currency":"EUR","page":"homepage","pos":"myretailsite/ireland","browser_id":"a38b230c-11eb-4cf9-8d5d-274e9f344925​"}

サイドバー。必要な属性

最低限、すべてのイベントデータオブジェクトには以下の属性が含まれなければなりません。異なるイベントタイプごとに、この表に記載されている以上の属性を必要とする場合があることに注意してください。

属性

種類

概要

例

channel

文字列(大文字)

ユーザーがブランドと関わる接点です。

例えば、ウェブページの場合、チャンネルは "WEB"です。モバイルアプリの画面では、チャンネルは "MOBILE_APP"です。

以下のいずれかでなければなりません:

• "AIRPORT_KIOSK"
• "BRANCH"
• "CALL_CENTER"
• "EMAIL"
• "GDS"
• "KIOSK"
• "MOBILE_APP"
• "MOBILE_WEB"
• "SMS"
• "OFFLINE"
• "OTA"
• "OTHER"
• "WEB"

type

文字列(大文字)

ユーザーがあなたのブランドと関わる際に起こるイベントの種類。

Sitecore CDP標準イベント(例えばVIEWやIDENTITY)を送信するには、値をSitecore CDP予約イベント名に設定してください。

カスタムイベントを送信するには、その値を好きなカスタムイベント名に設定してください。カスタムイベント名は Sitecore CDPの予約イベント名とは異なる必要があります。

Sitecore CDPが予約したイベント名:

• イベント名は "SC_"

• "ADD" - 標準 的なADD イベント。

• "ADD_CONSUMERS" - 標準 ADD_CONSUMERS イベント。

• "ADD_CONTACTS" - 標準 ADD_CONTACTS イベント。

• "CAMPAIGN_TRACKING" - 内部予約イベント。使用しないでください。

• "CHECKOUT" - 標準 的なチェックアウト イベント。

• "CLEAR_CART" - 標準 CLEAR_CART イベント。

• "CONFIRM" - 標準 的なCONFIRM イベント。

• "FEEDBACK" - フィードバックイベント。

• "IDENTITY" - 標準 的な同一イベント 。

• "INTERACTION" - 内部予約イベント。使用しないでください。

• "ORDER_CHECKOUT" - 標準 ORDER_CHECKOUT イベント。

• "PAYMENT" - 標準 的な支払い イベント。

• "SUBSCRIPTION" - 内部予約イベント。使用しないでください。

• "SEARCH" - 標準 的なSEARCH イベント。

• "TRACKING" - 内部予約イベント。使用しないでください。

• "VIEW" - 標準 的なVIEW イベント。

• "myretailsite

  _POPUP"

• "CUSTOM_EVENT_SEARCH"

• "CUSTOM_EVENT_BANNER_CLICK"

language

文字列(大文字 ISO 639-1)

ユーザーがアプリを使っている言語。

例えば、ユーザーがウェブサイトで日本語を選択した場合、その言語は "JA"です。

• "DE"
• "EN"
• "FR"

currency

文字列(大文字の ISO 4217)

ユーザーがアプリで使っている通貨のアルファベット順通貨コードです。

例えば、ユーザーがあなたのウェブサイトで通貨としてオーストラリアドルを選択した場合、通貨は "AUD"となります。

• "EUR"
• "GBP"
• "USD"

page

ストリング

ブランドとのやり取りが行われるウェブページの名前。

これはお好みのカスタム値です。

• "home"
• "contact-us.html"

pos

ストリング

ブランドとのやり取りが行われる販売ポイントの名前。

この値は、あなたのSitecore CDPインスタンス内に存在する販売時点名に設定する必要があります。

"myretailsite/ireland"

browser_id

ストリング

ブラウザID。

ブラウザIDは以下のような文字列です:

"a38b230c-11eb-4cf9-8d5d-274e9f344925​"

curl -X GET -g '/v1.2/event/create.json?client_key=<client_key>&message={"channel":"MOBILE_APP","type":"VIEW","language":"EN","currency":"EUR","page":"homepage","pos":"myretailsite/ireland","browser_id":"a38b230c-11eb-4cf9-8d5d-274e9f344925​"}'

{ "status": "OK", "version": "1.2", "client_key": "ZpHxO9WvLOfQRVPlvo0BqB8YjGYuFfNe", "ref": "dcb27c41-688d-4c36-8ed7-536e7bf590ba" }