モーメントAPIエンドポイント
この記事では、モーメントAPIエンドポイントについて説明します。
仕組み
モーメントAPIエンジンは、あなたの地域、アカウント、プロファイルに対してユニークなエンドポイントを作成します。各エンジンは、各エンドポイントにユニークなエンジンIDを割り当てます。
訪問者のデータは、エンジンを有効にし、訪問者がアクティブなセッションをログに記録し、システム内でイベントを生成した後に利用可能になります。訪問者のデータをリクエストし、まだアクティブなセッションをログに記録していない場合、APIはデータを返しません。
訪問者のデータを取得するには、Tealium iQ Advanced JavaScript Code Extensionを設定して、Moments API endpointにリクエストを行います。
GETメソッド
GETメソッドを使用して、モーメントAPIエンジンで指定したオーディエンス、バッジ、属性データを取得します:
GET https://personalization-api.{REGION}.prod.tealiumapis.com/personalization/accounts/{ACCOUNT}/profiles/{PROFILE}/engines/{ENGINE_ID}/visitors/{IDENTIFIER}?ignoreTapid={IGNORE_TAPID}&suppressNotFound={SUPPRESS_NOT_FOUND}
このコマンドは以下のパラメータを使用します:
パラメータ | タイプ | 説明 |
---|---|---|
identifier |
文字列 パスパラメータ |
Tealiumの匿名訪問者ID。ignoreTapid がtrue に設定されている場合は必須です。 |
ignoreTapid |
ブール値 クエリパラメータ |
APIがTAPIDクッキーからの訪問者IDを使用するか、URLパスパラメータからの訪問者IDを使用するかを決定します。デフォルトはfalse です。
|
suppressNotFound |
ブール値 クエリパラメータ |
訪問者が見つからない場合に返されるレスポンスタイプを決定します。デフォルトはfalse です。
|
オブジェクト
モーメントAPIは、エンジン設定で指定したオーディエンス、バッジ、属性フィールドを含むJSONオブジェクトとして訪問者データを返します。
訪問者の属性をIDまたは名前で返すように設定できます。以下にレスポンスボディの例を示します:
{
"audiences": [
"VIP",
"Women's Apparel",
"Lifetime visit count"
],
"badges": [
"13",
"26",
"52"
],
"metrics": {
"5048": 0
},
"properties": {
"5050": "<attr_value>"
},
"flags": {
"5052": false
},
"dates": {
"5054": 123456789
}
}
以下の表は、モーメントAPIがサポートするデータタイプをまとめたものです:
属性タイプ | サポート |
---|---|
バッジ | ✓ |
ブール値 | ✓ |
日付 | ✓ |
数値 | ✓ |
文字列 | ✓ |
ブール値の配列 | ✗ |
数値の配列 | ✗ |
文字列の配列 | ✗ |
ファネル | ✗ |
文字列のセット | ✗ |
タリー | ✗ |
タイムライン | ✗ |
PIIとしてマークされた属性はサポートされていません。
ヘッダー
モーメントAPIリクエストには以下のHTTPヘッダーが必要です:
- Referer - ドメイン許可リストと比較される値。リファラと許可リストが一致しない場合、リクエストは拒否されます。
- 例:
https://www.example.com/
- 例:
- Origin - JavaScriptからAPIを呼び出す際のCORSエラーを対処するために使用される値。
- 例:
https://www.example.com/
- 例:
エラーメッセージ
このエンドポイントの可能性のあるエラーメッセージ:
ステータスコード | 説明 |
---|---|
200 | ステータスOK。リクエストは成功しました。 |
400 | 不正なリクエスト。 |
403 | モーメントAPIエンジンが有効になっていません。 |
404 | 見つかりません。Tealium訪問者IDはデータベースにモーメントが保存されていません。 |
最終更新日 :: 2024年June月27日