Servicio de píxeles de terceros

El servicio de píxeles de terceros le permite cargar y modificar píxeles creativos de terceros y adjuntarlos a anunciantes o creatividades. También puede adjuntar píxeles creativos de terceros al miembro.

API de REST

Método HTTP Endpoint Description
GET https://api.appnexus.com/thirdparty-pixel Ver todos los píxeles de terceros.
GET https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID Ver un píxel específico de terceros.
POST https://api.appnexus.com/thirdparty-pixel Agrega un nuevo píxel de terceros.
PUT https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID Modificar un píxel de terceros existente.
DELETE https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID Eliminar un píxel de terceros existente.

Campos JSON

Campo Tipo Descripción
active booleano Marca que indica si el píxel está activo.

Valor predeterminado: true
adservers matriz de objetos Los adservers a los que llama el píxel. Necesario para los píxeles que sirven en el inventario de Google Ad Manager. Se puede recuperar una lista completa de servidores de anuncios desde el servicio de servidor de anuncios.

Ejemplo:
"adservers":[{"id":11},{"id":12}]
advertisers matriz de objetos Si el píxel tiene un anunciante propietario (es decir, advertiser_id no nulllo es), esta matriz debe contener el identificador (y solo el identificador) del anunciante propietario del píxel. Como resultado, este píxel se representará en todas las creatividades propiedad de ese anunciante. Si el píxel no tiene un anunciante propietario, esta matriz puede contener varios anunciantes a los que se aplicará el píxel.

Ejemplo:
"advertisers":[{"id":3}]

Optional
advertiser_id Entero Identificador del anunciante propietario del píxel de terceros.

Valor predeterminado: null
audit_status string Estado de auditoría del píxel. Los posibles valores son:
- "pending"
- "rejected"
- "approved"
- "exempt"

Nota:
Un píxel sin auditar no impedirá que una creatividad funcione, pero no se publicará junto con la creatividad hasta que haya pasado la auditoría.

Solo lectura
Valor predeterminado: "pending"
content string Si el del píxel format es "raw-js", este es el contenido JavaScript que se publicará con la creatividad. Los content campos y/o secure_content son obligatorios para raw-js los POST píxeles.
También puedes agregar macros a tu píxel. Para obtener una lista de las macros creativas que puede agregar a su píxel, consulte Macros creativas en la documentación de la interfaz de usuario .

Requerido en: POST si el valor del format píxel es "raw-js".
creatives matriz de objetos Las creatividades a las que se aplica un píxel. Los recursos creativos deben pertenecer al miembro o anunciante propietario. Para adjuntar un píxel de terceros a una creatividad, utilice el Servicio de creatividades.

Ejemplo:
"creatives":[{"id":860851}]

Solo lectura
format string El formato del píxel. Posibles valores para los creativos:
- "raw-js"
- "url-html"
- "url-js"
- "url-image"
- "raw-url"

Requerido el: POST y PUT si cambia content, secure_content, url, o campos url_secure .

Valor predeterminado: "raw-js"

Nota:
Para píxeles de visibilidad, solo usa "url-image" o "url-js" formatea.
id Entero El id. del píxel de terceros.

Requerido en: PUT y DELETE.
members matriz de objetos Opcional. Si se especifica, este campo contendrá el ID del miembro propietario del píxel y este píxel se representará en todas las creatividades propiedad de ese miembro.

Ejemplo:
"members":[{"id":1}]
member_id Entero ID del miembro/red propietario de este píxel.

Requerido en: POST
name string El nombre del píxel de terceros.
secure_content string Si el píxel es format"raw-js", el contenido de JavaScript para servir con la creatividad. Los content campos y/o secure_content son obligatorios para raw-js los POST píxeles.

También puedes agregar macros a tu píxel. Para obtener una lista de las macros creativas que puede agregar a su píxel; consulte Macros creativas en la documentación de la interfaz de usuario.

Requerido en: POST si el valor del format píxel es "raw-js".
secure_url string Si el píxel es format"url-html", "url-js", "url-image", o "raw-url", la URL del píxel HTML, JavaScript o Image para servir con la creatividad en una llamada segura (https). Los url campos y/o secure_url son obligatorios para POST estos tipos de píxeles. También puedes agregar macros a tu píxel.

También puedes agregar macros a tu píxel. Para obtener una lista de las macros creativas que puede agregar a su píxel, consulte Macros creativas en la documentación de la interfaz de usuario.

Requerido en: POST si el píxel es format"url-html", "url-js", "url-image", o "raw-url".
supply_exceptions matriz de objetos Los nombres de los miembros en los que debe not servir el píxel. "AdX" es actualmente el único valor aceptable.

Ejemplo:
"supply_exceptions":[{"name":"AdX"}]
url string Si el píxel es format"url-html", "url-js", "url-image", o "raw-url", la URL del píxel HTML, JavaScript o de imagen que se va a publicar con la creatividad. Los url campos y/o secure_url son obligatorios para POST estos tipos de píxeles.

También puedes agregar macros a tu píxel. Para obtener una lista de las macros creativas que puede agregar a su píxel, consulte Macros creativas en la documentación de la interfaz de usuario.

Ejemplos

Ver un píxel específico de un tercero

En este ejemplo, vemos un píxel de terceros con ID 123.

$ curl -b cookies -X GET 'https://api.appnexus.com/thirdparty-pixel?id=123'
 
{
    "thirdparty-pixel":{
        "id":123,
        "active":true,
        "member_id":456,
        "advertiser_id": 789,
        "format":"raw-js",
        "content":"var img = new Image(); img.src="https://url.com/event/js?self=" + data;"
        "url":null,
        "secure_url":null,
        "members":null,
        "advertisers":[{"id":789}], 
        "creatives":null
        "audit_status":"unaudited" // admin only
        "supply_exceptions":[
            {"name":"AdX"},
        ]
        "adservers":[
            {"id":123}
        ]
  }
}

Añadir un nuevo píxel de terceros

En este ejemplo, creamos un nuevo píxel de terceros del lado de la venta con ID 123. Tenga en cuenta que la información del objeto principal se debe "null" a que el archivo JSON que pasamos a la API no especificó un objeto principal para el píxel.

$ cat thirdparty-pixel.json
{
  "thirdparty-pixel":
    {
      "format":"url-html",
      "secure_url":"https://secureurl.com"
    }
}  

$ curl -b cookies -c cookies -X POST -d @thirdparty_pixel 'https://api.appnexus.com/thirdparty-pixel'

{
    "response":{
        "status":"OK",
        "count":1,
        "id":123,
        "start_element":0,
        "num_elements":100,
        "thirdparty-pixel":{
            "id":123,
            "active":true,
            "name":null,
            "member_id":456,
            "advertiser_id":789,
            "publisher_id":null,
            "format":"url-html",
            "audit_status":"pending",
            "created_on":"2014-11-05 19:51:44",
            "last_modified":"2014-11-05 19:51:44",
            "url":null,
            "secure_url":"https://secureurl.com",
            "members":null,
            "advertisers":null,
            "publishers":null,
            "creatives":null,
            "supply_exceptions":null,
            "adservers":null
       
    }
}

Actualizar un píxel de terceros

En este ejemplo, actualizamos un píxel de terceros con el identificador 123, aplicándolo a todos los recursos creativos del anunciante propietario.

$ cat pixelupdate.json

{
  "thirdparty-pixel":
    {
      "advertisers":[{"id":789}]
    }
}  

$ curl -b cookies -c cookies -X PUT -d @pixelupdate 'https://api.appnexus.com/thirdparty-pixel?id=123'

{
   "response":{
      "status":"OK",
      "id":123
   }
}

Eliminar un píxel de terceros

En este ejemplo, eliminamos un píxel de terceros con el ID 123.

$ curl -b cookies -X DELETE 'https://api.appnexus.com/thirdparty-pixel?id=123'

{
   "response":{
      "status":"OK"
   }
}