ビジタープロファイルAPIエンドポイント

GET Visitor

この呼び出しには、認証APIで返された地域固有のホストを使用する必要があります。詳細については、認証を参照してください。

以下のGETコマンドを使用して、ビジターレコードを取得します：

GET /v3/customer/visitor/accounts/{account}/profiles/{profile}?attributeId={attributeId}&attributeValue={attributeValue}&prettyName={prettyName}&responseFilters=["{attributeId}", "{attributeId}"]

このコマンドは以下のパラメータを使用します：

• attributeId
  • アカウントからのビジター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はライブビジターデータを取得します。
• responseFilters
  • ビジターデータをフィルタリングするためのIDのJSON配列。未構成の場合、APIはすべてのビジターデータを返します。構成されている場合、responseFiltersに含まれるattributeIdの値がレスポンスに返されます。
  • APIが一度に返すことができるattributeIdの値の最大数は150です。150以上のattributeIdの値を提供すると、APIは最初の150のIDのみを返します。
  • 例：responseFilters=["5051", "5016"]

例：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'

例：レスポンス

レスポンスの形式については、例のビジターオブジェクトを参照してください。

エラーメッセージ

このエンドポイントに対する潜在的なエラーメッセージは次のとおりです：

GET Historical Visitor

この呼び出しには、認証APIで返された地域固有のホストを使用する必要があります。詳細については、認証を参照してください。

GET Historical Visitorメソッドは、履歴ビジターのみを検索することでレスポンス時間を最適化しています。

以下のGETコマンドを使用して、履歴ビジターレコードを取得します：

GET /v3/customer/visitor/historical/accounts/{account}/profiles/{profile}?attributeId={attributeId}&attributeValue={attributeValue}&prettyName={prettyName}&responseFilters=["{attributeId}", "{attributeId}"]

このコマンドは以下のパラメータを使用します：

• attributeId
• アカウントからのビジター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のみを返します。

例：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'

例：レスポンス

レスポンスの形式については、例のビジターオブジェクトを参照してください。

エラーメッセージ

このエンドポイントに対する潜在的なエラーメッセージ：