Service de liste de codes postaux

2025-04-01

Dans la méthode traditionnelle de ciblage géographique des audiences, les utilisateurs peuvent cibler uniquement un nombre limité de codes postaux au niveau de l’élément de ligne ou du fractionnement. Avec l’introduction de l’API de service de liste de codes postaux dans la plateforme Xandr, cette limitation sera supprimée. L’API Liste de codes postaux permet aux acheteurs de créer une liste de codes postaux et de la réutiliser sur différents objets (éléments de ligne, fractionnements) pour le ciblage. Avec le service de liste de codes postaux, les utilisateurs peuvent désormais cibler 100 000 codes postaux sur une liste individuelle et 100 listes individuelles sur un élément de ligne ou un fractionnement.

Le service Liste de codes postaux permet aux utilisateurs d’effectuer les tâches suivantes :

Rechercher, créer, récupérer et supprimer une liste de codes postaux spécifique ou différente, inclure et exclure des listes de codes postaux contenant un certain nombre de codes postaux (par ID de code postal).
Activez l’inclusion et l’exclusion du ciblage de la liste de codes postaux au niveau de l’élément de ligne et du fractionnement.

Importante

Le nombre maximal de listes de codes postaux autorisés par membre est de 8 000.
Les listes de codes postaux qui n’ont pas été modifiées depuis six mois et qui ne sont pas associées à des articles de ligne qui ont servi au cours des six derniers mois peuvent être supprimées par Xandr.

Remarque

Tous les paramètres de requête du service de liste de codes postaux prennent en charge une liste de valeurs séparées par des virgules. Par exemple, pour supprimer un ensemble de listes de codes postaux, une liste d’ID séparés par des virgules peut être passée en tant que paramètres de requête.

API REST

HTTP, méthode	Endpoint	Description
`POST`	https://api.appnexus.com/postal-code-list	Ajoutez une nouvelle liste de codes postaux.
`PUT`	https://api.appnexus.com/postal-code-list	Modifier une liste de codes postaux.
`DELETE`	https://api.appnexus.com/postal-code-list?id=POSTAL_CODE_LIST_ID	Supprimer une liste de codes postaux.
`DELETE`	https://api.appnexus.com/postal-code-list?id=POSTAL_CODE_LIST_ID1,POSTAL_CODE_LIST_ID2,POSTAL_CODE_LIST_ID3	Supprimez plusieurs Listes de code postal.
`GET`	https://api.appnexus.com/postal-code-list	Affichez tous les codes postaux Listes et codes postaux qu’ils contiennent.
`GET`	https://api.appnexus.com/postal-code-list?name=POSTAL_CODE_LIST_NAME	Affichez une liste de codes postaux par nom et codes postaux qu’elle contient.
`GET`	https://api.appnexus.com/postal-code-list?id=POSTAL_CODE_LIST_ID	Affichez une liste de codes postaux et des codes postaux spécifiques qu’elle contient.
`GET`	https://api.appnexus.com/postal-code-list?postal_code_id=POSTAL_CODE_ID	Afficher tous les Listes de code postal contenant un code postal.
`GET`	https://api.appnexus.com/postal-code-list?search=SEARCH_TERM	Recherchez une liste de codes postaux par ID ou nom en tant que terme de recherche. Remarque : `SEARCH_TERM` peut être `POSTAL_CODE_ID` ou `POSTAL_CODE_LIST_NAME` contenir certains caractères.
`GET`	https://api.appnexus.com/postal-code-list?line_item_id=LINE_ITEM_ID	Afficher toutes les Listes de code postal ciblées par un élément de ligne.

Champs JSON

Champ	Type	Description
`id`	int	ID d’une liste de codes postaux. Obligatoire sur :`PUT`
`name`	string	Nom de la liste de codes postaux. Obligatoire sur :`POST`
`postal_codes`	tableau d’objets	Codes postaux à inclure dans la liste des codes postaux. Les ID de code postal des codes postaux sont inclus ici. Par exemple, consultez les formats qui peuvent être utilisés. Remarque : Pour les États-Unis, vous pouvez cibler le code postal complet à 9 chiffres (également appelé zip +4). Par exemple, voir ci-dessous. Obligatoire sur :`POST` et `PUT`.
`advertiser_ids`	tableau d’objets	Facultatif. Indique quels annonceurs ont accès à la liste de codes postaux (PCL). Ce champ permet d’associer un ou plusieurs annonceurs à la LCP. Un maximum de 50 annonceurs est autorisé par PCL. Si le `advertiser_ids` champ n’est pas spécifié, par défaut, le PCL est ouvert à tous les annonceurs. Par exemple, voir ci-dessous.
`last_modified`	Timestamp	Heure de la dernière modification apportée à la liste des codes postaux. Il s’agit d’un champ En lecture seule .
`created_on`	Timestamp	Heure de création de la liste de codes postaux. Il s’agit d’un champ En lecture seule .
`line_items`	tableau d’objets	Éléments de ligne qui ciblent la liste de codes postaux (éléments de ligne auxquels un profil est attaché et ce profil cible la liste de codes postaux). Il s’agit d’un champ En lecture seule . Par exemple, voir ci-dessous.

`postal_codes` Formats

"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` Exemple

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

`advertiser_ids` Exemple

JSON de l’API avec le champ facultatif 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}
         ] 
      }
   ]
}

Exemple de réponse :

{
    "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` Exemple

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

Exemples

Create une liste de codes postaux

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

Mettre à jour une liste de codes postaux

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

Ajouter un nouveau code postal à la liste de codes postaux

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

Supprimer une liste de codes postaux

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

Partager via

Service de liste de codes postaux

API REST

Champs JSON

postal_codes Formats

postal_codes Exemple

advertiser_ids Exemple

line_items Exemple