訪問プライバシーAPIエンドポイント

GET 訪問

この呼び出しには、認証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'

レスポンスの例

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

エラーメッセージ

このタスクに関連する可能性のあるエラーメッセージは以下の通りです：

訪問の削除

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

一つまたは複数の訪問レコードを削除する前に、以下の点を考慮してください：

• 訪問レコードの削除リクエストは、訪問ID値に関連付けられたすべてのデータの削除を引き起こします。これには、ステッチされた訪問レコードも含まれます。
• 削除リクエストは処理のためにキューに入れられ、完了までに最大30日かかる場合があります。
• 訪問が別の訪問に置き換えられた場合、または置き換えられた場合、ステッチされたすべての訪問が削除されます。

訪問レコードを削除するには、次のDELETEコマンドを使用します：

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

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

• attributeId
  アカウントからの訪問ID属性を表す数値ID。
• attributeValue
  検索する値。特殊文字を含む値はURLエンコードする必要があります。

権限要件

• サーバーサイドのパブリッシャーのレガシー権限、または
• 閲覧、編集、および削除訪問ルックアッププラットフォーム権限

cURLリクエストの例

curl -H 'Authorization: Bearer {token}' \
-X DELETE \
-G \
'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トランザクションコールで使用されるIDです。可能なステータス文字列には、PENDING、SUCCESS、またはFAILEDがあります。

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

{
"transactionId" : "{transactionId1}"
}

エラーメッセージ

このタスクに関連する可能性のあるエラーメッセージは以下の通りです：

トランザクションの取得

この呼び出しには、認証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で値が次のいずれかのステータス文字列であるオブジェクトが含まれます：PENDING、SUCCESS、またはFAILED。

{
  "0123456789" : "SUCCESS"
}

エラーメッセージ

このタスクに関連する可能性のあるエラーメッセージは以下の通りです：

訪問ID属性の取得

アカウントで利用可能な訪問ID属性のリストを取得するために、次のGETコマンドを使用します：

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" : "Email Address",
  "57" : "Tax ID Number"
}

エラーメッセージ

このタスクに関連する可能性のあるエラーメッセージは以下の通りです：