従来の Bidder プロファイル サービス
Bidder プロファイルは、リアルタイムの 入札リクエスト を受け取るフィルター条件を作成および管理するために使用されます。 プロファイルを使用すると、不要な入札要求を処理するために必要なリソースを制限できます。 Bidder プロファイル - FAQ を参照してください。
重要事項
- 入札要求が入札者プロファイルに合格するには、入札要求が指定されたフィルター条件をすべて満たす必要があります。
- 入札者には複数のプロファイルを作成できますが、特定の時点で入札者に対してアクティブにできる親プロファイルは 1 つだけです。 Bidder サービスを使用して、入札者に関連付けてプロファイルをアクティブ化します。
- 入札者は常に、入札者に関連付けられているメンバーが所有する在庫に対する入札要求を受け取ります。 この場合、Bidder プロファイルは適用されません。
- データ プロバイダーの入札者は、親プロファイルを 1 つだけ持ち、子プロファイルを持つ必要はありません。
警告
プロファイルは、アクティブな bidder オブジェクトにアタッチする必要があります。
プロファイルを作成した後、Bidder サービスを使用してを指定して、そのプロファイルを"parent_profile_id"
入札者に添付する必要があります。
非推奨のフィールドは使用しないでください。
プロファイルを構成するときは、以下で非推奨としてマークされているフィールドは含めないでください。 これにより、入札者は予想される入札要求量を受け取りません。
頻繁にプロファイルを更新すると、そのプロファイルが一時的にロックされる場合があります。
30 分以内に入札者プロファイルを複数更新すると、そのプロファイルが安全上の予防措置としてロックされる可能性があります。 プロファイルがロックされた場合、このプロファイルのみに一致するトラフィックは約 5 分間通過しません。
サポートされているフィルター条件
現在、次のフィルター条件がサポートされています。
- 販売メンバー
- メンバーにインベントリを要求するか除外するかを指定するには、 プラットフォーム メンバー サービスに関するページを参照してください。
注:
Xandr Direct Seller メンバー グループは既定で含まれており、API を使用して除外することはできません。 詳細については、「 外部需要パートナーの供給」を参照してください。
- 地理
- 国
- 指定した国のセットに対する要求を含める/除外する(OR)
- 指定した国のセットを除くすべての国の入札要求を受け取ります。
- Region
- 指定した一連のリージョンに対する要求を含める/除外する (OR)
- 指定したリージョンのセットを除くすべてのリージョンの入札リクエストを受け取ります。
- Dma
- 指定した DMA のセットに対する要求を含める/除外する(OR)
- 指定した DMA のセットを除くすべてのリージョンの入札要求を受け取ります。
- 国
- インベントリ
- ドメイン リスト
- 許可リストまたはブロックリストの要件を満たすインプレッションの要求を含める/除外します。
- インベントリ属性
- 特定のインベントリ属性を含むインプレッションに対するリクエストを含める/除外する。
- 監査の状態
- Xandr によって監査されていないドメインからの要求を除外します。
- ドメイン リスト
- Audience
警告
2019 年 4 月 27 日の時点で、Xandr は外部統合 DSP のプラットフォーム上のセグメントをサポートしなくなりました。
セグメントのターゲット設定
- セグメントのターゲット条件を満たすユーザーの要求を含める/除外します。
クリエイティブ サイズ
- 指定したクリエイティブ サイズのセットに対する入札要求を含める/除外します。
供給の種類 (web/mobile_app/mobile_web)
- 通常の Web アプリとモバイル アプリのインプレッションを含める/除外する。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.adnxs.com/profile/BIDDER_ID | プロファイルの表示: 入札者に関連付けられているすべてのプロファイルを表示するには。 |
GET |
https://api.adnxs.com/profile/BIDDER_ID/PROFILE_ID | プロファイルの表示: 入札者に関連付けられている特定のプロファイルを表示するには。 |
POST |
https://api.adnxs.com/profile/BIDDER_ID (プロファイル JSON) |
入札者のプロファイルを追加します。 |
PUT |
https://api.adnxs.com/profile/BIDDER_ID/PROFILE_ID (プロファイル JSON) |
既存のプロファイルを変更します。 |
DELETE |
https://api.adnxs.com/profile/BIDDER_ID/PROFILE_ID メモ: 非アクティブなプロファイルのみを削除できます。は、bidder オブジェクトに関連付けられていないプロファイルです。 |
既存のプロファイルを削除します。 |
Bidder サービスを使用して、入札者のprofile_id フィールドを目的の入札者プロファイルの ID に設定します。 |
親プロファイルとして入札者のプロファイルをアクティブ化します。 | |
Bidder サービスを使用して、入札者のchild_profiles配列を更新して、目的の入札者プロファイルの ID を含めます。 | 入札者のプロフィールを子プロファイルとしてアクティブ化します。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
ID |
文字列 | 入札者プロファイルの一意識別子。 必須: はい。更新時。 |
code |
String | 入札者プロファイルの代替識別子。入札者に固有です。 必須: いいえ。 |
description |
String | 入札者プロファイルの説明。 必須: いいえ。 |
last_activity |
timestamp | プロファイルに対する最後の変更のタイムスタンプ。 必須: いいえ。 |
入札調整 | ||
passthrough_percent |
double | 受け取るプロファイルのターゲットを満たす入札リクエストの割合 (50 = 50%)。 入札者に送信される要求はランダムに選択されますが、入札者は、入札者に関連付けられているメンバーのセグメント内のユーザーに対する要求を常に受け取ることができます。 に0 設定passthrough_percent した場合、入札者は、少なくとも 1 つのメンバーのセグメント内のユーザーに対する要求のみを受け取ります。 これらの値は、0.1 単位で有効になります。必須: いいえ。 |
メンバーのフィルター処理 | ||
member_targets |
オブジェクトの配列 | メンバーのメンバー ID を含むオブジェクトの配列。 アクションが指定されていない場合の既定のアクションは です "include" 。つまり、メンバー ID を含める必要があります。 これは、 オブジェクトで を"action" 指定することによってオーバーライドされる場合があります(例: )。 "member_targets":[{"id":"100","action": "exclude"}] 詳細については、「 プラットフォーム メンバー サービス」を参照してください。 必須: いいえ。 |
Geography フィルター処理 | ||
country_action |
Enum - "exclude" または "include" | の場合 "exclude" は、 に含まれていない "country_targets" 国の入札要求のみが入札者に送信されます。 の場合 "include" 、内の国 "country_targets" の入札要求のみが入札者に送信されます。 既定値は exclude です。必須: いいえ。 |
country_targets |
オブジェクトの配列 | フィールドで country_action 定義されているように、除外または含める国 ID。 Country Service を使用して、国 ID の一覧を取得できます。 詳細と形式については、「 国のターゲット」を参照してください。必須: いいえ。 |
region_action |
Enum - "exclude" または "include" | の場合 "exclude" は、NOT in "region_targets" リージョンの入札要求のみが入札者に送信されます。 の場合 "include" 、内の "region_targets" リージョンに対する入札要求のみが入札者に送信されます。既定値は exclude です。必須: いいえ。 |
region_targets |
オブジェクトの配列 | フィールドで region_action 定義されているように、除外または含めるリージョン/状態 ID。 リージョン サービスを使用して、リージョン ID の一覧を取得できます。 詳細と形式については、「 リージョン ターゲット」を参照してください。 必須: いいえ。 |
dma_targets |
オブジェクトの配列 | 対象となる dma を指定するオブジェクトの配列 (包含または除外用)。 例えば。 [{"dma":123}, {"dma":124}] 必須: いいえ。 |
dma_action |
Enum - "exclude" または "include" | 既定値は "exclude" です。 dma_targets を参照してください。必須: いいえ。 |
city_targets |
オブジェクトの配列 | フィールドで定義されているように、含めるか除外される都市の city_action ID。 City Service を使用して、市区町村 ID の一覧を取得できます。 詳細と形式については、「 市区町村のターゲット」を参照してください。必須: いいえ。 |
city_action |
Enum - "exclude" または "include" | の場合 "exclude" は、NOT in "city_targets" の都市に対する入札要求のみが入札者に送信されます。 の場合 "include" 、内の "city_targets" 都市に対する入札要求のみが入札者に送信されます。既定値は exclude です。必須: いいえ。 |
インベントリ | ||
inventory_action |
Enum - "exclude" または "include" | 非推奨。 このフィールドをそのままにしておき "exclude" 、このフィールドを使用しないでください。これにより、入札者に送信される使用可能な在庫が減る可能性があるためです。必須: いいえ。 |
use_inventory_attribute_targets |
ブール型 | に設定すると "true" 、適用 inventory_attribute_targets されます。 このフラグを使用すると "opt-in" 、一部のインベントリに対して存在する場合に、ツール バーなどの特定のインベントリ属性を受け取ることができます。 の場合 "false" 、入札者はすべての在庫を受け取ります。 必須: いいえ。 |
inventory_attribute_targets |
インベントリ属性オブジェクトの配列。 | ターゲットに含めるオブジェクトの配列 (例: )。 [{"id":12}] 有効になっている場合 use_inventory_attribute_targets は、選択した属性を含む入札要求が送信されます。 また、在庫属性を含む入札リクエストも送信します。 特定のインベントリ属性を除外するには、除外する属性を除くすべての ID を含めるだけです。必須: いいえ。 |
non_audited_url_action |
string | が に "exclude" 設定されている場合、Xandr によって監査されていないすべてのインベントリが除外されます。 それ以外の場合は、すべてのインベントリが含まれます。必須: いいえ。 |
domain_list_action |
Enum - "exclude" または "include" | に適用する既定の domain_list_target アクション。必須: いいえ。 |
domain_list_targets |
ドメイン リストの ID を持つオブジェクトの配列。 | ドメイン リスト ターゲットのオブジェクトの配列 (例: )。 [] 列挙されたドメイン リストの に domain_list_action 一致するインベントリに対する入札要求のみが入札者に送信されます。必須: いいえ。 |
domain_action |
必須: 廃止。 | |
domain_targets |
必須: 廃止。 | |
Audience | ||
segment_targets |
各 ID とアクションを持つセグメント ターゲットの配列。 | "segment_boolean_operator" が "and" の場合、セグメントが に"exclude" 設定されている場合"action" は、そのセグメント内のユーザーのインプレッションは入札者に送信されません。いずれか"action" が に"include" 設定されている場合は、含まれているセグメントのユーザーが入札者に送信されます。 が に"or" 設定されている場合"segment_boolean_operator" 、いずれかの条件をsegment_targets 満たすユーザーが入札者に送信されます。警告: 2019 年 4 月 27 日の時点で、Xandr は外部統合 DSP のプラットフォーム上のセグメントをサポートしなくなりました。 必須: いいえ。 |
segment_boolean_operator |
Enum - "and" または "or" | に適用する segment_targets アクション。 "And" は、すべての条件を満たす必要があります。 "Or" は、少なくとも 1 つを満たす必要があります。警告: 2019 年 4 月 27 日の時点で、Xandr は外部統合 DSP のプラットフォーム上のセグメントをサポートしなくなりました。 必須: いいえ。 |
サプライの種類 (Web/モバイル) | ||
supply_type_targets |
供給の種類のターゲットの配列: "mobile_app" (モバイル アプリ インベントリの場合) "mobile_web" (モバイル Web インベントリの場合) "web" (通常のディスプレイ インベントリの場合) |
に従って、どの供給タイプターゲットを含めるか除外するかを決定します supply_type_action 。必須: いいえ。 |
supply_type_action |
Enum - "exclude" または "include" | に適用する supply_type_targets アクション。必須: いいえ。 |
モバイル固有 | ||
carrier_targets |
まだサポートされていません | 必須: いいえ。 |
carrier_action |
Enum - "exclude" または "include" | に適用する carrier_targets アクション。必須: いいえ。 |
handset_make_targets |
まだサポートされていません | 必須: いいえ。 |
handset_make_action |
Enum - "exclude" または "include" | に適用する handset_make_targets アクション。必須: いいえ。 |
handset_model_targets |
まだサポートされていません | 必須: いいえ。 |
handset_model_action |
Enum - "exclude" または "include" | に適用する handset_model_targets アクション。必須: いいえ。 |
location_target_radius |
まだサポートされていません | 必須: いいえ。 |
location_target_latitude |
まだサポートされていません | 必須: いいえ。 |
location_target_longitude |
まだサポートされていません | 必須: いいえ。 |
その他 | ||
size_targets |
オブジェクトの配列 | 幅と高さの配列。入札者が入札するクリエイティブ サイズを指定します。 例えば。 [{"width":300,"height":250},{"width":600,"height":160}] 必須: いいえ。 |
現在サポートされていません | ||
language_targets |
このフィールドは現在使用できません。 | |
postal_code_targets |
このフィールドは現在使用できません。 | |
age_targets |
このフィールドは現在使用できません。 | |
daypart_targets |
このフィールドは現在使用できません。 | |
browser_targets |
このフィールドは現在使用できません。 |
国のターゲット
配列内の country_targets
各オブジェクトには、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 国の ID。 Country Service を使用して、国 ID の完全な一覧を取得できます。 |
name |
string | 読み取り専用です。 国の名前。 |
code |
string | 読み取り専用です。 国のコード。 |
国のターゲット: 例
{
"profile": {
"country_action": "include",
"country_targets": [
{
"id": 233,
"name": "United States",
"code": "US"
}
]
}
}
リージョンターゲット
配列内の region_targets
各オブジェクトには、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | リージョンの ID。 リージョン サービスを使用して、リージョン ID の一覧を取得できます。 |
name |
string | 読み取り専用です。 リージョンの名前。 |
code |
string | 読み取り専用です。 リージョンのコード。 |
country_name |
string | 読み取り専用です。 リージョンが属する国の名前。 |
country_code |
string | 読み取り専用です。 リージョンが属する国のコード。 |
リージョン ターゲット: 例
{
"profile": {
"region_action": "include",
"region_targets": [
{
"id": 1
"name": "New York",
"code": "NY",
"country_name": "United States",
"country_code": "US"
}
]
}
}
都市のターゲット
配列内の city_targets
各オブジェクトには、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 対象となる都市の ID。 City Service を使用して、市区町村 ID の一覧を取得できます。 |
name |
string | 読み取り専用です。 対象となる都市の名前。 |
region_name |
string | 読み取り専用です。 市区町村が属する地域の名前。 |
region_code |
string | 読み取り専用です。 市区町村が属する地域のコード。 |
country_name |
列挙 | 読み取り専用です。 リージョンが属する国の名前。 |
country_code |
列挙 | 読み取り専用です。 リージョンが属する国のコード。 |
市区町村のターゲット: 例
{
"profile": {
"city_action": "include",
"city_targets": [
{
"id": 123,
"name": "Queens",
"region_name": "New York",
"region_code": "NY",
"country_code": "US",
"country_name": "United States",
}
]
}
}
認証トークン
API Services を使用する場合、認証は常に最初の手順です。 認証トークンは、後で使用するために Cookie ファイルに書き込むことができます。 詳細な手順については、「 認証サービス」を参照してください。
例
bidder 6 に新しいプロファイルを追加する
新しいプロファイルの ID は 123 です。
$ cat bidder_profile:
{
"profile":
{
"description": "Only Alberta (NO US can be included)",
"country_action": "include",
"country_targets": [{"id": 1},{"ide":2}],
"region_action": "exclude",
"region_targets": [{id: 1}],
"member_targets": [
{
"id": "100",
"action": "exclude"
},
{
"id": "102",
"action": "exclude",
"name": "Inventory name 2"
}
],
"dma_targets": [{"dma":123}, {"dma":124}],
"dma_action": "exclude",
"segment_boolean_operator": "and",
"segment_targets": [
{
"id": "16808",
"name": "Users meeting certain criteria",
"action": "include",
"start_minutes": null,
"expire_minutes": null,
"other_less": null,
"other_greater": null,
"other_equals": null
},
{
"id": "16809",
"name": "Users that have seen an ad for this campaign and should not be targeted for 2 days",
"action": "exclude",
"start_minutes": null,
"expire_minutes": "2880",
"other_less": null,
"other_greater": null,
"other_equals": null,
}
],
"size_targets": [{"width":300,"height":250},{"width":600,"height":160}]
}
}
$ curl -b cookies -c cookies -X POST --data-binary @bidder_profile "https://api.adnxs.com/profile/6"
{
"response":
{
"status":"OK",
"id":"123"
}
}
bidder 6 に現在関連付けられているすべてのプロファイルを表示する
curl -b cookies -c cookies "https://api.adnxs.com/profile/6"
bidder 6 に関連付けられているプロファイル 123 を表示する
curl -b cookies -c cookies "https://api.adnxs.com/profile/6/123"
入札者のプロファイルをアクティブ化するには、 Bidder Service を使用して、入札者のフィールドを目的の入札者プロファイルの ID に設定 profile_id
します。
bidder 6 でプロファイル ID 123 を更新する
$ cat bidder_profile:
{
"profile":
{
"id": "123",
"country_action": "include",
"country_targets": [{"id": 233}]
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @bidder_profile "https://api.adnxs.com/profile/6/123"
入札者プロファイルにドメイン リストを "ブロックリスト" として追加する
ヒント
ドメイン リストの詳細については、 ドメイン リスト サービスに関するページを参照してください。
$ cat domain-list-profile
{
"profile" : {
"domain_list_targets" : [
{
"id" : 9351
}
],
"domain_list_action" : "exclude",
"id" : 431739
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @domain-list-profile 'https://api.adnxs.com/profile/497/431739'
{
"response" : {
"count" : 1,
"num_elements" : null,
"id" : "431739",
"profile" : {
"supply_type_targets" : null,
"browser_targets" : null,
"id" : 431739,
"dma_targets" : null,
"screen_size_targets" : null,
"inventory_attribute_targets" : null,
"device_type_targets" : null,
"dma_action" : "exclude",
"operating_system_targets" : null,
"domain_list_targets" : [
{
"id" : 9351,
"deleted" : false,
"type" : "black",
"description" : "Rich's awesome domain list (blocklist)",
"name" : "Rich's awesome domain list (blocklist)"
}
],
"session_freq_type" : "platform",
"operating_system_family_targets" : null,
"domain_targets" : null,
"venue_targets" : null,
"description" : "Ethical Ad Blocker Test Segment",
"city_targets" : null,
"age_targets" : null,
"domain_action" : "exclude",
"inventory_action" : "exclude",
"site_targets" : null,
"size_targets" : [
{
"width" : 300,
"height" : 50
},
{
"width" : 300,
"height" : 250
}
],
"location_target_radius" : null,
"language_action" : "exclude",
"ip_targets" : null,
"segment_targets" : [
{
"deleted" : false,
"other_greater" : null,
"name" : "ethical ad blocker segment 00",
"code" : "ethical-adblock-00",
"other_less" : null,
"expire_minutes" : null,
"action" : "include",
"other_in_list" : null,
"id" : 110944,
"other_equals" : null,
"start_minutes" : null
}
],
"is_expired" : false,
"region_action" : "exclude",
"location_target_latitude" : null,
"code" : "ethical-adblock-00",
"inventory_group_targets" : null,
"country_action" : "exclude",
"querystring_targets" : null,
"carrier_targets" : null,
"member_id" : null,
"passthrough_percent" : 100,
"segment_boolean_operator" : "or",
"intended_audience_targets" : null,
"operating_system_extended_targets" : null,
"device_model_action" : "exclude",
"language_targets" : null,
"gender_targets" : null,
"non_audited_url_action" : "include",
"inventory_network_resold_targets" : null,
"supply_type_action" : "exclude",
"daypart_targets" : null,
"daypart_timezone" : null,
"postal_code_targets" : null,
"querystring_boolean_operator" : "and",
"last_activity" : "2015-03-30 21:25:41",
"member_targets" : [
{
"action" : "include",
"billing_name" : "unexposed",
"id" : 4782,
"third_party_auditor_id" : null
}
],
"browser_family_targets" : null,
"screen_size_action" : "exclude",
"min_session_imps" : null,
"device_model_targets" : null,
"querystring_action" : "exclude",
"segment_group_targets" : null,
"country_targets" : null,
"city_action" : "exclude",
"domain_list_action" : "exclude",
"location_target_longitude" : null,
"carrier_action" : "exclude",
"position_targets" : null,
"use_inventory_attribute_targets" : false,
"device_type_action" : "exclude",
"region_targets" : null,
"browser_action" : "exclude"
},
"start_element" : null,
"status" : "OK"
}
}