ビジタープライバシーAPIエンドポイント

GET Visitor

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

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

GET /v3/privacy/visitor/accounts/{account}/profiles/{profile}?attributeId={attributeId}&attributeValue={attributeValue}&prettyName={prettyName}

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

• attributeId
  • アカウントからのビジターID属性を表す数値ID。
• attributeValue
  • 検索する値。
  • 特殊文字を含む値はURLエンコードする必要があります。
• prettyName
  • 属性キーがレスポンスにどのように表示されるかを示すブール値：
    • True – 属性は、“Lifetime Order Value"のようなユーザーフレンドリーな名前として表示されます。
    • False – 属性は、“28471"のような数値IDとして表示されます。

権限要件

• サーバーサイドのリーダー、エディター、またはパブリッシャーのレガシー権限、または
• 最小限のビュービジタールックアッププラットフォーム権限

例：cURLリクエスト

curl -H 'Authorization: Bearer {token}' \
 -G \
'https://us-east-1-platform.tealiumapis.com/v3/privacy/visitor/accounts/my_account/profiles/main' \
 --data-urlencode 'attributeId=86' \
 --data-urlencode 'attributeValue=user@example.com' \
 --data 'prettyName=true'

例：レスポンス

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

エラーメッセージ

このタスクの潜在的なエラーメッセージは以下の通りです：

DELETE visitor

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

ビジターレコードを1つ以上削除する前に、以下の点を考慮してください：

• ビジターレコードの削除リクエストは、ビジターID値に関連するすべてのデータの削除を引き起こします。これには、ステッチされたビジターレコードも含まれます。
• 削除リクエストは処理のためにキューに入れられ、完了までに最大30日かかる場合があります。
• ビジターが他のビジターに置き換えられた場合、または他のビジターに置き換えられた場合、ステッチされたすべてのビジターが削除されます。
• DELETEコマンドへのパラメータは、クエリ文字列パラメータではなく、コンテンツタイプ “application/x-www-form-urlencoded” を使用してURLエンコードされたフォームフィールドとして渡す必要があります。

以下のDELETEコマンドを使用して、ビジターレコードを削除します：

DELETE /v3/privacy/visitor/accounts/{account}/profiles/{profile}
  attributeID={value}
  attributeValue={value}

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

• attributeId
  アカウントからのビジターID属性を表す数値ID。
• attributeValue
  検索する値。

権限要件

• サーバーサイドのパブリッシャーのレガシー権限、または
• ビュー、編集、削除ビジタールックアッププラットフォーム権限

例：cURLリクエスト

curl -H 'Authorization: Bearer {token}' \
-X DELETE \
'https://us-east1-platform.tealiumapis.com/v3/privacy/visitor/accounts/my_account/profiles/main' \
--data-urlencode "attributeId=86"
--data-urlencode "attributeValue=user@example.com"

例：レスポンス

削除リクエストへのレスポンスには、transaction_idとステータスが含まれます。transaction_idは、以前のリクエストのステータスを確認するためのGETトランザクション呼び出しで使用されます。次のステータス文字列が可能です：PENDING、SUCCESS、またはFAILED。

成功したレスポンスは、transactionId値を持つ202 Acceptedメッセージを表示します。同じaccount、profile、attributeId、およびattributeValueを持つリクエストが既に存在し、そのトランザクションステータスがPENDINGである場合、既存のトランザクションIDが返されます。以下のようになります：

{
"transactionId" : "{transactionId1}"
}

エラーメッセージ

このタスクの潜在的なエラーメッセージは以下の通りです：

GET transaction

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

トランザクションとは、任意のDELETEビジターリクエストを指します。DELETEビジターリクエストは後で処理するためにキューに入れられます。これにより、transaction_idがそのリクエストの一意のレコードとなり、処理ステータスを確認するためのIDとして使用されます。

以下のGETコマンドを使用して、トランザクションのステータスを確認します：

GET /v3/privacy/visitor/accounts/{account}/profiles/{profile}/transactions/{transaction_id}

権限要件

• サーバーサイドのリーダー、エディター、またはパブリッシャーのレガシー権限、または
• 最小限のビュービジタールックアッププラットフォーム権限

例：cURLリクエスト

APIキーからベアラートークンを生成する方法については、認証を参照してください。ベアラートークンはAPIキーではなく、API呼び出しで使用されます。

curl -H 'Authorization: Bearer {token}' \
https://us-east-1-platform.tealiumapis.com/v3/privacy/visitor/accounts/my_account/profiles/main/transactions/0123456789

例：レスポンス

レスポンスには、キーがtransaction_idで値が次のステータス文字列のいずれかである1つのキー/値ペアを含むオブジェクトが含まれます：PENDING、SUCCESS、またはFAILED。

{
  "0123456789" : "SUCCESS"
}

エラーメッセージ

このタスクの潜在的なエラーメッセージは以下の通りです：

GET Visitor ID Attributes

以下のGETコマンドを使用して、アカウントで利用可能なビジターID属性のリストを取得します：

GET /v3/privacy/visitor/accounts/{account}/profiles/{profile}/ids

権限要件

• サーバーサイドのリーダー、エディター、またはパブリッシャーのレガシー権限、または
• 最小限のビュービジタールックアッププラットフォーム権限

例：cURLリクエスト

curl -H 'Authorization: Bearer {token}' \
https://platform.tealiumapis.com/v3/privacy/visitor/accounts/my_account/profiles/main/ids

例：レスポンス

このコマンドのレスポンスは、ビジターID属性の数値IDと名前を表すキー/値ペアのオブジェクトです。

{
  "43" : "メールアドレス",
  "57" : "税ID番号"
}

エラーメッセージ

このタスクの潜在的なエラーメッセージは以下の通りです：