Proveedores asociados: solicitud de puja
Advertencia
Hemos deshabilitado el protocolo de integración de suministro (ASI) (anteriormente AppNexus Supply Integration) para las integraciones de suministro del lado servidor a partir del 1 de octubre de 2017. Le recomendamos encarecidamente que migre el suministro al protocolo OpenRTB. Todo en esta sección es contenido heredado.
Para enviar una solicitud de puja a Xandr, debe tener POST
un archivo con formato JSON que contenga los detalles de la solicitud de puja al siguiente punto de conexión:
https://ib.adnxs.com/asi?member_id=YOUR_PROD_MEMBER_ID
Para realizar pruebas en nuestro entorno de prueba de cliente, puede ir POST
al punto de conexión:
https://ib.client-testing.adnxs.net/asi?member_id=YOUR_TESTING_MEMBER_ID
Para obtener instrucciones sobre cómo dar formato a la solicitud, consulte los ejemplos de la parte inferior de la página.
Campos JSON
Donde los campos están disponibles para los valores internos y externos (por ejemplo, int_blocked_categories
y ext_blocked_categories
), incluya solo uno de los campos en el archivo con formato JSON. Si se incluyen ambos, se usará el valor interno.
Campo | Tipo | Description |
---|---|---|
an_user_id |
Entero | Identificador de Xandr para el usuario que ve la página. Este campo se incluye si almacena asignaciones de id. de usuario en el sistema. Para obtener más información, consulte Asignación de id. de usuario. Obligatorio: sí, si ext_user_id no está incluido. |
ext_user_id |
string | Identificador de asociado de suministro para el usuario que ve la página. Este campo se incluye si almacena asignaciones de identificadores de usuario con Xandr. Para obtener más información, consulte Asignación de id. de usuario. Obligatorio: sí, si an_user_id no está incluido. |
ext_auction_id |
string | El identificador del asociado de suministro para la subasta. Obligatorio: sí |
width |
Entero | Ancho de la ubicación. Obligatorio: sí |
height |
Entero | Alto de la ubicación. Obligatorio: sí |
ad_format |
enumeración | Formato de la creatividad que se debe devolver. Valores posibles: "iframe", "javascript" o "vast". Nota sobre VAST:No se admite el formato "vasto". Sin embargo, consulte la solicitud de puja VAST en la sección Ejemplos de cómo es probable que se vea una solicitud de puja para una creatividad de vídeo VAST. Obligatorio: sí |
template_id |
Entero | Todavía no se admite. En el caso de las creatividades de vídeo vastas, es posible que desee que Xandr incluya parámetros personalizados en el ad_tag campo de la respuesta de la puja. Para ello, Xandr puede crear una "plantilla de suministro" para usted, a la que se hace referencia aquí al solicitar el vídeo VAST. Para obtener más información, consulte Plantillas de suministro en la documentación de respuesta de la oferta.Obligatorio: no |
ip_address |
string | Dirección IP del usuario que ve la página. Obligatorio: no |
is_secure |
booleano | True o false. El asociado de suministro puede solicitar una versión SSL de la creatividad estableciendo esto en true. |
page_url |
string | Dominio completo de la solicitud de puja (no pase una dirección URL codificada). Obligatorio: no |
position |
enumeración | Posición de la ubicación en la página. Valores posibles: "above" (encima del plegamiento), "below" (debajo del pliegue) o "unknown". Predeterminado: "desconocido" Obligatorio: no |
ext_pub_code |
string | Código de asociado de suministro para el publicador. Obligatorio: no |
ext_placement_code |
string | Código de asociado de suministro para la ubicación. Obligatorio: no |
an_placement_id |
Entero | Identificador de Xandr para la ubicación. Para recuperar identificadores de ubicación, use el servicio de selección de ubicación. Obligatorio: no |
language |
Entero | Identificador X del idioma de la página. Para recuperar identificadores de idioma, use language service. Valor predeterminado: 0 Obligatorio: no |
user_agent |
string | Agente de usuario para la solicitud (es decir, el explorador). Obligatorio: no |
int_blocked_technical_attributes |
matriz de ints | Identificadores Xandr para los atributos técnicos creativos que no se permiten. Para recuperar identificadores de atributos técnicos, use el Servicio de atributos técnicos. Obligatorio: no |
ext_blocked_technical_attributes |
matriz de ints | Identificadores de asociados de suministro para los atributos técnicos creativos que no están permitidos. Obligatorio: no |
int_blocked_categories |
matriz de ints | Identificadores Xandr para las categorías creativas que no están permitidas. Para recuperar identificadores de categoría, use el servicio Category. Obligatorio: no |
ext_blocked_categories |
matriz de ints | Identificadores de asociados de suministro para las categorías creativas que no están permitidas. Obligatorio: no |
int_content_categories |
matriz de ints | Identificadores Xandr para las categorías de contenido aplicadas a la ubicación. Puede usar el servicio categoría de contenido para ver todos los valores posibles. Esto incluye categorías de contenido personalizadas creadas por el asociado de suministro bajo su miembro Xandr. Valor predeterminado: 0 Obligatorio: no |
ext_content_categories |
matriz de ints | Identificadores de asociados de suministro para las categorías de contenido aplicadas a la selección de ubicación. Valor predeterminado: 0 Obligatorio: no |
blocked_urls |
matriz de cadenas | Direcciones URL de página de aterrizaje creativas que no están permitidas. Se pueden bloquear hasta 20 direcciones URL. Consulte Ejemplo de formato a continuación. Obligatorio: no |
blocked_languages |
matriz de ints | Idiomas creativos que no están permitidos. Para recuperar identificadores de idioma, use language service. Obligatorio: no |
int_blocked_brands |
matriz de ints | Los identificadores Xandr para las marcas que no están permitidas. Para recuperar identificadores de marca, use el Servicio de marca. Obligatorio: no |
age |
Entero | La antigüedad del usuario que ve la página. Valor predeterminado: 0 Obligatorio: no |
gender |
enumeración | El sexo del usuario que ve la página. Valores posibles: "male", "female" o "unknown". Predeterminado: "desconocido" Obligatorio: no |
supply_type |
enumeración | Entorno de visualización. Valores posibles: "web", "mobile_app", "mobile_web", "in-stream-video" u "other". Propina: El valor de supply_type invalidará el tipo de suministro establecido en el nivel de sitio .Nota:Aún no se admite el formato "in-stream-video". Predeterminado: "web" Obligatorio: no |
Formato de ejemplo: blocked_urls
{
"blocked_urls": [
"landingpage1.com",
"landingpage2.com"
]
}
Asignación de ubicación
Xandr enviará una oferta solo cuando podamos asignar su solicitud a una ubicación en Xandr. Estamos buscando lo siguiente en la siguiente secuencia:
an_placement_id
ext_placement_code
ext_pub_code
(la etiqueta predeterminada del publicador)- Ubicación predeterminada del miembro (configurada para su cuenta por el Administrador de cuentas técnicas antes de que se asignen incluso las credenciales de inicio de sesión de producción).
Si ninguno de los anteriores está disponible, Xandr no enviará una oferta. Tenga en cuenta que cada ext_placement_code
uno de ellos solo puede asignarse a una ubicación en Xandr y cada ext_pub_code
una puede asignarse a un solo publicador en Xandr.
Ejemplos
Envío de una solicitud de puja mínimamente aceptable
Create un archivo con formato JSON, incluidos solo los campos necesarios. En este ejemplo se usa el
an_user_id
campo , pero podría usarext_user_id
en su lugar.$ cat bid_request | { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "ad_format":"iframe", "width": 300, "height": 250 }
POST
el archivo con formato JSON. Asegúrese de incluir el identificador de miembro en la cadena de consulta.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envío de una solicitud de puja que incluye solo valores Xandr
Create un archivo con formato JSON con los campos de los valores Xandr en lugar de proporcionar valores de asociado, por ejemplo,
an_user_id
en lugar deext_user_id
yint_blocked_technical_attributes
en lugar deext_blocked_technical_attributes
."$ cat bid_request"{ "an_user_id":1089773736613054100, "ext_auction_id":"395dj2j2j2dd", "width":300, "height":250, "ad_format":"iframe", "ip_address":"38.108.249.106", "page_url":"publisher.com", "position":"above", "ext_pub_code":"203pub", "ext_site_code":"145site", "an_placement_id":40, "language":1, "user_agent":"Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "int_blocked_technical_attributes":[ 6, 10, 11 ], "int_blocked_categories":[ 16, 17, 19 ], "int_content_categories":[ 5, 6, 7 ], "blocked_urls":[ "landingpage1.com", "landingpage2.com", "landingpage3.com", "landingpage4.com", "landingpage5.com" ], "blocked_languages":[ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "age":25, "gender":"male", "supply_type":"web" }
POST
el archivo con formato JSON. Asegúrese de incluir el identificador de miembro en la cadena de consulta.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envío de una solicitud de puja que incluye solo valores externos
Create un archivo con formato JSON con los campos para proporcionar valores de asociado en lugar de valores Xandr, por ejemplo,
ext_placement_code
en lugar dean_placement_id
yext_blocked_categories
en lugar deint_blocked_categories
.$ cat bid_request { "ext_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "width": 300, "height": 250, "ad_format": "iframe", "ip_address": "38.108.249.106", "page_url": "publisher.com", "position": "above", "ext_pub_code": "203pub", "ext_site_code": "145site", "ext_placement_code": "40placement", "language": 1, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "ext_blocked_technical_attributes": [ 3, 5, 8 ], "ext_blocked_categories": [ 2, 15, 20 ], "ext_content_categories": [ 2, 9, 13 ], "blocked_urls": [ "landingpage1.com", "landingpage2.com", "landingpage3.com", "landingpage4.com", "landingpage5.com" ], "blocked_languages": [ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "age": 25, "gender": "male", "supply_type": "web" }
POST
el archivo con formato JSON. Asegúrese de incluir el identificador de miembro en la cadena de consulta.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envío de una solicitud de puja que no incluye detalles de bloqueo
Si configura perfiles de anuncio para aplicar las preferencias de los publicadores, no es necesario especificar los detalles de bloqueo en la solicitud de puja.
Create un archivo con formato JSON, excepto los campos para bloquear atributos técnicos, categorías creativas, categorías de contenido, direcciones URL e idiomas.
$ cat bid_request { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "width": 300, "height": 250, "ad_format": "iframe", "ip_address": "38.108.249.106", "page_url": "publisher.com", "position": "above", "ext_pub_code": "203pub", "ext_site_code": "145site", "an_placement_id": "40", "language": 1, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "age": 25, "gender": "male", "supply_type": "web" }
POST
el archivo con formato JSON. Asegúrese de incluir el identificador de miembro en la cadena de consulta.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envío de una solicitud de puja para una creatividad de vídeo VAST (AÚN NO COMPATIBLE)
Al solicitar una creatividad de vídeo VAST:
ad_format
debe establecerse en "vast".width
debe establecerse en 1.height
debe establecerse en 1.- La solicitud debe asignarse a una ubicación en el sistema Xandr que permita la creación del tipo de medio "Vídeo" o cualquier combinación de los subtipos multimedia "VAST de 15 segundos", "VAST de 30 segundos" o "Otros VAST". Si la solicitud se asigna a una ubicación que no es de vídeo, AppNexus responderá con un error (el formato de anuncio de solicitud no coincide con el formato de ubicación). Para obtener más información sobre cómo buscar la ubicación que se va a usar, consulte Asignación de ubicación anterior.
- No pase
int_blocked_technical_attributes
niext_blocked_technical_attributes
defina qué duraciones de vídeo VAST desea. En su lugar, como se mencionó anteriormente, la ubicación de Xandr debe definir la duración de vídeo VAST permitida. - Si ha pedido a Xandr que configure una plantilla de suministro para incluir parámetros personalizados en el campo de la
ad_tag
respuesta de la oferta, establezcatemplate_id
en el identificador de esa plantilla de suministro. Para obtener más información, consulte Plantillas de suministro en la documentación de respuesta de la oferta.
Create un archivo con formato JSON según los requisitos anteriores. En este ejemplo se supone que hay una ubicación específica en el sistema Xandr definida para permitir creatividades de vídeo VAST. El identificador de esta ubicación se pasa en el
an_placement_id
campo .$ cat bid_request { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "ad_format":"vast", "width": 1, "height": 1. "an_placement_id": 204, "tmpl_id": 4, "ip_address": "38.108.249.106", "page_url": "ibdo.com", "position": "unknown", "language": 0, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "age": 25, "gender": "female" }
POST
el archivo con formato JSON. Asegúrese de incluir el identificador de miembro en la cadena de consulta.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'