Partager via

Service de code d’inventaire externe

Certains vendeurs utilisent leurs propres codes pour décomposer leur inventaire de manière plus précise que par placement de site > d’éditeur>. Le service de code d’inventaire externe vous permet d’inscrire ces codes auprès de Xandr afin de pouvoir les transmettre lors d’appels publicitaires, puis de les signaler.

Voici le principe de fonctionnement :

  1. Vous devez effectuer un POST appel à ce service pour inscrire un code d’inventaire externe auprès de Xandr avant les étapes 2 et 3.
  2. Vous transmettez le code comme ext_inv_code dans la chaîne de requête des appels publicitaires basés sur des étiquettes (voir l’exemple ci-dessous), ou en définissant une extInvCode valeur via l’API defineTag d’AST ou l’API du Kit de développement logiciel (SDK) mobile.
  3. Vous pouvez ensuite créer des rapports sur l’ID/nom d’inventaire externe (mappés à partir du code d’inventaire externe via le service API décrit dans cette page) dans l’un des rapports/flux suivants (auxquels vous avez accès) :

Exemple de balise de placement avec code d’inventaire externe

<script src="https://ib.adnxs.com/ttj?id=1234&ext_inv_code=ABC" type="text/javascript"></script>

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/external-inv-code Affichez tous vos codes d’inventaire externes.
GET https://api.appnexus.com/external-inv-code?publisher_id=PUBLISHER_ID Afficher tous les codes d’inventaire externes pour un éditeur spécifique.
GET https://api.appnexus.com/external-inv-code?id=ID Afficher un code d’inventaire externe spécifique.
GET https://api.appnexus.com/external-inv-code?code=CODE Afficher un code d’inventaire externe spécifique.
POST https://api.appnexus.com/external-inv-code Ajoutez un nouveau code d’inventaire externe.
PUT https://api.appnexus.com/external-inv-code?id=ID Modifier un code d’inventaire externe.
DELETE https://api.appnexus.com/external-inv-code?id=ID Supprimer un code d’inventaire externe.

Champs JSON

Conseil

Chaque combinaison de publisher_id et code doit être unique.

Champ Type (Longueur) Description
code string (100) Valeur qui sera passée comme ext_inv_code dans la chaîne de requête des appels publicitaires basés sur des étiquettes ou le corps de la demande des appels publicitaires ut/v3 basés sur AST/SDK.

Obligatoire sur : POST
id int ID du code d’inventaire externe.

Valeur par défaut : nombre généré automatiquement
Obligatoire sur : PUT et DELETE
name string (100) Nom du code d’inventaire externe. Ce nom peut être inclus dans les (quatre premiers) rapports d’interface utilisateur/API Network/Publisher Analytics listés ci-dessus.

Obligatoire sur : POST
publisher_id int ID du serveur de publication pour lequel le code d’inventaire externe est utilisé. Si 0la valeur est , le code est utilisé sur plusieurs éditeurs.

Par défaut : 0

Exemples

Ajout d’un code d’inventaire externe pour un éditeur spécifique

$ cat ext_inv_code.json
{
   "external_inv_code": {
      "publisher_id": 103764,
      "code":"55",
      "name":"Code 55"
   }
}
$ curl -b cookies -c cookies -X POST -d @ext_inv_code.json 'https://api.appnexus.com/external-inv-code'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 102,
        "start_element": 0,
        "num_elements": 100,
        "external_inv_code": {
            "member_id": 1066,
            "id": 102,
            "publisher_id": 103764,
            "name": "55",
            "code": "Code 55"
        }
        }
    }
}

Ajout d’un code d’inventaire externe à utiliser sur plusieurs serveurs de publication

$ cat ext_inv_code.json
{
   "external_inv_code": {
      "publisher_id": 0,
      "code":"74",
      "name":"Code 74"
   }
}
$ curl -b cookies -c cookies -X POST -d @ext_inv_code.json 'https://api.appnexus.com/external-inv-code'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 102,
        "start_element": 0,
        "num_elements": 100,
        "external_inv_code": {
            "member_id": 1066,
            "id": 103,
            "publisher_id": 0,
            "name": "74",
            "code": "Code 74"
        }
    }
}

Mise à jour d’un code d’inventaire externe

$ cat ext_inv_code_update
{
   "external_inv_code": {
      "name":"Fresh new name"
   }
}
$ curl -b cookies -c cookies -X PUT -d @ext_inv_code_update.json 'https://api.appnexus.com/external-inv-code?id=102'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "102",
        "start_element": 0,
        "num_elements": 100,
        "external_inv_code": {
            "member_id": 1066,
            "id": 102,
            "publisher_id": 103764,
            "name": "Fresh new name",
            "code": "Code 5"
        }
    }
}

Suppression d’un code d’inventaire externe

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/external-inv-code?id=102'
{
    "response": {
        "status": "OK"
    }
}
  • Last updated on