Compartir a través de

Servicio de código de inventario externo

  • Artículo

Algunos vendedores usan sus propios códigos para desglosar su inventario de forma más granular que por ubicación del sitio > del publicador>. El servicio de código de inventario externo le permite registrar dichos códigos con Xandr para que pueda pasarlos en llamadas de anuncios y, a continuación, informar sobre ellos.

Aquí se muestra cómo funciona:

  1. Debe realizar una POST llamada a este servicio para registrar un código de inventario externo con Xandr antes de los pasos 2 y 3.
  2. El código se pasa como ext_inv_code en la cadena de consulta de llamadas de anuncios basadas en etiquetas (consulte el ejemplo siguiente) o mediante la definición de un extInvCode valor a través de defineTag API de AST o la API del SDK de Mobile.
  3. A continuación, puede informar sobre el nombre o el identificador de inventario externo (asignados desde el código de inventario externo a través del servicio de API descrito en esta página) en cualquiera de los siguientes informes o fuentes (a los que tiene acceso):

Etiqueta de selección de ubicación de ejemplo con código de inventario externo

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

API de REST

Http (método) Endpoint Description
GET https://api.appnexus.com/external-inv-code Ver todos los códigos de inventario externos.
GET https://api.appnexus.com/external-inv-code?publisher_id=PUBLISHER_ID Ver todos los códigos de inventario externos para un publicador específico.
GET https://api.appnexus.com/external-inv-code?id=ID Ver un código de inventario externo específico.
GET https://api.appnexus.com/external-inv-code?code=CODE Ver un código de inventario externo específico.
POST https://api.appnexus.com/external-inv-code Agregue un nuevo código de inventario externo.
PUT https://api.appnexus.com/external-inv-code?id=ID Modifique un código de inventario externo.
DELETE https://api.appnexus.com/external-inv-code?id=ID Elimine un código de inventario externo.

Campos JSON

Sugerencia

Cada combinación de publisher_id y code debe ser única.

Campo Tipo (longitud) Description
code string (100) Valor que se pasará como ext_inv_code en la cadena de consulta de llamadas de anuncios basadas en etiquetas o el cuerpo de la solicitud de las llamadas de anuncios ut/v3 basadas en AST/SDK.

Obligatorio activado: POST
id Entero Identificador del código de inventario externo.

Valor predeterminado: número generado automáticamente
Obligatorio activado: PUT y DELETE
name string (100) Nombre del código de inventario externo. Este nombre se puede incluir en los (primeros cuatro) informes de api o interfaz de usuario de Network/Publisher Analytics enumerados anteriormente.

Obligatorio activado: POST
publisher_id Entero Identificador del publicador para el que se usa el código de inventario externo. Si 0es , el código se usa en varios publicadores.

Valor predeterminado: 0

Ejemplos

Adición de un código de inventario externo para un publicador específico

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

Adición de un código de inventario externo para su uso en varios publicadores

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

Actualización de un código de inventario externo

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

Eliminación de un código de inventario externo

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