Licitadores: servicio de lista de dominios
Las listas de dominios se pueden usar para crear una lista de permitidos o una lista de bloqueo de dominios que se deben incluir o excluir, respectivamente, de la selección de destino. Los identificadores de lista de dominios se usan con los perfiles de licitador mejorados para especificar qué dominios deben incluirse o excluirse de la selección de destino. Tenga en cuenta que especificar si una lista de dominios es una "lista de permitidos" o una "lista de bloqueos" no determina si esa lista se incluirá o excluirá. En su lugar, el domain_list_action debe especificarse en los perfiles del licitador mejorado como "include" para las listas de permitidos y "exclude" para las listas de bloqueados.
API de REST
| Http (método) | Endpoint | Description |
|---|---|---|
| GET | https://api.adnxs.com/domain-list |
Ver todas las listas de dominios. |
| GET | https://api.adnxs.com/domain-list?id=DOMAIN_LIST_ID |
Ver una lista de dominios específica. Nota: El uso de la API debe tener el campo "is_admin" establecido en true. |
| GET | https://api.adnxs.com/domain-list/search=SEARCH_TERM |
Busque listas de dominios con nombres o descripciones que contengan determinados caracteres. |
| POST | https://api.adnxs.com/domain-list |
Agregue una nueva lista de dominios. |
| PUT | https://api.adnxs.com/domain-list/DOMAIN_LIST_ID |
Modificar una lista de dominios existente. |
| DELETE | https://api.adnxs.com/domain-list/DOMAIN_LIST_ID |
Elimine una lista de dominios existente. |
Campos JSON
| Campo | Tipo | Description |
|---|---|---|
description |
string(100) | Descripción de la lista de dominios especificada por el usuario. |
domains |
matriz o cadenas | Dominios incluidos en la lista de dominios. Consulte los ejemplos siguientes para obtener formato. Nota: "www" se quita de los dominios Los dominios que empiecen por "www" tendrán la "www"subcadena eliminada antes de almacenarse en nuestro sistema. Por ejemplo, "www.example.org" se acortará a "example.org". |
id |
Entero | Identificador interno de la lista de dominios. - Obligatorio en: PUT. |
last_modified |
Timestamp | Solo lectura. El día y la hora en que se cambió por última vez la lista de dominios. |
name |
string(100) | Nombre de la lista de dominios especificado por el usuario. - Obligatorio activado: POST. |
type |
string | Tipo de lista de dominios. Valores posibles: "black" y "white". Esto es estrictamente informativo. El valor aquí no determina si la lista está incluida o excluida.- Valor predeterminado: "blanco". |
Nota:
Solo el usuario de api que crea una lista de dominios puede ver y editar el contenido de esa lista de dominios.
Ejemplos
Agregar una lista de dominios
$ 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"]
}
}
}
Visualización de una lista de dominios
$ 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"
}
}
Agregue una lista de dominios al perfil del licitador como una "lista de bloqueos"
Nota:
Este ejemplo tiene como destino las listas de dominios que usan los perfiles de licitador mejorado.
$ 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"
}
}
Buscar listas de dominios con nombres o descripciones que contengan "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"
}
]
}
}