API de plataforma digital: servicio de ciudad

Artículo
05/17/2024

El servicio de ciudad de solo lectura le permite ver información sobre las ciudades registradas en el sistema Xandr, incluida la región, el área de mercado designada y el país al que pertenece cada ciudad. Puede usar este servicio para recuperar los identificadores de ciudades para dirigirse a campañas (consulte city_targets el servicio de perfil).

API de REST

Http (método)	Endpoint	Description
`GET`	https://api.appnexus.com/city	Ver todas las ciudades.
`GET`	https://api.appnexus.com/city?country_code=COUNTRY_CODE	Ver todas las ciudades de un país específico.
`GET`	https://api.appnexus.com/city?country_name=COUNTRY_NAME	Ver todas las ciudades de un país específico.
`GET`	https://api.appnexus.com/city?dma_id=DMA_ID	Ver todas las ciudades en un área de mercado específica designada.
`GET`	https://api.appnexus.com/city?dma_name=DMA_NAME	Ver todas las ciudades en un área de mercado específica designada.
`GET`	https://api.appnexus.com/city?id=ID	Ver una ciudad específica por identificador.
`GET`	https://api.appnexus.com/city?name=NAME	Ver una ciudad específica por nombre.
`GET`	https://api.appnexus.com/city/meta	Averigüe por qué campos puede filtrar y ordenar.

Campos JSON

Campo	Tipo	Description
`id`	Entero	El identificador de la ciudad.
`name`	string	Nombre de la ciudad.
`country_id`	Entero	El identificador del país al que pertenece la ciudad. Puede usar country service para recuperar una lista completa de identificadores de país.
`country_name`	string	Nombre del país al que pertenece la ciudad. Puede usar country service para recuperar una lista completa de nombres de país.
`country_code`	string	El código ISO del país al que pertenece la ciudad. Puede usar country service para recuperar una lista completa de códigos de país.
`region_id`	Entero	Identificador de la región a la que pertenece la ciudad. Puede usar el Servicio de región para recuperar una lista completa de identificadores de región.
`region_name`	string	Nombre de la región a la que pertenece la ciudad. Puede usar el Servicio de región para recuperar una lista completa de nombres de región.
`region_code`	string	Código ISO o FIPS para la región a la que pertenece la ciudad. Puede usar el Servicio de región para recuperar una lista completa de códigos de región.
`dma_id`	Entero	El identificador de la zona de mercado designada a la que pertenece la ciudad. Puede usar el Servicio de área de mercado designada para recuperar una lista completa de identificadores DMA.
`dma_name`	string	Nombre de la zona de mercado designada a la que pertenece la ciudad. Puede usar el Servicio de área de mercado designada para recuperar una lista completa de nombres DMA.
`active`	Booleano	Si `true`es , la ciudad está disponible para la selección de destino. Si `false`es , no hay datos de geolocalización para la ciudad, por lo que la entrega no es posible.

Ejemplos

Ver todas las ciudades de Alemania

$ curl -b cookies -c cookies 'https://api.appnexus.com/city?country_code=DE'
{
    "response": {
        "status": "OK",
        "count": 15769,
        "start_element": 0,
        "num_elements": 100,
        "cities": [
            {
                "id": 36677,
                "name": "Aach",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            {
                "id": 36678,
                "name": "Aalen",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            {
                "id": 36679,
                "name": "Abstatt",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            ...
        ]
    }
}

Ver todas las ciudades de la región de Bayern de Alemania

$ curl -b cookies -c cookies 'https://api.appnexus.com/city?region_name=Bayern'
{
  "response": {
    "status": "OK",
    "count": 3066,
    "start_element": 0,
    "num_elements": 100,
    "cities": [
      {
        "id": 39026,
        "name": "Abenberg",
        "region_id": 826,
        "region_name": "Bayern",
        "region_code": "02",
        "country_id": 59,
        "country_name": "Germany",
        "country_code": "DE",
        "dma_id": 1,
        "dma_name": "--",
        "active": true,
        "last_modified": "2015-04-09 19:40:57"
      },
      {
        "id": 39027,
        "name": "Abensberg",
        "region_id": 826,
        "region_name": "Bayern",
        "region_code": "02",
        "country_id": 59,
        "country_name": "Germany",
        "country_code": "DE",
        "dma_id": 1,
        "dma_name": "--",
        "active": true,
        "last_modified": "2015-04-09 19:40:57"
      },
      {
        "id": 39028,
        "name": "Absberg",
        "region_id": 826,
        "region_name": "Bayern",
        "region_code": "02",
        "country_id": 59,
        "country_name": "Germany",
        "country_code": "DE",
        "dma_id": 1,
        "dma_name": "--",
        "active": true,
        "last_modified": "2015-04-09 19:40:57"
      },
      ...
    ]
  }
}

Ver todas las ciudades llamadas "Karlsruhe"

$ curl -b cookies -c cookies 'https://api.appnexus.com/city?name=Karlsruhe'
{
    "response": {
        "status": "OK",
        "count": 2,
        "start_element": 0,
        "num_elements": 100,
        "cities": [
            {
                "id": 37739,
                "name": "Karlsruhe",
                "region_id": 825,
                "region_name": "Baden-Wurttemberg",
                "region_code": "01",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "dma_id": 1,
                "dma_name": "--",
                "active": true,
                "last_modified": "2015-04-09 19:40:57"
            },
            {
                "id": 195431,
                "name": "Karlsruhe",
                "region_id": 3952,
                "region_name": "North Dakota",
                "region_code": "ND",
                "country_id": 233,
                "country_name": "United States",
                "country_code": "US",
                "dma_id": 687,
                "dma_name": "Minot-Bismarck-Dickinson(Williston) ND",
                "active": false,
                "last_modified": "2016-10-19 05:01:12"
            }
        ]
    }
}

Compartir a través de