API Plateforme numérique - Service Ville

Le service municipal en lecture seule vous permet de voir des informations sur les villes inscrites dans le système Xandr, y compris la région, la zone de marché désignée et le pays auquel chaque ville appartient. Vous pouvez utiliser ce service pour récupérer les ID des villes pour le ciblage dans les campagnes (voir city_targets dans le service de profil).

API REST

HTTP, méthode	Endpoint	Description
`GET`	https://api.appnexus.com/city	Afficher toutes les villes.
`GET`	https://api.appnexus.com/city?country_code=COUNTRY_CODE	Afficher toutes les villes d’un pays spécifique.
`GET`	https://api.appnexus.com/city?country_name=COUNTRY_NAME	Afficher toutes les villes d’un pays spécifique.
`GET`	https://api.appnexus.com/city?dma_id=DMA_ID	Afficher toutes les villes d’une zone de marché désignée spécifique.
`GET`	https://api.appnexus.com/city?dma_name=DMA_NAME	Afficher toutes les villes d’une zone de marché désignée spécifique.
`GET`	https://api.appnexus.com/city?id=ID	Afficher une ville spécifique par ID.
`GET`	https://api.appnexus.com/city?name=NAME	Affichez une ville spécifique par nom.
`GET`	https://api.appnexus.com/city/meta	Découvrez les champs que vous pouvez filtrer et trier.

Champs JSON

Champ	Type	Description
`id`	int	ID de la ville.
`name`	string	Nom de la ville.
`country_id`	int	ID du pays auquel appartient la ville. Vous pouvez utiliser country service pour récupérer la liste complète des ID de pays.
`country_name`	string	Nom du pays auquel appartient la ville. Vous pouvez utiliser le service de pays pour récupérer la liste complète des noms de pays.
`country_code`	string	Code ISO du pays auquel appartient la ville. Vous pouvez utiliser le service pays pour récupérer la liste complète des codes pays.
`region_id`	int	ID de la région à laquelle appartient la ville. Vous pouvez utiliser le service de région pour récupérer une liste complète des ID de région.
`region_name`	string	Nom de la région à laquelle la ville appartient. Vous pouvez utiliser le service de région pour récupérer la liste complète des noms de région.
`region_code`	chaîne	Code ISO ou FIPS de la région à laquelle la ville appartient. Vous pouvez utiliser le service régional pour récupérer une liste complète des codes de région.
`dma_id`	int	ID de la zone de marché désignée à laquelle appartient la ville. Vous pouvez utiliser le service de zone de marché désignée pour récupérer une liste complète des ID DMA.
`dma_name`	string	Nom de la zone de marché désignée à laquelle appartient la ville. Vous pouvez utiliser le service de zone de marché désignée pour récupérer une liste complète des noms DMA.
`active`	Valeur booléenne	Si `true`la valeur est , la ville est disponible pour le ciblage. Si `false`la valeur est , il n’existe aucune donnée de géolocalisation pour la ville et la livraison n’est donc pas possible.

Exemples

Afficher toutes les villes en Allemagne

$ 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"
            },
            ...
        ]
    }
}

Afficher toutes les villes de la région bayern d’Allemagne

$ 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"
      },
      ...
    ]
  }
}

Afficher toutes les villes nommées « Ensemble »

$ 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"
            }
        ]
    }
}

Last updated on 2025-10-22

Partager via