訪問プロファイル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 – 属性は「ライフタイムオーダーバリュー」のようなユーザーフレンドリーな名前で表示されます。
    • 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 – 属性は「ライフタイムオーダーバリュー」のようなユーザーフレンドリーな名前で表示されます。
    • 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}'

レスポンスの例

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

エラーメッセージ

このエンドポイントに関する潜在的なエラーメッセージは以下の通りです：