Visitor Profile API — V3 早期アクセス
Visitor Profile APIは、顧客データハブからの訪問プロファイルレコードのクエリに使用されます。特定の訪問に関する既知のデータを取得して、ウェブサイトの初回訪問向けのパーソナライゼーションを向上させます。
動作原理
訪問の検索は、アカウントからのVisitor ID属性に基づいて行われます。
レート制限
Visitor Profile APIのデフォルトのレート制限は、1秒あたり150リクエストです。より高いレート制限が必要な場合は、Tealiumのアカウントマネージャーに連絡してください。
許可要件
サーバーサイドのリーダー、エディター、またはパブリッシャー。
認証
ベアラートークンはすべてのAPI呼び出しの認証に使用され、APIキーは認証呼び出しでのみ使用されます。ベアラートークンに加えて、認証応答には後続のサーバーサイドAPI呼び出しで使用する必要があるリージョン固有のホスト名も含まれます。
APIキーからベアラートークンを生成する方法については、Tealium API V3 入門ガイドを参照してください。
訪問フィールド
訪問は、以下のフィールドを含むJSONオブジェクトとして返されます：
| オブジェクト名 | タイプ | 説明 |
|---|---|---|
live |
ブール値 | 訪問が現在ライブセッションにいる場合はtrueに構成されます。 |
visitor |
オブジェクト | 各属性データ型のサブオブジェクトを持つ訪問オブジェクト：
|
応答の例
{"live": false,
"visitor": {
"metrics": {
"初回訪問からの経過週数": 0.14,
"累計参照訪問数": 11,
"累計訪問回数": 12,
"平均訪問時間（分）": 0.36,
"累計イベント数": 35,
"サイトでの総滞在時間（分）": 4.27,
"直接訪問数": 1
},
"dates": {
"最終訪問": 1521217490000,
"last_visit_start_ts": 1521217490000,
"初回訪問": 1521134626000
},
"properties": {
"利用したブラウザの累計バージョン（お気に入り）": "Chrome",
"利用したブラウザの累計タイプ（お気に入り）": "Chrome",
"プロファイル": "main",
"利用したデバイスの累計（お気に入り）": "Mac desktop",
"利用したプラットフォームの累計（お気に入り）": "browser",
"最後のイベントURL": "http://www.tealium.com/",
"アカウント": "tealium",
"利用したオペレーティングシステムの累計（お気に入り）": "Mac OS X"
},
"flags": {
"再訪問": true
},
"funnels": {
"fake_funnel": {
"completed": true,
"fake_title": {
"timestamp": 1655303842639,
"snapshot": {
"fake_string": "fake_string",
"週ごとの平均訪問回数": 1.0
}
}
},
"pii_funnel": {
"completed": true,
"step2": {
"timestamp": 1655303842639,
"snapshot": {
"pii_string": "Example string",
"初回訪問": 1655303836000,
"最後のイベントURL": "http://172.16.3.15:8000/datacloudtest.html"
}
},
"step1": {
"timestamp": 1655303842639,
"snapshot": {
"pii_string": "Example string"
}
}
}
},
"sequences": {
"fake_timeline": [
{
"timestamp": 1655303842639,
"snapshot": {}
},
{
"timestamp": 1655303842642,
"snapshot": {}
},
{
"timestamp": 1655303842652,
"snapshot": {}
},
{
"timestamp": 1655303842654,
"snapshot": {}
},
{
"timestamp": 1655303842665,
"snapshot": {}
}
]
},
"audiences": [
"fake_visitors"
],
"badges": ["Unbadged"],
"metric_sets": {
"利用したオペレーティングシステムの累計": {
"Mac OS X": 12
},
"利用したデバイスの累計": {
"Mac desktop": 12
},
"利用したブラウザの累計バージョン": {
"Chrome": 12
},
"利用したブラウザの累計タイプ": {
"Chrome": 12
},
"利用したプラットフォームの累計": {
"browser": 12
}
}
}
}
訪問の取得
次のGETコマンドを使用して、訪問レコードを取得します：
GET /v3/customer/visitor/accounts/{account}/profiles/{profile}?attributeId={attributeId}&attributeValue={attributeValue}&prettyName={prettyName}&responseFilters=["{attributeId}", "{attributeId}"]
このコマンドでは、次のパラメータを使用します：
attributeId- アカウントからのVisitor ID属性を表す数値IDです。
attributeValue- 検索する値です。
- 特殊文字を含む値はURLエンコードする必要があります。
prettyName- 応答で属性キーが表示される方法を示すブール値：
true– 属性は「Lifetime Order Value」などのユーザーフレンドリーな名前で表示されます。false– 属性は「28471」などの数値IDで表示されます。
- 応答で属性キーが表示される方法を示すブール値：
searchPriority- リクエストのデータソースを示すJSON文字列配列として渡される値です。デフォルトは
["live", "historical"]です。["live"]– ウェブサイトに関する現在の訪問についてのライブデータを取得します。["historical"]— 30分の待機期間後に完了した訪問に関するウェブサイトの過去のデータを取得します。["live", "historical"]— APIはライブ訪問データを取得しようとします。ライブ訪問データが利用できない場合、APIは過去の訪問データを取得します。["historical", "live"]— APIは過去の訪問データを取得しようとします。過去のデータが利用できない場合、APIはライブ訪問データを取得します。
- リクエストのデータソースを示すJSON文字列配列として渡される値です。デフォルトは
responseFilters- 訪問データをフィルタリングするためのIDのJSON配列です。構成しない場合、APIはすべての訪問データを返します。構成された場合、
responseFiltersに含まれるattributeIdの値が応答で返されます。 - APIが一度に返すことができる
attributeIdの最大数は150です。150を超えるattributeIdの値を提供する場合、APIは最初の150のIDのみを返します。 - 例：
responseFilters=["5051", "5016"]
- 訪問データをフィルタリングするためのIDのJSON配列です。構成しない場合、APIはすべての訪問データを返します。構成された場合、
この呼び出しでは、認証APIで返されたリージョン固有のホストを使用する必要があります。詳細については、入門ガイド > リージョン固有のホストを参照してください。
cURLリクエストの例
curl --location -g --request \
GET 'https://us-east-1-platform.tealiumapis.com/v3/customer/visitor/accounts/my_account/profiles/profileinuseast?attributeId=5013&attributeValue=liveOnly&searchPriority=["live", "historical"]&responseFilters=["5051", "5016"]' \
--header 'Authorization: Bearer fakeToken'
応答の例
応答の形式については、例の訪問オブジェクトを参照してください。
エラーメッセージ
このエンドポイントの潜在的なエラーメッセージは次のとおりです：
| エラーメッセージ | 説明 |
|---|---|
| 400 | {"message": "You are missing an attribute Id or Attribute Value"} |
| 401 | {"message": "Unauthorized"} |
| 404 | Visitor was not found, empty response.{"message": "Invalid query parameter value for 'searchPriority' detected."} |
過去の訪問の取得
GET Historical Visitorメソッドは、より高速な応答時間を実現するために、過去の訪問のみを検索します。
次のGETコマンドを使用して、過去の訪問レコードを取得します：
GET /v3/customer/visitor/historical/accounts/{account}/profiles/{profile}?attributeId={attributeId}&attributeValue={attributeValue}&prettyName={prettyName}&responseFilters=["{attributeId}", "{attributeId}"]
このコマンドでは、次のパラメータを使用します：
attributeId- アカウントからのVisitor ID属性を表す数値IDです。
attributeValue- 検索する値です。
- 特殊文字を含む値はURLエンコードする必要があります。
prettyName- 応答で属性キーが表示される方法を示すブール値：
true– 属性は「Lifetime Order Value」などのユーザーフレンドリーな名前で表示されます。false– 属性は「28471」などの数値IDで表示されます。
responseFilters- 訪問データをフィルタリングするためのIDのJSON配列です。構成しない場合、APIはすべての訪問データを返します。構成された場合、
responseFiltersに含まれるattributeIdの値が応答で返されます。APIが一度に返すことができるattributeIdの最大数は150です。150を超えるattributeIdの値を提供する場合、APIは最初の150のIDのみを返します。
- 訪問データをフィルタリングするためのIDのJSON配列です。構成しない場合、APIはすべての訪問データを返します。構成された場合、
この呼び出しでは、認証APIで返されたリージョン固有のホストを使用する必要があります。詳細については、入門ガイド > リージョン固有のホストを参照してください。
cURLリクエストの例
curl --location -g --request \
GET 'https://us-east-1-platform.tealiumapis.com/v3/customer/visitor/historical/accounts/my_account/profiles/profileinuseast?attributeId=5013&attributeValue=liveOnly&responseFilters=["5051", "5016"]' \
--header 'Authorization: Bearer fakeToken'
応答の例
応答の形式については、例の訪問オブジェクトを参照してください。
エラーメッセージ
このエンドポイントの潜在的なエラーメッセージは次のとおりです：
| エラーメッセージ | 説明 |
|---|---|
| 400 | {"message": "You are missing an attribute Id or Attribute Value"} |
| 401 | {"message": "Unauthorized"} |
| 404 | Visitor was not found, empty response. |
最終更新日 :: 2024年March月29日