Servicio de lista de códigos postales

Artículo
07/05/2024

En el modo tradicional de segmentación geográfica de audiencias, los usuarios solo pueden dirigirse a un número limitado de códigos postales en el nivel de línea o división. Con la introducción de Postal Code List Service API en la plataforma Xandr, se eliminará esta limitación. La API de lista de códigos postales permitirá a los compradores crear una lista de códigos postales y reutilizarla entre diferentes objetos (elementos de línea, divisiones) para la selección de destino. Con el servicio de lista de códigos postales, los usuarios ahora pueden tener como destino 100 000 códigos postales en una lista individual y 100 listas individuales en un elemento de línea o dividirse.

El servicio Lista de códigos postales permite a los usuarios:

Busque, cree, capture y elimine una lista de códigos postales específica o diferente, incluya y excluya listas de códigos postales que contengan un número de códigos postales (por id. de código postal).
Habilite incluir y excluir el destino de la lista de códigos postales en el elemento de línea y el nivel de división.

Importante

El número máximo de listas de códigos postales permitidos por miembro es de 8000.
Las listas de códigos postales que no se han modificado en seis meses y que no están asociadas a los artículos de línea que se han servido en los últimos seis meses pueden ser eliminadas por Xandr.

Nota:

Todos los parámetros de consulta del servicio de lista de códigos postales admiten una lista de valores separados por comas. Por ejemplo, para eliminar un conjunto de listas de código postal, se puede pasar una lista separada por comas de identificadores como parámetros de consulta.

API de REST

Http (método)	Endpoint	Description
`POST`	https://api.appnexus.com/postal-code-list	Agregue una nueva lista de códigos postales.
`PUT`	https://api.appnexus.com/postal-code-list	Modificar una lista de códigos postales.
`DELETE`	https://api.appnexus.com/postal-code-list?id=POSTAL_CODE_LIST_ID	Eliminar una lista de códigos postales.
`DELETE`	https://api.appnexus.com/postal-code-list?id=POSTAL_CODE_LIST_ID1,POSTAL_CODE_LIST_ID2,POSTAL_CODE_LIST_ID3	Eliminar varias listas de códigos postales.
`GET`	https://api.appnexus.com/postal-code-list	Ver todas las listas de códigos postales y códigos postales que contienen.
`GET`	https://api.appnexus.com/postal-code-list?name=POSTAL_CODE_LIST_NAME	Ver una lista de códigos postales por nombre y códigos postales que contiene.
`GET`	https://api.appnexus.com/postal-code-list?id=POSTAL_CODE_LIST_ID	Ver una lista de códigos postales y códigos postales específicos que contiene.
`GET`	https://api.appnexus.com/postal-code-list?postal_code_id=POSTAL_CODE_ID	Ver todas las listas de códigos postales que contienen un código postal.
`GET`	https://api.appnexus.com/postal-code-list?search=SEARCH_TERM	Busque una lista de códigos postales por identificador o nombre como término de búsqueda. Nota: `SEARCH_TERM` puede ser `POSTAL_CODE_ID` o `POSTAL_CODE_LIST_NAME` contener ciertos caracteres.
`GET`	https://api.appnexus.com/postal-code-list?line_item_id=LINE_ITEM_ID	Ver todas las listas de código postal destinadas a un elemento de línea.

Campos JSON

Campo	Tipo	Descripción
`id`	Entero	Identificador de una lista de códigos postales. Obligatorio activado:`PUT`
`name`	string	Nombre de la lista de códigos postales. Obligatorio activado:`POST`
`postal_codes`	matriz de objetos	Códigos postales que se incluirán en la lista de códigos postales. Aquí se incluyen los identificadores de código postal de los códigos postales. Por ejemplo, vea los formatos que se pueden usar. Nota: Para los Ee. UU., puede dirigirse al código postal completo de 9 dígitos (también conocido como zip +4). Por ejemplo, consulte a continuación. Obligatorio activado:`POST` y `PUT`.
`advertiser_ids`	matriz de objetos	Opcional. Indica qué anunciantes tienen acceso a la Lista de códigos postales (PCL). Este campo permitirá asociar uno o varios anunciantes a la PCL. Se permite un máximo de 50 anunciantes por PCL. Si no se especifica el `advertiser_ids` campo, de forma predeterminada, la PCL está abierta a todos los anunciantes. Por ejemplo, consulte a continuación.
`last_modified`	Timestamp	Hora de la última modificación realizada en la lista de códigos postales. Es un campo de solo lectura .
`created_on`	Timestamp	Hora de creación de la lista de códigos postales. Es un campo de solo lectura .
`line_items`	matriz de objetos	Los elementos de línea que tienen como destino la lista de códigos postales (elementos de línea que tienen un perfil asociado y ese perfil está destinado a la lista de códigos postales). Es un campo de solo lectura . Por ejemplo, consulte a continuación.

`postal_codes` Formatos

"postal_codes":[
{"id": 1},
{"id": 2},
{"id": 3}
],

"postal_codes": [
{"country_code":"US","code":"10010"},
{"country_code":"US","code":"10111"},
{"country_code":"US","code":"10100"}
],

`postal_codes` ejemplo

"postal_codes":[{"country_code":"US","code":"10010-7456"}],

`advertiser_ids` ejemplo

JSON de API con el campo opcional advertiser_ids :

{
   "postal-code-lists":[
      {
         "postal_codes":[
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ],
         "name":"My first postal code list"
         "advertiser_ids":[
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ] 
      }
   ]
}

Respuesta de ejemplo:

{
    "response": {
        "status": "OK",
        "count": 2,
        "id": 169386,
        "start_element": 0,
        "num_elements": 100,
        "postal-code-list": {
            "id": 169386,
            "code": null,
            "name": "My first postal code list",
            "description": null,
            "created_on": "2023-08-14 15:36:17",
            "last_modified": "2023-08-14 15:36:17",
            "postal_codes_count": 1,
            "postal_codes": [
                {
                    "id": 1,
                    "code": "00010",
                    "country_id": 113,
                    "active": true,
                    "country_code": "IT",
                    "country_name": "Italy"
                },
                {
                    "id": 2,
                    "code": "00010",
                    "country_id": 113,
                    "active": true,
                    "country_code": "IT",
                    "country_name": "Italy"
                },
                {
                    "id": 3,
                    "code": "00010",
                    "country_id": 113,
                    "active": true,
                    "country_code": "IT",
                    "country_name": "Italy"
                }
            ],
            "line_items": null,
            "advertiser_ids":[
               {"id": 1}, {"id": 2}, {"id": 3}
            ], 
        },
        "dbg_info": {
            "warnings": [],
            "version": "1.2.216",
            "output_term": "postal-code-list"
        }
    }
}

`line_items` ejemplo

"line_items":[
{
"id" : 1,
"name": "LINE_ITEM1",
"code": null
},
{
"id" : 2,
"name": "LINE_ITEM2",
"code": null
}
],

Ejemplos

Crear una lista de códigos postales

$ cat postal-code-list-create

{
   "postal-code-lists":[
      {
         "postal_codes":[
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ],
         "name":"My first postal code list"
      },
      {
         "postal_codes": [ 
            {"country_code":"US","code":"10011"},
            {"country_code":"US","code":"10110"},
            {"country_code":"US","code":"11111"}
        ],
         "name":"Another one"
      }
   ]
}

$ curl -b cookies -X POST -d @postal-code-list-create 'https://api.appnexus.com/postal-code-list'
{
    "response": {
        "status": "OK",
        "postal-code-list": {
           "id": 3901,
           "name": "My first postal code list"
           ....
         }
    }
}

Actualización de una lista de códigos postales

$ cat postal-code-list-update

{
    "postal-code-list": {
        "id": 3901,
        "name": "Modified Postal Code List name",
        "description": "Modified Postal Code List description",
        "postal_codes": [
            {"id": 2}
        ]
    }
}

$ curl -b cookies -X PUT -d @postal-code-list-update 'https://api.appnexus.com/postal-code-list'
{
    "response": {
        "status": "OK",
        "postal-code-list": {
           "id": 3901,
           "name": "modified postal code list name"
           "description": "Updated Description",
           ....
         }
    }
}

Agregar un nuevo código postal a la lista de códigos postales

$ cat postal-code-list-update

{
    "postal-code-list": {
        "id": 3901,
        "postal_codes": [
            {"id": 9987}
        ]
    }
}

$ curl -b cookies -X PUT -d @postal-code-list-update 'https://api.appnexus.com/postal-code-list&append=true'

{
    "response": {
        "status": "OK",
        "postal-code-list": {
           "id": 3901,
           "postal_codes": [
            {"id": 9987}
        ]
    }
}

Eliminar una lista de códigos postales

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/postal-code-list?id=3901'

{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null
    }
}

Compartir a través de

Servicio de lista de códigos postales

API de REST

Campos JSON

`postal_codes` Formatos

`postal_codes` ejemplo

`advertiser_ids` ejemplo

`line_items` ejemplo

Ejemplos

Crear una lista de códigos postales

Actualización de una lista de códigos postales

Agregar un nuevo código postal a la lista de códigos postales

Eliminar una lista de códigos postales

Recursos adicionales

Compartir a través de

Servicio de lista de códigos postales

API de REST

Campos JSON

postal_codes Formatos

postal_codes ejemplo

advertiser_ids ejemplo

line_items ejemplo

Ejemplos

Crear una lista de códigos postales

Actualización de una lista de códigos postales

Agregar un nuevo código postal a la lista de códigos postales

Eliminar una lista de códigos postales

Temas relacionados

Recursos adicionales

`postal_codes` Formatos

`postal_codes` ejemplo

`advertiser_ids` ejemplo

`line_items` ejemplo