ユーザーデータの取得

はじめに

Cxenseプラットフォームからユーザー、または複数ユーザーからなるグループに関する全てのデータを取得したい場合があります。例えば：

• 透明性の観点から、ユーザー自身に情報を提供する場合

• 他システムに連携、または格納するために情報を取得したい場合

上記のための機能は、いくつかのAPIにまたがって存在しており、各APIからはユーザー情報の一部を取得できます。このページの目的は、適切なAPIの使用方法、およびフィルタリングの適用方法を提供することにあります。

ユーザーID

ある特定のユーザー（複数ユーザーからなるグループをユーザとして定義できる場合も含む）
に関する情報を取得する場合、前提条件として特定のユーザーを識別したり、参照したりする方法が存在しなければなりません。さらに、そのユーザを識別する方法は、APIを使用するクライアントが理解できるものでなければなりません。

このため、Cxenseプラットフォームは、Cxenseが理解可能なユーザID（例えば、1stパーティCookieの値）と、顧客が定義付けしたユーザーID（例：外部のCRMシステムで使用されるID)とのリンクをサポートしています。これにより、APIクライアントは、ユーザーを直接解釈し、理解できるようになります。

ユーザーIDのリンクは、以下の2つの方法で可能です。

• ブラウザー上で動作するJavaScript上で、addExternalIdを使用する方法

• HTTPリクエストを生成できるアプリケーション上で、/profile/user/external/link/update APIを使用する方法

注意：ユーザーIDは、実際には2つの部分からなります。

• 値：　crm123のような、例えば外部のCRMシステムで使用できる値

• タイプ：　カスタマープリフィックスを使用します。もし、同じcrm123というIDを異なる顧客が使用したとしても、タイプによって名前の重複や曖昧さを回避することができます。

ユーザーセントリック API

以下ではリクエストまたはレスポンスのいずれかで明示的なユーザー識別子に使うAPIメソッドとして、
ユーザーセントリックAPIメソッドを定義しています。ユーザーセントリックAPIに該当するものは以下の通りです。

• /profile/user/segment APIメソッドはユーザーに割り当てられているオーディエンスセグメントのリストを読み取ります。例えば、このAPIコールでは「ユーザー crm123 が現在オーディエンスセグメントの3、67、98のメンバーである」といった内容が表示されます。参照されたセグメントの詳細については /segment/read APIメソッドを使って読み取ることができます。

• /profile/user/external/read APIメソッドはCxenseプラットフォームに格納されているユーザーに関する外部から提供されたデータを読み取ります。例えば、このAPIコールでは「ユーザー crm123が男性、1970年生まれ、購読者、左利き、犬を3頭飼っている」といった内容が表示されます。

• /profile/user APIメソッドは長期間の関心事項、意図、場所、デバイス、検索クエリ、カスタムマーカーといった情報を含む、ユーザーに関する推測データを読み取ります。例えば、このAPIコールでは「ユーザー crm123 は概してサッカーや有名人のゴシップ、ロンドン出身、iPhoneを使う、といったことに興味を持っていて、　最近はピンクの象について調べて、 foo789 というタグでリターゲティングされるようにマークされた」といった内容が表示されます。

• /traffic/user APIメソッドは付与したフィルタークエリでマッチするユーザー識別子のリストを読み取ります。例えば、このAPIコールは「ユーザー crm123 と crm456 が今日貴社のサイトのスポーツセクションに訪問した、　最もアクティブな二人の iPhoneユーザーである」といった内容が表示されます。

ユーザーフィルター

APIメソッドは aggregationクエリを実行して、特定のユーザーに関する情報を読み取るのに使われます。
これは traffic filter の一部として user type フィルターを使うことによって実行されます。例えば、特定のユーザーによって発生したイベントだけに限定した aggregation に制限されます。

{"type":"user", "group":"xyz", "item":"crm123"}

上で示されているような特定のユーザーに制限したトラフィックフィルターによって、個々のユーザーデータをより多くの種類で検索できるようになります。

• /traffic API メソッドはユーザーの活動数を読み取ります。例えば、このAPIコールでは「ユーザー crm123 が先週貴社サイトで423ページビューをもたらした」といった内容が表示されます。

• /traffic/event API メソッドは ユーザーによって発生した Event groups データを読み取ります。
  例えば、このAPIコールでは「ユーザー crm123 が今日、http://example.com/banana.html  と http://example.com/orange.html を読んだ」といった内容が表示されます。参照されたURLの詳細については /profile/content/fetch メソッドを使って、読み取ることができます。

• /traffic/keyword APIメソッドはユーザーに訪問されたコンテンツプロファイルからの情報を読み取ります。例えば、このAPIコールでは「ユーザー crm123が最近 Robin Williams と Lauren Bacall という人について読んでいる」といった内容が表示されます。 

• /traffic/custom APIメソッドは ユーザーによって発生したイベントに関連する カスタムパラメータ についての情報を読み取ります。例えば、このAPIコールでは「ユーザー crm123が今日5回の購入イベントと7回の販売イベントを発生させた」といった内容が表示されます。

Last updated: January 24, 2022