Compartir a través de

API de plataforma digital: servicio de lista de dominios

  • Artículo

Nota:

En el futuro, se seguirá la terminología de "allowlist" y "blocklist" para nuestras API. Esto forma parte de un esfuerzo continuo para evaluar el uso actual de la terminología y dar inicio a una terminología más inclusiva para las plataformas Xandr.

El servicio Lista de dominios le permite definir una lista de dominios que se pueden incluir o excluir del perfil de destino de una campaña. Las listas de dominios de los perfiles de destino se usan para colocar dominios con características similares en grupos que se pueden usar para incluir o excluir fácilmente dominios de la segmentación de campaña. Por lo general, se usan como listas de permitidos o listas de bloqueo. Las listas de permitidos contienen dominios que quieres incluir en la segmentación de la campaña y las listas de bloqueados contienen dominios que quieres excluir. (Consulte domain_list_targets y domain_list_action en el Servicio de perfiles para ver cómo incluir estas listas en los perfiles).

API de REST

Http (método) Endpoint Description
GET https://api.appnexus.com/domain-list Ver todas las listas de dominios.
GET https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID Ver una lista de dominios específica.
GET https://api.appnexus.com/domain-list?search=SEARCH_TERM Busque listas de dominios con nombres o descripciones que contengan determinados caracteres.
POST https://api.appnexus.com/domain-list Agregue una nueva lista de dominios.
PUT https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID Modificar una lista de dominios existente.
DELETE https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID Elimine una lista de dominios existente.

Campos JSON

Campo Tipo Description
description string(100) Descripción de la lista de dominios.
domains matriz Matriz de dominios con el formato ["domain1.com", "domain2.com", ... , "domain10.com"].

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 del sistema de la lista de dominios.
Obligatorio activado: PUT
last_modified string Marca de tiempo de solo lectura de la última vez que se cambió la lista de dominios.
name string(100) Nombre de la lista de dominios especificado por el usuario. Este nombre debe ser único.
Obligatorio activado: POST
type string Tipo de lista de dominios. Valores posibles: black y white. Este valor es estrictamente informativo; no determina si la lista está incluida o excluida en la selección de destino.
Valor predeterminado: "white"

Ejemplos

Adición de una lista de dominios

$ cat domain-list

{
   "domain-list":{
      "name":"Domains to target",
      "description":"A list of the domains to target for Campaign A",
      "type":"white",
      "domains":["domain-a.com", "domain-b.net", "domain-c.org"]
   }
}

$ curl -b cookies -c cookies -X POST --data-binary @domain-list 'https://api.appnexus.com/domain-list'

{
   "response":{
      "status":"OK",
      "id":9
   }
}

Visualización de la lista de dominios 9

$ curl -b cookies -c cookies 'https://api.appnexus.com/domain-list?id=9'

{
   "response":{
      "domain-list":{
         "id":9,
         "name":"Domains to target",
         "description":"A list of the domains to target for Campaign A",
         "type":"white",
         "domains":["domain-a.com", "domain-b.net", "domain-c.org"]
      }
      "status":"OK"
   }
}

Adición de listas de dominio al perfil 35 como un "allowlist"

$ cat domain-list-profile

{
   "profile":{
      "id":35,
      "domain_list_targets":[{"id":9}, {"id":10}, {"id":15}, {"id":18}],
      "domain_list_action":"include",
   }
}

$ curl -b cookies -c cookies -X PUT --data-binary @domain-list-profile 'https://api.appnexus.com/profile?id=35'

{
   "response":{
      "status":"OK",
      "id":35
   }
}

Búsqueda de listas de dominios con nombres o descripciones que contengan "test"

$ curl -b cookies -c cookies 'https://api.appnexus.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"
      }
      }