モーメントAPIエンドポイント
この記事では、モーメントAPIのエンドポイントについて説明します。
仕組み
モーメントAPIエンジンは、あなたの地域、アカウント、プロファイルに対してユニークなエンドポイントを作成します。各エンジンは、各エンドポイントにユニークなエンジンIDを割り当てます。
訪問のデータは、エンジンを有効にし、訪問がアクティブなセッションをログし、システム内でイベントを生成した後に利用可能になります。訪問のデータをリクエストし、まだアクティブなセッションをログしていない場合、APIはデータを返しません。
訪問のデータを取得するには、Tealium iQ Advanced JavaScript Code Extensionを構成して、モーメントAPIエンドポイントにリクエストを行います。
GETメソッド
GETメソッドを使用して、モーメントAPIエンジンで指定したオーディエンス、バッジ、属性データを取得します。
Tealium匿名訪問ID
GET https://personalization-api.{REGION}.prod.tealiumapis.com/personalization/accounts/{ACCOUNT}/profiles/{PROFILE}/engines/{ENGINE_ID}/visitors/{IDENTIFIER}?suppressNotFound={SUPPRESS_NOT_FOUND}
このコマンドは以下のパラメータを使用します:
パラメータ | タイプ | 説明 |
---|---|---|
identifier |
文字列 パスパラメータ |
Tealiumの匿名訪問ID。 |
suppressNotFound |
ブール値 クエリパラメータ |
訪問が見つからない場合の返答タイプを決定します。デフォルトはfalse です。
|
セカンダリ訪問ID
GET https://personalization-api.{REGION}.prod.tealiumapis.com/personalization/accounts/{ACCOUNT}/profiles/{PROFILE}/engines/{ENGINE_ID}?attributeId={attributeId}&attributeValue={attributeValue}&suppressNotFound={SUPPRESS_NOT_FOUND}
このコマンドは以下のパラメータを使用します:
パラメータ | タイプ | 説明 |
---|---|---|
attributeId |
文字列 クエリパラメータ |
あなたのアカウントからの訪問ID属性を表す数値ID。 |
attributeValue |
文字列 クエリパラメータ |
検索する値。特殊文字を含む値はURLエンコードする必要があります。 |
suppressNotFound |
ブール値 クエリパラメータ |
訪問が見つからない場合の返答タイプを決定します。デフォルトはfalse です。
|
匿名IDとセカンダリ訪問IDについての詳細は、匿名ID、ユーザー識別子、訪問ID属性を参照してください。
オブジェクト
モーメント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年September月6日