Visibility Profile サービス

在庫を再販する場合、可視性プロファイル サービスを使用すると、入札要求で購入者に渡す詳細レベルを制御できます。 具体的には、発行元 ID と名前、配置 ID と名前、発行元が提供する年齢と性別のデータ、インベントリのユニバーサルとカスタムの分類、インベントリ URL、位置情報などを公開または非表示にすることができます。

プロファイルの既定の設定 ( expose_age_default、 expose_gender_defaultなど) は、すべてのプラットフォーム購入者と外部入札者に適用されますが、 buyer_members 配列と bidders 配列を使用して、特定のプラットフォーム購入者と外部入札者の既定の設定をオーバーライドできます。 たとえば、既定では在庫データを非表示にし、特別なビジネス関係を持つ特定の購入メンバーにのみデータを公開できます。 または、競合他社と見なされる特定の購入メンバーを除くすべてのユーザーにインベントリ データを公開することもできます。

買い手が入札リクエストに表示するデータに影響を与えるだけでなく、可視性の設定は、購入者が購入したインプレッションについて報告したときに表示されるデータにも影響します。 たとえば、購入者から発行元 ID と名前を非表示にした場合、その購入者にはレポートに発行元 ID と名前が表示されません。

REST API

JSON フィールド

カスタム カテゴリ

expose_custom_categories_defaultがlistに設定されている場合は、この配列を使用して、入札要求に渡すカスタム カテゴリを指定します。 配列内の各オブジェクトは、1 つのカスタム カテゴリを表し、次のフィールドが含まれています。 書式設定については、次の 例を 参照してください。

購入者メンバー

この配列を使用して、特定の Xandr プラットフォーム メンバーの可視性ルールを定義します。 配列内の各オブジェクトは 1 つのメンバーを表し、次のフィールドを含みます。 書式設定については、次の 例を 参照してください。

入札

この配列を使用して、特定の外部入札者やコンテキスト データ プロバイダーの可視性ルールを定義します。 配列内の各オブジェクトは、1 つの入札者を表し、次のフィールドを含みます。 書式設定については、次の 例を 参照してください。

例

可視性プロファイルの追加 - メンバー 9 を除くすべての購入者に在庫データを表示する

この例では、 POST 要求によって可視性プロファイルが作成され、メンバー 9 を除くすべての Xandr プラットフォーム メンバーと外部入札者が、入札要求の発行元、配置、年齢、性別、カテゴリ、および URL 情報を表示できます。

$ cat visibility_profile

{
    "visibility-profile": {
        "name": "Test Visibility Profile",
        "expose_age_default": true,
        "expose_gender_default": true,
        "expose_custom_categories_default": "all",
        "url_exposure_default": "full",
        "expose_reserve_price_default": true,
        "expose_user_id_default": true,
        "expose_ip_default": true,
        "expose_user_agent_default": true,
        "expose_postal_code_default": true,
        "expose_geo_lat_lon_default": true,
        "expose_device_id_default": true,
        "expose_querystring_default": true,
        "expose_application_id_default": true,
        "expose_site_id_default": true,
        "buyer_members": [
            {
                "id": 9,
                "expose_age": false,
                "expose_gender": false,
                "expose_custom_categories": "none",
                "url_exposure": "hidden"
            }
        ]
    }
}

$ curl -b cookies -X POST -d @visibility_profile 'https://api.appnexus.com/visibility-profile'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 1818,
        "start_element": 0,
        "num_elements": 100,
        "visibility-profile": {
            "id": 1818,
            "member_id": 1066,
            "name": "Test Visibility Profile",
            "notes": null,
            "expose_age_default": true,
            "expose_gender_default": true,
            "expose_custom_categories_default": "all",
            "url_exposure_default": "full",
            "expose_reserve_price_default": true,
            "expose_user_id_default": true,
            "expose_ip_default": true,
            "expose_user_agent_default": true,
            "expose_postal_code_default": true,
            "expose_geo_lat_lon_default": true,
            "expose_device_id_default": true,
            "expose_querystring_default": true,
            "expose_application_id_default": true,
            "expose_site_id_default": true,
            "last_modified": "2015-08-31 21:18:54",
            "buyer_members": [
                {
                    "id": 9,
                    "expose_age": false,
                    "expose_gender": false,
                    "expose_custom_categories": "none",
                    "url_exposure": "hidden",
                    "expose_bid_requests": true,
                    "expose_reserve_price": true,
                    "expose_user_id": true,
                    "expose_ip": true,
                    "expose_user_agent": true,
                    "expose_postal_code": true,
                    "expose_geo_lat_lon": true,
                    "expose_device_id": true,
                    "expose_querystring": true,
                    "expose_application_id": true,
                    "expose_site_id": true,
                    "name": "DisplayWords Bidder - member 9",
                    "custom_categories": null
                }
            ],
            "bidders": null,
            "custom_categories": null
        }
    }
}

可視性プロファイルの追加 - メンバー 9 を除くすべての購入者の在庫データを非表示にする

この例では、 POST 要求によって可視性プロファイルが作成され、メンバー 9 を除くすべての Xandr プラットフォーム メンバーと外部入札者が、入札要求の発行元、配置、年齢、性別、カテゴリ、および URL 情報を表示できなくなります。

$ cat visibility_profile

{
    "visibility-profile": {
        "name": "Test Visibility Profile",
        "expose_age_default": false,
        "expose_gender_default": false,
        "expose_custom_categories_default": "none",
        "url_exposure_default": "hidden",
        "expose_reserve_price_default": true,
        "expose_user_id_default": true,
        "expose_ip_default": true,
        "expose_user_agent_default": true,
        "expose_postal_code_default": true,
        "expose_geo_lat_lon_default": true,
        "expose_device_id_default": true,
        "expose_querystring_default": true,
        "expose_application_id_default": true,
        "expose_site_id_default": true,
        "buyer_members": [
            {
                "id": 9,
                "expose_age": true,
                "expose_gender": true,
                "expose_custom_categories": "all",
                "url_exposure": "full",
                "expose_bid_requests": true,
                "expose_reserve_price": true,
                "expose_user_id": true,
                "expose_ip": true,
                "expose_user_agent": true,
                "expose_postal_code": true,
                "expose_geo_lat_lon": true,
                "expose_device_id": true,
                "expose_querystring": true,
                "expose_application_id": true,
                "expose_site_id": true,
            }
        ]
    }

$ curl -b cookies -X POST -d @visibility_profile 'https://api.appnexus.com/visibility-profile'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 1819,
        "start_element": 0,
        "num_elements": 100,
        "visibility-profile": {
            "id": 1819,
            "member_id": 1066,
            "name": "Test Visibility Profile",
            "notes": null,
            "expose_age_default": false,
            "expose_gender_default": false,
            "expose_custom_categories_default": "none",
            "url_exposure_default": "hidden",
            "expose_reserve_price_default": true,
            "expose_user_id_default": true,
            "expose_ip_default": true,
            "expose_user_agent_default": true,
            "expose_postal_code_default": true,
            "expose_geo_lat_lon_default": true,
            "expose_device_id_default": true,
            "expose_querystring_default": true,
            "expose_application_id_default": true,
            "expose_site_id_default": true,
            "last_modified": "2015-08-31 21:57:13",
            "buyer_members": [
                {
                    "id": 9,
                    "expose_age": true,
                    "expose_gender": true,
                    "expose_custom_categories": "all",
                    "url_exposure": "full",
                    "expose_reserve_price": true,
                    "expose_user_id": true,
                    "expose_ip": true,
                    "expose_user_agent": true,
                    "expose_postal_code": true,
                    "expose_geo_lat_lon": true,
                    "expose_device_id": true,
                    "expose_querystring": true,
                    "expose_application_id": true,
                    "expose_site_id": true,
                    "name": "DisplayWords Bidder - member 9",
                    "custom_categories": null
                }
            ],
            "bidders": null,
            "custom_categories": null
        }
    }
}

可視性プロファイルの変更 1818

この例では、 PUT 要求によって可視性プロファイル 1818 が更新され、カスタム コンテンツ カテゴリ 24214 のみが入札要求に渡されるようにします。 これは、可視性が個別に定義されているプラットフォーム メンバー 9 を除くすべての Xandr プラットフォーム メンバーと外部入札者に適用されます (応答の配列 {{buyer_members}} 参照)。

$ cat visibility_profile_update

{
    "visibility-profile": {
        "expose_custom_categories_default": "list",
        "custom_categories": [
            {
                "id": 24214
            }
        ]
    }
}

$ curl -b cookies -X PUT -d @visibility_profile_update 'https://api.appnexus.com/visibility-profile?id=1818'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "1818",
        "start_element": 0,
        "num_elements": 100,
        "visibility-profile": {
            "id": 1818,
            "member_id": 1066,
            "name": "Test Visibility Profile",
            "notes": null,
            "expose_age_default": true,
            "expose_gender_default": true,
            "expose_custom_categories_default": "list",
            "url_exposure_default": "full",
            "expose_reserve_price_default": true,
            "expose_user_id_default": true,
            "expose_ip_default": true,
            "expose_user_agent_default": true,
            "expose_postal_code_default": true,
            "expose_geo_lat_lon_default": true,
            "expose_device_id_default": true,
            "expose_querystring_default": true,
            "expose_application_id_default": true,
            "expose_site_id_default": true,
            "last_modified": "2015-08-31 21:24:43",
            "buyer_members": [
                {
                    "id": 9,
                    "expose_age": false,
                    "expose_gender": false,
                    "expose_custom_categories": "none",
                    "url_exposure": "hidden",
                    "expose_reserve_price": true,
                    "expose_user_id": true,
                    "expose_ip": true,
                    "expose_user_agent": true,
                    "expose_postal_code": true,
                    "expose_geo_lat_lon": true,
                    "expose_device_id": true,
                    "expose_querystring": true,
                    "expose_application_id": true,
                    "expose_site_id": true,
                    "name": "DisplayWords Bidder - member 9",
                    "custom_categories": null
                }
            ],
            "bidders": null,
            "custom_categories": [
                {
                    "id": 24214,
                    "name": "TEST"
                }
            ]
        }
    }
}

すべての可視性プロファイルを表示する

$ curl -b cookies 'https://api.appnexus.com/visibility-profile'

{
    "response": {
        "status": "OK",
        "count": 2,
        "start_element": 0,
        "num_elements": 100,
        "visibility-profiles": [
            {
                "id": 1816,
                "member_id": 1066,
                "name": "Test Visibility Profile",
                "notes": null,
                "expose_age_default": true,
                "expose_gender_default": true,
                "expose_custom_categories_default": "list",
                "url_exposure_default": "full",
                "expose_reserve_price_default": true,
                "expose_user_id_default": true,
                "expose_ip_default": true,
                "expose_user_agent_default": true,
                "expose_postal_code_default": true,
                "expose_geo_lat_lon_default": true,
                "expose_device_id_default": true,
                "expose_querystring_default": true,
                "expose_application_id_default": true,
                "expose_site_id_default": true,
                "last_modified": "2015-08-31 18:14:45",
                "buyer_members": [
                    {
                        "id": 9,
                        "expose_age": true,
                        "expose_gender": true,
                        "expose_custom_categories": "none",
                        "url_exposure": "full",
                        "expose_reserve_price": true,
                        "expose_user_id": true,
                        "expose_ip": true,
                        "expose_user_agent": true,
                        "expose_postal_code": true,
                        "expose_geo_lat_lon": true,
                        "expose_device_id": true,
                        "expose_querystring": true,
                        "expose_application_id": true,
                        "expose_site_id": true,
                        "name": "DisplayWords Bidder - member 9",
                        "custom_categories": null
                    }
                ],
                "bidders": [
                    {
                        "id": 6,
                        "expose_age": true,
                        "expose_gender": true,
                        "expose_custom_categories": "none",
                        "url_exposure": "full",
                        "expose_reserve_price": true,
                        "expose_user_id": true,
                        "expose_ip": true,
                        "expose_user_agent": true,
                        "expose_postal_code": true,
                        "expose_geo_lat_lon": true,
                        "expose_device_id": true,
                        "expose_querystring": true,
                        "expose_application_id": true,
                        "expose_site_id": true,
                        "name": "Dilling HBF Test New",
                        "custom_categories": null
                    }
                ],
                "custom_categories": [
                    {
                        "id": 24214,
                        "name": "TEST"
                    }
                ]
            },
            {
                "id": 1818,
                "member_id": 1066,
                "name": "Test Visibility Profile",
                "notes": null,
                "expose_age_default": true,
                "expose_gender_default": true,
                "expose_custom_categories_default": "list",
                "url_exposure_default": "full",
                "expose_reserve_price_default": true,
                "expose_user_id_default": true,
                "expose_ip_default": true,
                "expose_user_agent_default": true,
                "expose_postal_code_default": true,
                "expose_geo_lat_lon_default": true,
                "expose_device_id_default": true,
                "expose_querystring_default": true,
                "expose_application_id_default": true,
                "expose_site_id_default": true,
                "last_modified": "2015-08-31 21:24:43",
                "buyer_members": [
                    {
                        "id": 9,
                        "expose_age": false,
                        "expose_gender": false,
                        "expose_custom_categories": "none",
                        "url_exposure": "hidden",
                        "expose_reserve_price": true,
                        "expose_user_id": true,
                        "expose_ip": true,
                        "expose_user_agent": true,
                        "expose_postal_code": true,
                        "expose_geo_lat_lon": true,
                        "expose_device_id": true,
                        "expose_querystring": true,
                        "expose_application_id": true,
                        "expose_site_id": true,
                        "name": "DisplayWords Bidder - member 9",
                        "custom_categories": null
                    }
                ],
                "bidders": null,
                "custom_categories": [
                    {
                        "id": 24214,
                        "name": "TEST"
                    }
                ]
            }
        ]
    }
}

可視性プロファイルの表示 1818

$ curl -b cookies 'https://api.appnexus.com/visibility-profile?id=1818'

{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "visibility-profile": {
            "id": 1818,
            "member_id": 1066,
            "name": "Test Visibility Profile",
            "notes": null,
            "expose_age_default": true,
            "expose_gender_default": true,
            "expose_custom_categories_default": "list",
            "url_exposure_default": "full",
            "expose_reserve_price_default": true,
            "expose_user_id_default": true,
            "expose_ip_default": true,
            "expose_user_agent_default": true,
            "expose_postal_code_default": true,
            "expose_geo_lat_lon_default": true,
            "expose_device_id_default": true,
            "expose_querystring_default": true,
            "expose_application_id_default": true,
            "expose_site_id_default": true,
            "last_modified": "2015-08-31 21:24:43",
            "buyer_members": [
                {
                    "id": 9,
                    "expose_age": false,
                    "expose_gender": false,
                    "expose_custom_categories": "none",
                    "url_exposure": "hidden",
                    "name": "DisplayWords Bidder - member 9",
                    "custom_categories": null
                }
            ],
            "bidders": null,
            "custom_categories": [
                {
                    "id": 24214,
                    "name": "TEST"
                }
            ]
        }
    }
}