Partager via

API de plateforme numérique - Service de liste de domaines

Remarque

À l’avenir, les terminologies « allowlist » et « blocklist » seront suivies pour nos API. Cela fait partie d’un effort continu visant à évaluer notre utilisation actuelle de la terminologie et à intégrer une terminologie plus inclusive pour les plateformes Xandr.

Le service Liste de domaines vous permet de définir une liste de domaines qui peuvent être inclus ou exclus du profil de ciblage d’une campagne. Les listes de domaines dans les profils de ciblage sont utilisées pour placer des domaines avec des caractéristiques similaires dans des groupes que vous pouvez utiliser pour inclure ou exclure facilement des domaines du ciblage de campagne. Elles sont généralement utilisées comme des listes d’autorisation ou des listes de blocage. Les listes d’autorisation contiennent des domaines que vous souhaitez inclure dans le ciblage de votre campagne, et les listes de blocage contiennent des domaines que vous souhaitez exclure. (Consultez domain_list_targets et domain_list_action dans le service de profil pour savoir comment inclure ces listes dans vos profils).

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/domain-list Afficher toutes les listes de domaines.
GET https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID Afficher une liste de domaines spécifique.
GET https://api.appnexus.com/domain-list?search=SEARCH_TERM Recherchez des listes de domaines avec des noms ou des descriptions contenant certains caractères.
POST https://api.appnexus.com/domain-list Ajoutez une nouvelle liste de domaines.
PUT https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID Modifier une liste de domaines existante.
DELETE https://api.appnexus.com/domain-list?id=DOMAIN_LIST_ID Supprimer une liste de domaines existante.

Champs JSON

Champ Type Description
description string(100) Description de la liste des domaines.
domains tableau Tableau de domaines au format ["domain1.com", "domain2.com", ... , "domain10.com"].

Remarque : "www" est supprimé des domaines.
Les domaines qui commencent par "www" verront la "www" sous-chaîne supprimée avant d’être stockées dans notre système. Par exemple, "www.example.org" sera raccourci à "example.org".
id int Identificateur système interne de la liste des domaines.
Obligatoire sur : PUT
last_modified string Horodatage en lecture seule de la dernière modification de la liste de domaines.
name string(100) Nom de la liste de domaines tel que spécifié par l’utilisateur. Ce nom doit être unique.
Obligatoire sur : POST
type string Type de liste de domaines. Les valeurs possibles sont black et white. Cette valeur est strictement informative ; il ne détermine pas si la liste est incluse ou exclue dans le ciblage.
Par défaut : "white"

Exemples

Ajout d’une liste de domaines

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

Affichage de la liste des domaines 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"
   }
}

Ajout de listes de domaines au profil 35 en tant que "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
   }
}

Recherche de listes de domaines avec des noms ou des descriptions contenant "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"
      }
      }
  • Last updated on