メンバー データ共有サービス
メンバー データ共有サービスを使用すると、セグメントを他のプラットフォーム メンバーと共有できます。 次に、動作のしくみを示します。
- Microsoft Invest でユーザー (データ プロバイダー) を有効にするように購入者に依頼します。 これを行うために使用する必要がある設定は、Microsoft Invest Segment Manager の [ データ プロバイダーの管理] にあります。
- セグメントを共有するメンバーの共有レコードを作成します。
- 共有レコードで、すべてのセグメントを共有するか、特定のセグメントの一覧を共有するかを指定します。
- セグメントを共有したメンバーは、キャンペーンでセグメントをターゲットにすることができます (入札者の場合は、各入札リクエストでセグメント データが送信されます)。
注:
共有レコードからセグメントを削除すると、メンバーは新規または既存のキャンペーンのターゲット プロファイルにセグメントを追加できません。 ただし、メンバーが既存のキャンペーンのセグメントを既にターゲットにしている場合、キャンペーンは、メンバーがキャンペーンのターゲット プロファイルから手動で削除するまで、引き続きセグメントをターゲットにし続けます。 セグメントが削除されると、メンバーはキャンペーンのターゲティング プロファイルに再度追加できなくなります。
- 広告主レベルのセグメントは共有できません。 共有できるのは、メンバー/ネットワーク レベルのセグメントだけです。 セグメントを広告主からネットワーク レベルに移動するには、セグメント サービスを使用して
advertiser_id
をNULL
に設定できます。 - 外部統合 DSP に属する購入者メンバーとセグメントを共有することはできません。
- メンバー データ共有サービスは、Xandr の API (api.appnexus.com) とインプレッション バス API (api.adnxs.com) の両方で動作するようになりました。 以下では api.adnxs.com のみが使用されますが、Xandr の API にアクセスできるクライアントの api.appnexus.com に置き換えることができます。 Xandr 上のメンバーのみが API にアクセスできます。 ほとんどのデータ プロバイダーは、インプレッション バス API にのみアクセスできます。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.adnxs.com/member-data-sharing |
既存のすべての共有レコードを表示します。 |
GET |
https://api.adnxs.com/member-data-sharing?id=RECORD_ID |
特定の共有レコードを表示します。 |
GET |
https://api.adnxs.com/member-data-sharing?data_member_id=MEMBER_ID&buyer_member_id=CLIENT_MEMBER_ID ここで、 data_member_id = メンバー ID、 buyer_member_id = 受信者のメンバー ID |
メンバー ID を使用して共有レコード ID を取得します。 |
POST |
https://api.adnxs.com/member-data-sharing?data_member_id=MEMBER_ID (JSON の共有) 手記: メンバーデータ共有オブジェクトは、単数形の場合は配列にすることはできません。 |
セグメントを 1 つのメンバーと共有する共有レコードを 1 つ作成します。 |
POST |
https://api.adnxs.com/member-data-sharings?data_member_id=MEMBER_ID (JSON の共有) 手記: メンバー データ共有 (複数形) オブジェクトは、複数形の場合は配列である必要があります。 |
複数の共有レコードを作成して、複数のメンバーとセグメントを共有します。 |
PUT |
https://api.adnxs.com/member-data-sharing?id=RECORD_ID 注: - このメソッドは、既存のすべてのセグメントを削除し、セグメントを新しく指定されたリストのみに置き換えます。 - リストから 1 つ以上のセグメントを削除するには、リスト全体を目的のセグメントに置き換える必要があります。 |
共有レコード内で共有されているセグメントの一覧を置き換えます。 |
PUT |
https://api.adnxs.com/member-data-sharing?id=RECORD_ID&append=true 手記: セグメントは、"追加" フラグを使用してリストにのみ追加でき、削除することはできません。 |
共有レコード内の共有セグメント リストからセグメントを追加する。 |
DELETE |
https://api.adnxs.com/member-data-sharing?id=RECORD_ID |
共有レコードを削除します。 |
ヒント
JSON 構造体:
1 つの共有レコードを追加または更新するときは、JSON を "member_data_sharing"
という 1 つのオブジェクトとして構造化する必要があります。 複数の共有レコード POST
追加するときは、JSON を "member_data_sharings"
(複数形に注意) というオブジェクトの配列として構造化し、共有データを配列に配置する必要があります。 複数の共有レコードを同時に更新 (PUT
) することはできません。 正確な書式設定については、次の 例を 参照してください。
JSON フィールド
フィールド | 型 (長さ) | 説明 |
---|---|---|
id |
int | 共有レコードの ID。 デフォルト: 自動生成された数値 クエリ文字列で必要な On: PUT /DELETE |
data_member_id |
int | 読み取り専用です。 メンバー ID。 |
buyer_member_id |
int | セグメントを共有しているメンバーの ID。 必須: POST |
segment_exposure |
列挙 | すべてのセグメントを共有するか、特定のセグメントのリストをメンバーと共有するか。 使用可能な値: "all" または "list" 。
"all" を選択すると、新しく作成されたセグメントが自動的に購入者メンバーと共有されます。 特定の購入者のみがアクセスできるカスタム セグメントを作成する場合は、 "list" 露出を使用する必要があります。必須: POST |
segments |
オブジェクトの配列 |
segment_exposure が"list" されている場合は、メンバーと共有しているセグメントの一覧。 書式設定については、以下の最初の例を参照してください。segment_exposure が"list" の場合は、On:POST /PUT 必須。 |
例
メンバー 103 および 104 とセグメントを共有する
$ cat data_share_multiple
{
"member_data_sharings": [
{
"buyer_member_id": 103,
"segment_exposure": "all"
},
{
"buyer_member_id": 104,
"segment_exposure": "list",
"segments": [
{
"id": 121175
},
{
"id": 121176
},
{
"id": 121177
},
{
"id": 121178
}
]
}
]
}
$ curl -b cookies -c cookies -X POST -d @data_share_multiple 'https://api.adnxs.com/member-data-sharing?data_member_id=1432'
{
"response": {
"status": "OK",
"count": 2,
"start_element": null,
"num_elements": null,
"id": [
54,
55
],
"member_data_sharings": {
"54": {
"id": 54,
"data_member_id": 1432,
"buyer_member_id": 103,
"segment_exposure": "all",
"segments": null
},
"55": {
"id": 55,
"data_member_id": 1432,
"buyer_member_id": 104,
"segment_exposure": "list",
"segments": [
{
"id": 121175,
"name": "Segment share 1"
},
{
"id": 121176,
"name": "Segment share 2"
},
{
"id": 121177,
"name": "Segment share 3"
},
{
"id": 121178,
"name": "Segment share 4"
}
]
}
},
"dbg": {
...
}
}
}
メンバー 105 とセグメントを共有する
$ cat data_share_single
{
"member_data_sharing": {
"buyer_member_id": 105,
"segment_exposure": "all"
}
}
$ curl -b cookies -c cookies -X POST -d @data_share_single 'https://api.adnxs.com/member-data-sharing?data_member_id=1432'
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null,
"id": "56",
"member_data_sharing": {
"id": 56,
"data_member_id": 1432,
"buyer_member_id": 105,
"segment_exposure": "all",
"segments": null
},
"dbg": {
...
}
}
}
メンバー 104 の共有レコードを更新する
この例では、 PUT
要求によって、セグメント 121179が共有レコード 55 (メンバー 104 の共有レコード) に追加されます。
$ cat data_share_update
{
"member_data_sharing": {
"segments": [
{
"id": 121175
},
{
"id": 121176
},
{
"id": 121177
},
{
"id": 121178
},
{
"id": 121179
}
]
}
}
$ curl -b cookies -c cookies -X PUT -d @data_share_update 'https://api.adnxs.com/member-data-sharing?id=55'
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null,
"id": 55,
"member_data_sharing": {
"id": 55,
"data_member_id": 1432,
"buyer_member_id": 104,
"segment_exposure": "list",
"segments": [
{
"id": 121175,
"name": "test for sharing"
},
{
"id": 121176,
"name": "test for sharing2"
},
{
"id": 121177,
"name": "test for sharing3"
},
{
"id": 121178,
"name": "test for sharing4"
},
{
"id": 121179,
"name": "test for sharing4"
}
]
},
"dbg": {
...
}
}
}
すべての共有レコードを表示する
$ curl -b cookies -c cookies 'https://api.adnxs.com/member-data-sharing'
{
"response": {
"status": "OK",
"count": 5,
"start_element": null,
"num_elements": null,
"member_data_sharings": [
{
"id": 46,
"data_member_id": 1432,
"buyer_member_id": 100,
"segment_exposure": "all",
"segments": null
},
{
"id": 52,
"data_member_id": 1432,
"buyer_member_id": 101,
"segment_exposure": "all",
"segments": null
},
{
"id": 53,
"data_member_id": 1432,
"buyer_member_id": 102,
"segment_exposure": "all",
"segments": null
},
{
"id": 54,
"data_member_id": 1432,
"buyer_member_id": 103,
"segment_exposure": "all",
"segments": null
},
{
"id": 55,
"data_member_id": 1432,
"buyer_member_id": 104,
"segment_exposure": "list",
"segments": [
{
"id": 121175,
"name": "Segment share 1"
},
{
"id": 121176,
"name": "Segment share 2"
},
{
"id": 121177,
"name": "Segment share 3"
},
{
"id": 121178,
"name": "Segment share 4"
},
{
"id": 121179,
"name": "Segment share 5"
}
]
},
{
"id": 56,
"data_member_id": 1432,
"buyer_member_id": 105,
"segment_exposure": "all",
"segments": null
}
],
"dbg": {
...
}
}
}
共有レコードの表示 55
$ curl -b cookies -c cookies 'https://api.adnxs.com/member-data-sharing?id=55'
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null,
"member_data_sharing": {
"id": 55,
"data_member_id": 1432,
"buyer_member_id": 104,
"segment_exposure": "list",
"segments": [
{
"id": 121175,
"name": "Segment share 1"
},
{
"id": 121176,
"name": "Segment share 2"
},
{
"id": 121177,
"name": "Segment share 3"
},
{
"id": 121178,
"name": "Segment share 4"
},
{
"id": 121179,
"name": "Segment share 5"
}
]
},
"dbg": {
...
}
}
}