Skip to content
Last updated

プロファイルとProfiles API トークンについて

プロファイルページでは、顧客またはアカウントごとにデータをグループ化します。Profiles API トークンは、詳細な顧客情報に基づいてパーソナライズされたコンテンツを増やす機能を提供します。

また、Profiles API トークンを使用して、ウェブサイト上での顧客体験をパーソナライズすることもできます。Treasure Dataのパーソナライゼーション機能を、Adobe Target、Optimizely、Google OptimizeなどのA/Bテストツールと組み合わせて使用することで、効果を生み出すウェブサイトのバージョンを決定できます。

基礎となるパーソナライゼーションワークフローが完了すると、パーソナライゼーションデータセットが更新されます。特定のプロファイルが属するセグメントの最新リストを確認できます。また、特定のプロファイルに関連付けられた属性のリストも確認できます。

要件

ペアレントセグメントは、ペアレントセグメントに既に存在している必要があります。ペアレントセグメントは、Profiles API トークンによってアクセスされるすべてのデータの基盤となります。

ウェブクライアントでは、プロファイルセグメントIDの取得にTreasure Data JavaScript SDKを使用します。Profiles APIトークンはJavaScript SDK v1.9.1以降でサポートされています。古いバージョンを使用している場合は、アップグレードする必要があります。

サーバーサイド連携では、クライアントSDKを使用せずにHTTPS経由でProfiles APIを直接呼び出すことができます。詳しくは、SDKを使用せずにProfiles APIを呼び出す(サーバーサイド)を参照してください。

SDKを使用せずにProfiles APIを呼び出す(サーバーサイド)

Profiles APIは、iOS SDK、Treasure Data JavaScript SDK、その他のクライアントSDKを使用せずに、HTTPS経由で直接呼び出すことができます。独自のバックエンドからプロファイルのセグメントと属性を検索する場合に便利です。たとえば、サーバーサイドのパーソナライゼーションサービスや、Profiles APIトークンをアプリのバイナリに埋め込みたくないモバイルアプリのバックエンドから利用できます。

Note

新しいリアルタイムパーソナライゼーションのユースケースでは、サーバー間連携向けに設計されたReal Time Personalization APIの利用を検討してください。このセクションは、すでにProfiles APIトークンを使用しているアカウントが、ブラウザやSDKの外部からトークンを呼び出す場合を対象としています。

リクエスト

GET /cdp/lookup/collect/segments
Host: cdp.in.treasuredata.com

ご利用のリージョンに対応するホストを使用してください。

リージョンホスト
UScdp.in.treasuredata.com
EUcdp-eu01.in.treasuredata.com
韓国cdp-ap02.in.treasuredata.com
東京cdp-tokyo.in.treasuredata.com

その他のリージョンについては、Treasure APIのbaseURLを参照してください。

クエリパラメーター

名前説明
version2を指定します。
tokenProfiles APIトークンのID(UUID)です。1回のリクエストで複数のトークンを検索する場合は、カンマ区切りのリストを指定します。
key.<column_name>検索するプロファイルのLookup Keyの列と値です。例: key.customer_id=customer-123。<column_name>はトークンに設定されたLookup Keyと一致する必要があります。
callback任意です。ブラウザの<script>タグから呼び出す場合など、JSONP形式のレスポンスが必要な場合にのみ使用します。サーバーサイドから呼び出す場合は省略してください。省略すると、APIは通常のJSONを返します。
Warning

トークンのLookup Keyがtd_global_idの場合、APIはリクエストで渡された値を無視し、訪問者の_td_globalブラウザCookieから値を読み取ります。そのため、ブラウザセッションがないサーバーサイド呼び出しでは、td_global_idをLookup Keyとして使用できません。サーバーサイド連携では、カスタム識別子列など、別のLookup Keyを使用してください。

例

curl --get "https://cdp.in.treasuredata.com/cdp/lookup/collect/segments" \
  --data-urlencode "version=2" \
  --data-urlencode "token=YOUR_PROFILES_API_TOKEN_UUID" \
  --data-urlencode "key.customer_id=customer-123"

レスポンス

[
  {
    "values": ["100", "200"],
    "attributes": {
      "title": "Manager",
      "area": "Japan"
    },
    "key": {
      "customer_id": "customer-123"
    },
    "audienceId": "272739"
  }
]
フィールド説明
valuesプロファイルが属するセグメント(バッチおよびリアルタイム)のIDです。
attributesトークンに設定されたプロファイルの属性です。
keyこのリクエストで使用したLookup Keyの列と値です。
audienceIdトークンが属するParent SegmentのIDです。

1回のリクエストで複数のトークンを検索した場合、レスポンス配列にはトークンごとに1つの要素が含まれます。

エラーレスポンス

ステータス例原因
400 Bad Request{"error":"Bad Request","message":"Query parameter key.<column> is required but not set","status":400}必須のkey.<column_name>パラメーターが指定されていません。
403 Forbidden{"error":"Forbidden","message":"Invalid token","status":403}トークンが存在しないか、このアカウントでは有効ではありません。

本番環境のバックエンドでは、タイムアウトを設定し、一時的な障害に対して上限付きの指数バックオフを使用してください。リクエストを修正せずに400または403のレスポンスを再試行しないでください。

Security

Profiles APIトークンは公開された認証なしのトークンです。トークンの値を知っている人は誰でも直接クエリできます。トークンの返却属性としてPII(メールアドレス、電話番号、氏名など)を設定しないでください。トークンを取得した人に公開しても安全な属性だけを設定してください。レスポンスのkeyオブジェクトにはLookup Keyとその値がそのまま含まれます。これはプロファイルの返却属性ではありません。可能な場合は非PIIの識別子を使用し、Lookupの値から個人を特定できる場合はリクエストURLとログを適切に保護してください。トークンはクエリ文字列に含まれるため、トークンやLookupの値の露出を制限する必要がある場合は、サーバーやプロキシのログでクエリパラメーターをマスキングするように設定してください。