メンバー プロファイル サービス
メンバー プロファイル サービスを使用すると、1 つのグローバル プロファイルを確立して、サード パーティのインプレッションを受け入れる国/地域とドメインを制限できます。 キャンペーンは、メンバー プロファイルの要件に一致しないサード パーティのインプレッションには入札されません。
キャンペーン プロファイルをメンバー プロファイルに合わせる
キャンペーン プロファイルは、必ずメンバー プロファイル に合わせて調整してください。それ以外の場合は、キャンペーンのターゲット設定が有効でない可能性があります。
- 例 1: メンバー プロファイルは、米国とカナダからのサード パーティのインプレッションを受け入れるように設定されています。 キャンペーンは、米国、カナダ、メキシコからのインプレッションをターゲットに設定されています。 この場合、キャンペーンでは、メンバー プロファイルによってこれらのインプレッションが入札に使用できなくなるため、メキシコからのインプレッションをターゲットにする機会はありません。
- 例 2: メンバー プロファイルは、apples.com、oranges.com、pears.com を含むドメイン リスト 1 からサード パーティのインプレッションをブロックするように設定されています。 キャンペーンは、plums.com、bananas.com、apples.com を含むターゲット ドメイン リスト 3 に設定されます。 apples.com は、ドメイン リスト 1 とドメイン リスト 3 の両方に含まれていることに注意してください。 この場合、メンバー プロファイルはドメイン リスト 1 をブロックするため、キャンペーンで apples com からのインプレッションをターゲットにする機会はありません。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
POST |
https://api.appnexus.com/member-profile (メンバー プロファイル JSON) |
メンバー プロファイルを作成する |
PUT |
https://api.appnexus.com/member-profile (メンバー プロファイル JSON) |
メンバー プロファイルを更新する |
GET |
https://api.appnexus.com/member-profile |
メンバー プロファイルを表示する |
DELETE |
https://api.appnexus.com/member-profile |
メンバー プロファイルを削除する |
GET |
https://api.appnexus.com/member-profile/meta |
フィルター処理および並べ替え可能なフィールドを確認する |
注:
メンバー プロファイルは 1 つだけであるため、 PUT、 GET、または DELETE 要求にプロファイル ID を含める必要はありません。
JSON フィールド
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | メンバー プロファイルの ID。 |
domain_list_action |
列挙 |
domain_list_targetsに対して実行するアクション。 使用可能な値: - "include" - サード パーティのインプレッションは、指定したドメイン リスト内のドメインからのみ受け入れます。 - "exclude" - 指定したドメイン リスト内のものを除くすべてのドメインからサードパーティのインプレッションを受け入れます。既定値: "exclude" |
domain_list_targets |
配列 | 含めるか除外する ドメインの一覧 。 書式設定については 、以下の例 を参照してください。 |
country_targets |
配列 | サード パーティのインプレッションを受け入れる国/地域。 これらの国/地域からのみインプレッションを受け入れます。 国/地域を指定しない場合は、すべての国/地域のサード パーティのインプレッションを受け入れることに注意してください。 以下 の例を 参照してください。 |
last_modified |
date | 読み取り専用。 メンバー プロファイルが最後に変更された日付。 |
inventory_url_list_targets |
オブジェクトの配列 | インベントリ リスト ID (許可リストまたはブロックリスト) の一覧が含まれます。 1 つの許可リストまたは 1 つ以上のブロックリストをプロファイルにアタッチするために使用されます。 - 許可リストには、プロファイルを使用して広告申込情報の対象となるドメインまたはアプリの一覧が含まれています。 許可リストが含まれている場合、許可リストに含まれていないドメインとアプリは対象になりません。 - 各ブロックリストには、プロファイルを使用する広告申込情報によるターゲット設定から除外するドメインまたはアプリの一覧が含まれています。 詳細については、「Profile Service のインベントリ Lists」を参照してください。 |
require_transparency_and_consent_framework_string |
ブール値 |
true場合は、有効な TCF 文字列が存在する場合にのみ、関連付けられているオブジェクトにインベントリの購入を許可しますfalse場合は、関連付けられているオブジェクトが事前に定義されたターゲット設定宣言に含まれるインベントリを購入できるようにします。注: このパラメーターは、GDPR が適用される地域からのトラフィックにのみ適用されます。 既定値: false |
例
メンバー プロファイルの作成
$ cat profile { "member-profile": { "domain_list_action": "include", "domain_list_targets": [ { "id": 23620 }, { "id": 23625 } ], "country_targets": [ { "id": 1 }, { "id": 2 } ] } } $ curl -b cookies -X POST -d @profile 'https://api.appnexus.com/member-profile' { "response": { "status": "OK", "id": 121740 } }
追加の国からのサード パーティのインプレッションを受け入れるようにメンバー プロファイルを更新する
$ cat profile_update { "member-profile": { "country_targets": [ { "id": 233 }, { "id": 59 } ] } } $ curl -b cookies -X PUT -d @profile_update 'https://api.appnexus.com/member-profile' { "response": { "status": "OK", "id": 121740 } }
メンバー プロファイルの表示
$ curl -b cookies 'https://api.appnexus.com/member-profile' { "response": { "status": "OK", "member-profile": { "id": 121740, "domain_list_action": "include", "country_targets": [ { "id": 233, "name": "United States", "code": "US" }, { "id": 58, "name": "Czech Republic", "code": "CZ" }, { "id": 59, "name": "Germany", "code": "DE" } ], "domain_list_targets": [ { "id": "23620", "name": "Domain List 1", "description": "Include Domain List 1", "type": "white" }, { "id": "23625", "name": "Domain List 2", "description": "Include Domain List 2", "type": "white" } ], "last_modified": "2011-12-15 16:57:51" }, "count": 1, "start_element": 0, "num_elements": 100 } }
透明性と同意フレームワーク文字列を要求する
{
"profile": {
"require_transparency_and_consent_framework_string": "false",
}
}