Solicitar
La API de inserción de anuncios puede invocarse tanto desde el lado del cliente como desde el lado del servidor.
Cuando se utiliza la implementación del lado del cliente, el navegador puede realizar una solicitud pre-flight. Si desea evitar esto, en la cabecera de la petición, utilice Content-Type: text/plain. Esto asegurará que el navegador califique la petición como "simple" y por lo tanto omita la petición pre-flight.
Además, cuando se llama a la API en el lado cliente, en realidad no se requieren IPs ya que puede ser difícil detectar la IP utilizando frontend y Javascript. En su lugar, nuestra API detecta la IP de la conexión cuando se realiza la solicitud.
Cuando se utiliza la implementación del lado del servidor, para garantizar una orientación correcta, la IP correcta del usuario debe pasarse explícitamente. De lo contrario, los anuncios se segmentarán en función de la ubicación del servidor, lo que puede provocar que las impresiones se invaliden posteriormente por una IP incorrecta.
Tanto si se utiliza cliente como servidor, si se pasa una IP, se priorizará sobre la que detectemos.
Para realizar una solicitud a la API de inserción de anuncios, debe pasar dos objetos: usuario y zonas. La solicitud se realiza en JSON mediante HTTP POST.
usuario
| Parámetro | ¿Es necesario? | Descripción |
|---|---|---|
| id | No | ID del usuario |
| ip | Recomendado | La dirección IP del usuario. |
| ua | Sí | El agente de usuario: Una cadena que contiene el navegador/app y dispositivo/OS del usuario. |
| idioma | No | Establece el idioma de la solicitud utilizando el código ISO estándar de dos caracteres más un código de región opcional de dos caracteres. Por ejemplo, en-us para el inglés de Estados Unidos. |
| referente | No | La dirección del sitio donde se mostrará el anuncio. |
| el | No | El correo electrónico del usuario codificado en Base64. |
| resolución_pantalla | No | Resolución de pantalla del dispositivo utilizado por el usuario |
| orientación_ventana | No | Debe ser "vertical" si el sitio tiene un diseño móvil y "horizontal" si es de escritorio. |
| gdpr | No | Extensiones con aviso de privacidad (Objeto). |
usuario.gdpr
| Parámetro | Descripción |
|---|---|
| gdpr | Debe ser 0 si la persona que llama cree que el usuario no está bajo GDPR, y 1 si el usuario está bajo GDPR . |
| consentimiento | Esta es la cadena de consentimiento requerida por las Normas IAB. |
zonas
| Parámetro | ¿Es necesario? | Descripción |
|---|---|---|
| id | Sí | ID de la zona publicitaria |
| sub | No | Subidentificador de la zona publicitaria |
| palabras clave | No | Cualquier palabra clave asociada al tráfico que pueda coincidir con un tipo específico de publicidad. Si no hay palabras clave, se utilizará la URL del sitio para la concordancia |
| targeting_personalizado | No | Valores de zona personalizados (Objeto) |
zones.custom_targeting
| Parámetro | Descripción |
|---|---|
| ex_av | Debe ser 0 si no está definido, 1 si la edad está verificada y 2 si la edad no está verificada |
Ejemplo
Es posible solicitar varias zonas publicitarias en una sola solicitud. Cada zona tendrá un ID diferente, como puede ver en el ejemplo siguiente.
{
"user": {
"id": "abdef8u9",
"ip": "10.42.0.1",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"language": "en-US",
"referer": "https://blabla.com",
"gdpr" : {
"gdpr" : 1,
"consent": "CPAoZRHPArq3hBcADBENBJCgAAAAAAAAAAqIHKQAAOUgAAAA"
}
},
"zones": [
{
"id": 4031007,
"sub": 111,
"keywords": "humour, general"
},
{
"id": 4031015,
"sub": 222
},
{
"id": 4031019,
"sub": 222
}
]
}