メンバーデータ共有サービス (対象ユーザーのみ)

[アーティクル]
02/23/2024

ヒント

メンバーデータ共有ドキュメントをより明確にするために、このページを作成しました。このページには、対象ユーザーデータプロバイダー (bidder/リアルタイム統合がないプロバイダー) にのみ関連する呼び出しがあります。

メンバーデータ共有サービスを使用すると、セグメントを他のプラットフォームメンバーと共有できます。次に、動作のしくみを示します。

購入者に対して、DSP の投資でユーザー (データプロバイダー) を有効にするよう依頼します。これを行うために使用する必要がある設定は、DSP セグメントマネージャーの [ データプロバイダーの管理] にあります。
セグメントを共有するメンバーの共有レコードを作成します。
共有レコードで、すべてのセグメントを共有するか、特定のセグメントの一覧を共有するかを指定します。
セグメントを共有したメンバーは、キャンペーンでセグメントをターゲットにすることができます (入札者の場合は、各入札リクエストでセグメントデータが送信されます)。

共有レコードからセグメントを削除すると、メンバーは新規または既存のキャンペーンのターゲットプロファイルにセグメントを追加できないことに注意してください。ただし、メンバーが既存のキャンペーンのセグメントを既にターゲットにしている場合、キャンペーンは、メンバーがキャンペーンのターゲットプロファイルから手動で削除するまで、引き続きセグメントをターゲットにし続けます。セグメントが削除されると、メンバーはキャンペーンのターゲティングプロファイルに再度追加できなくなります。

ヒント

特定のメンバーを対象としたカスタムセグメントがある場合は、各共有レコードで "list" に設定 segment_exposure し、配列を segments 使用して、各メンバーがアクセスする必要があるセグメントを識別する必要があります。

注:

メンバーデータ共有サービスは、Xandr の API (api.appnexus.com) とインプレッションバス API (api.adnxs.com) の両方で機能します。以下では api.adnxs.com のみが使用されますが、Xandr の API にアクセスできるクライアントの api.appnexus.com に置き換えることができます。 Xandr 上のメンバーのみが API にアクセスできます。ほとんどのデータプロバイダーは、インプレッションバス API にのみアクセスできます。

REST API

HTTP メソッド	エンドポイント	説明
DELETE	https://api.adnxs.com/member-data-sharing?id=RECORD_ID https://api.adnxs.com/member-data-sharing/RECORD_ID	共有レコードを削除する
GET	https://api.adnxs.com/member-data-sharing	すべての共有レコードを表示する
取得	https://api.adnxs.com/member-data-sharing?id=RECORD_ID https://api.adnxs.com/member-data-sharing/RECORD_ID レコード ID がわからない場合は、以下のエンドポイントを使用できます https://api.adnxs.com/member-data-sharing?data_member_id=MEMBER_ID&buyer_member_id=CLIENT_MEMBER_ID	特定の共有レコードを表示する
POST	https://api.adnxs.com/member-data-sharing?data_member_id=MEMBER_ID (JSON の共有)	共有レコードを 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 (JSON の共有) https://api.adnxs.com/member-data-sharing/RECORD_ID (JSON の共有)	共有レコードを変更する

ヒント

JSON 構造体:

1 つの共有レコードを追加または更新するときは、JSON を "member_data_sharing" という 1 つのオブジェクトとして構造化する必要があります。 (POST) 複数の共有レコードを追加する場合は、JSON を "member_data_sharings" と呼ばれるオブジェクトの配列として構成し (複数形に注意してください)、共有データを配列に配置する必要があります。複数の共有レコードを同時に更新 (PUT) することはできません。正確な書式設定については、次の例を参照してください。

JSON フィールド

フィールド	型 (長さ)	説明
buyer_member_id	int	セグメントを共有しているメンバーの ID。必須: POST
data_member_id	int	読み取り専用。メンバー ID。
id	int	共有レコードの ID。既定値: 自動生成された数値必須: クエリ文字列内の PUT/DELETE
segment_exposure	列挙	すべてのセグメントを共有するか、特定のセグメントのリストをメンバーと共有するか。使用可能な値: "all" または "list" です。 [すべて] を選択すると、新しく作成されたすべてのセグメントが自動的に購入者メンバーと共有されます。特定の購入者のみがアクセスできるカスタムセグメントを作成する場合は、"リスト" 露出を使用する必要があります。必須: POST
セグメント	オブジェクトの配列	segment_exposureが "list" の場合、メンバーと共有しているセグメントの一覧。書式設定については、以下の最初の例を参照してください。必須: POST/PUT (segment_exposureが "list" の場合)。

例

メンバー 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'
{
    "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'
{
    "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 要求は、共有レコード 55 内の既存のデータ (メンバー 104 の共有レコード) をセグメント121179に置き換えます。

$ 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/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/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": {
        ...
        }
    }
}

次の方法で共有

REST API

JSON フィールド

例

その他のリソース

次の方法で共有

メンバー データ共有サービス (対象ユーザーのみ)

メンバー データ共有サービス (対象ユーザー データ プロバイダーのみ)

REST API

JSON フィールド

例

その他のリソース

メンバーデータ共有サービス (対象ユーザーのみ)

メンバーデータ共有サービス (対象ユーザーデータプロバイダーのみ)