訪問プロファイルAPIエンドポイント

GET 訪問

この呼び出しには、認証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/{account}/profiles/{profile}?attributeId=5013&attributeValue=liveOnly&searchPriority=["live", "historical"]&responseFilters=["5051", "5016"]' \
--header 'Authorization: Bearer {token}'

例 レスポンス

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

エラーメッセージ

このエンドポイントに関連する可能性のあるエラーメッセージは次のとおりです：

GET 歴史的訪問

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

GET 歴史的訪問メソッドは、歴史的訪問のみを検索することにより、より高速なレスポンス時間を実現するために最適化されています。

歴史的訪問の記録を取得するには、以下の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/{account}/profiles/{profile}?attributeId=5013&attributeValue=liveOnly&responseFilters=["5051", "5016"]' \
--header 'Authorization: Bearer {token}'

例 レスポンス

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

エラーメッセージ

このエンドポイントに関連する可能性のあるエラーメッセージは次のとおりです：