Bidders - ドメイン リスト サービス
ドメイン リストを使用して、ターゲット設定からそれぞれ含めるか除外する必要があるドメインの許可リストまたはブロックリストを作成できます。 ドメイン リスト ID は、 拡張入札者プロファイル と共に使用され、ターゲット設定に含めるドメインまたは除外するドメインを指定します。 ドメイン リストが "許可リスト" か "ブロックリスト" かを指定しても、そのリストが含まれるか除外されるかは決まらないことをお勧めします。 代わりに、domain_list_actionは 、拡張入札者プロファイル で許可リストの場合は "含める" として、ブロックリストの場合は "除外" として指定する必要があります。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | https://api.adnxs.com/domain-list |
すべてのドメイン リストを表示します。 |
| GET | https://api.adnxs.com/domain-list?id=DOMAIN_LIST_ID |
特定のドメイン リストを表示します。 注: API の使用には、"is_admin" フィールドを true に設定する必要があります。 |
| GET | https://api.adnxs.com/domain-list/search=SEARCH_TERM |
特定の文字を含む名前または説明を含むドメイン リストを検索します。 |
| POST | https://api.adnxs.com/domain-list |
新しいドメイン リストを追加します。 |
| PUT | https://api.adnxs.com/domain-list/DOMAIN_LIST_ID |
既存のドメイン リストを変更します。 |
| DELETE | https://api.adnxs.com/domain-list/DOMAIN_LIST_ID |
既存のドメイン リストを削除します。 |
JSON フィールド
| フィールド | 種類 | 説明 |
|---|---|---|
description |
string(100) | ユーザーによって指定されたドメイン リストの説明。 |
domains |
配列または文字列 | ドメインの一覧に含まれるドメイン。 形式については、以下の例を参照してください。 注: "www" はドメインから削除されます で始まる "www" ドメインでは、システムに "www"格納される前に部分文字列が削除されます。 たとえば、 "www.example.org" は に "example.org"短縮されます。 |
id |
int | ドメイン リストの内部 ID。 - 必須: PUT。 |
last_modified |
timestamp | 読み取り専用。 ドメイン リストが最後に変更された日時。 |
name |
string(100) | ユーザーによって指定されたドメイン リストの名前。 - 必須: POST。 |
type |
string | ドメイン リストの種類。 可能な値は、"black" と "white" です。 これは厳密に情報です。 ここでの値は、リストが含まれるか除外されるかを決定しません。- 既定値: "white" |
注:
ドメイン リストを作成する API ユーザーのみが、そのドメイン リストの内容を表示および編集できます。
例
ドメイン リストを追加する
$ cat domain-list
{
"domain-list" : {
"type" : "black",
"domains" : [
"baddomain.com",
"worsedomain.net",
"worstdomain.org"
],
"description" : "Rich's awesome domain list (blocklist)",
"name" : "Rich's awesome domain list (blocklist)"
}
}
$ curl -b cookies -c cookies -X POST --data-binary @domain-list 'https://api.adnxs.com/domain-list'
{
"response":{
"status":"OK",
"count":1,
"start_element":null,
"num_elements":null,
"id":9351,
"domain-list":{
"id":9351,
"name":"Rich's awesome domain list (blocklist)",
"description":"Rich's awesome domain list (blocklist)",
"type":"black",
"last_modified":"2015-03-30 21:14:05",
"domains":["baddomain.com","worsedomain.net","worstdomain.org"]
}
}
}
ドメイン リストを表示する
$ curl -b cookies -c cookies 'https://api.adnxs.com/domain-list/9'
{
"response":{
domain-list":{
"id":9,
"name":"Domains to exclude",
"description":"A list of the domains to target for the parent profile allowlist",
"type":"black",
"domains":[
"baddomain.com",
"worsedomain.net",
"worstdomain.org"
]
},
"status":"OK"
}
}
入札者プロファイルにドメイン リストを "ブロックリスト" として追加する
注:
次の使用例は、 拡張入札者プロファイルを使用してドメイン リストをターゲットにします。
$ cat domain-list-profile
{
"bidder_profile" : {
"domain_lists" : {
"action" : "exclude",
"targets" : [
{
"id" : 918698,
}
]
}}}
$ curl -b cookies -c cookies -X PUT --data-binary @domain-list-profile 'https://api.adnxs.com/bidder-profile/497/431739'
{
"response" : {
"profile" : {
"last_activity" : "2015-03-30 21:25:41",
"inv_class_targets" : null,
"inventory_group_targets" : null,
"session_freq_type" : "platform",
"age_targets" : null,
"dma_targets" : null,
"language_targets" : null,
"domain_targets" : null,
"domain_list_targets" : [
{
"name" : "Rich's awesome domain list (blocklist)",
"id" : 9351,
"description" : "Rich's awesome domain list (blocklist)",
"type" : "black",
"deleted" : false
}
],
"country_targets" : null,
"operating_system_family_targets" : null,
"device_type_action" : "exclude",
"querystring_action" : "exclude",
"intended_audience_targets" : null,
"description" : "Ethical Ad Blocker Test Segment",
"position_targets" : null,
"city_targets" : null,
"device_model_targets" : null,
"carrier_action" : "exclude",
"device_type_targets" : null,
"language_action" : "exclude",
"non_audited_url_action" : "include",
"location_target_radius" : null,
"ip_targets" : null,
"domain_list_action" : "exclude",
"passthrough_percent" : 100,
"segment_group_targets" : null,
"size_targets" : [
{
"height" : 50,
"width" : 300
},
{
"width" : 300,
"height" : 250
}
],
"browser_action" : "exclude",
"city_action" : "exclude",
"operating_system_extended_targets" : null,
"browser_family_targets" : null,
"querystring_targets" : null,
"querystring_boolean_operator" : "and",
"screen_size_action" : "exclude",
"postal_code_targets" : null,
"region_targets" : null,
"segment_targets" : [
{
"expire_minutes" : null,
"other_greater" : null,
"other_less" : null,
"other_in_list" : null,
"action" : "include",
"deleted" : false,
"start_minutes" : null,
"name" : "ethical ad blocker segment 00",
"id" : 110944,
"code" : "ethical-adblock-00",
"other_equals" : null
}
],
"device_model_action" : "exclude",
"inventory_source_targets" : null,
"inventory_action" : "exclude",
"country_action" : "exclude",
"use_inventory_attribute_targets" : false,
"segment_boolean_operator" : "or",
"supply_type_targets" : null,
"is_expired" : false,
"carrier_targets" : null,
"daypart_timezone" : null,
"code" : "ethical-adblock-00",
"inventory_attribute_targets" : null,
"region_action" : "exclude",
"site_targets" : null,
"domain_action" : "exclude",
"browser_targets" : null,
"gender_targets" : null,
"min_session_imps" : null,
"dma_action" : "exclude",
"venue_targets" : null,
"id" : 431739,
"member_targets" : [
{
"id" : 4782,
"billing_name" : "unexposed",
"action" : "include",
"third_party_auditor_id" : null
}
],
"screen_size_targets" : null,
"inventory_network_resold_targets" : null,
"member_id" : null,
"location_target_longitude" : null,
"supply_type_action" : "exclude",
"location_target_latitude" : null,
"daypart_targets" : null,
"operating_system_targets" : null
},
"id" : "431739",
"num_elements" : null,
"count" : 1,
"start_element" : null,
"status" : "OK"
}
}
"Test" を含む名前または説明を含むドメイン リストを検索する
$ curl -b cookies -c cookies "https://api.adnxs.com/domain-list/search=test"
{
"response": {
"status": "OK",
"domain-lists": [
{
"id": 1733,
"name": "Add Test",
"description": "",
"type": "white",
"domains": [
"amblergazette.com",
"facebook.com",
"google.com",
"zwire.com"
],
"last_modified": "2011-03-10 18:03:07"
}
]
}
}