Tealium Visitor Privacy APIエンドポイント
Visitor Privacy APIを使用すると、特定の訪問に関する既知のデータを取得したり、訪問のレコードを削除したり、削除リクエストのステータスを確認したりすることができます。
GET visitor
訪問のレコードを取得するには、以下の GET コマンドを使用します：
GET /v2/visitor/accounts/{account}/profiles/{profile}?attributeId={attributeId}&attributeValue={attributeValue}&prettyName={prettyName}
GET visitor パラメータ
このコマンドは以下のパラメータを使用します：
| パラメータ | タイプ | 説明 |
|---|---|---|
attributeId |
string | アカウントからの訪問ID属性を表す数値ID。 |
attributeValue |
string | 検索する値。特殊文字を含む値はURLエンコードする必要があります。 |
prettyName |
boolean | 属性キーがレスポンスにどのように表示されるかを示すブール値： true - 属性はユーザーフレンドリーな名前、例えば Lifetime Order Value として表示されます。 false - 属性は数値ID、例えば 28471 として表示されます。 |
cURLリクエストの例
curl -H 'Authorization: Bearer {token}' \
-G \
'https://api.tealiumiq.com/v2/visitor/accounts/my_account/profiles/main' \
--data-urlencode 'attributeId=86' \
--data-urlencode 'attributeValue=user@example.com' \
--data 'prettyName=true'
レスポンスの例
レスポンスの形式については、訪問オブジェクトの例を参照してください。
エラーメッセージ
このタスクの可能性のあるエラーメッセージは以下の通りです：
| エラーコード | エラーメッセージ |
|---|---|
| 404 | “returnCode” : 1240, “message” : “Account was not found” |
| 404 | “returnCode” : 1250, “message” : “Profile was not found” |
DELETE visitor
一つまたは複数の訪問レコードを削除する前に、以下の点を考慮してください：
- 訪問レコードの削除リクエストは、訪問ID値に関連するすべてのデータ、ステッチされた訪問レコードを含む、を削除する結果となります。
- 削除リクエストは処理のためにキューに入れられ、完了までに数日かかることがあります。
- 訪問が他の訪問に置き換えられた場合、または置き換えられた場合、ステッチされたすべての訪問が削除されます。
DELETEコマンドへのパラメータは、クエリストリングパラメータではなく、コンテンツタイプ "application/x-www-form-urlencoded" を使用してURLエンコードされたフォームフィールドとして渡す必要があります。
訪問のレコードを削除するには、以下の DELETE コマンドを使用します：
DELETE /v2/visitor/accounts/{account}/profiles/{profile}
attributeID={value}
attributeValue={value}
DELETE visitor パラメータ
このコマンドは以下のパラメータを使用します：
| パラメータ | タイプ | 説明 |
|---|---|---|
attributeId |
string | アカウントからの訪問ID属性を表す数値ID。 |
attributeValue |
string | 検索する値。特殊文字を含む値はURLエンコードする必要があります。 |
cURLリクエストの例
curl -H 'Authorization: Bearer {token}' \
-X DELETE \
'https://api.tealiumiq.com/v2/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}"
}
エラーメッセージ
このタスクの可能性のあるエラーメッセージは以下の通りです：
| エラーコード | エラーメッセージ |
|---|---|
| 404 | “returnCode” : 1240, “message” : “Account was not found” |
| 404 | “returnCode” : 1250, “message” : “Profile was not found” |
GET transaction
トランザクション は、任意の GET visitor リクエストまたは DELETE visitor リクエストを指します。DELETE visitor リクエストは後で処理するためにキューに入れられ、これにより transaction_id がそのリクエストとIDのユニークなレコードとなり、処理ステータスを確認する際に使用されます。
トランザクションのステータスを確認するには、以下の GET コマンドを使用します：
GET /v2/visitor/accounts/{account}/profiles/{profile}/transactions/{transaction_id}
cURLリクエストの例
API認証について読んで、APIキーからベアラートークンを生成する方法を学びます。ベアラートークンはAPIキーではなく、APIコールで使用されます。
curl -H 'Authorization: Bearer {token}' \
https://api.tealiumiq.com/v2/visitor/accounts/my_account/profiles/main/transactions/0123456789
レスポンスの例
レスポンスには、key が transaction_id で value が次のステータス文字列のいずれかであるオブジェクトが含まれます：PENDING、SUCCESS、または FAILED。
{
"0123456789" : "SUCCESS"
}
GET visitor ID属性
アカウントで利用可能な訪問ID属性のリストを取得するには、以下の GET コマンドを使用します：
GET /v2/visitor/accounts/{account}/profiles/{profile}/ids
cURLリクエストの例
curl -H 'Authorization: Bearer {token}' \
https://api.tealiumiq.com/v2/visitor/accounts/my_account/profiles/main/ids
レスポンスの例
このコマンドのレスポンスは、訪問ID属性の数値IDと名前を表すキー/値のペアのオブジェクトです。
{
"43" : "Email Address",
"57" : "Tax ID Number"
}
最終更新日 :: 2024年June月25日