Solicitud

La API de ubicación de anuncios puede llamarse desde cualquiera cliente lado o servidor lado.

Cuando se usa cliente una implementación del lado, el navegador puede realizar una preflight solicitud. Si deseas evitar esto, en la cabecera de la solicitud, usa Content-Type: text/plain. Esto garantizará que el navegador califique la solicitud como "simple" y, por lo tanto, omita la solicitud preflight.

Además, al llamar a la API en el cliente lado, las IP no son realmente necesarias ya que puede ser difícil detectar la IP usando el frontend y JavaScript. En su lugar, nuestra API detecta la IP a partir de la conexión cuando se realiza la solicitud.

Cuando se usa servidor implementación del lado, para garantizar una segmentación correcta, la IP correcta del usuario debe pasarse explícitamente. De lo contrario, los anuncios se segmentarán según la ubicación del servidor y esto puede hacer que más adelante las impresiones se invaliden por una discrepancia de IP.

Tanto si se usa cliente como servidor, si se pasa una IP, esta tendrá prioridad sobre la que detectemos.

Para realizar una solicitud a la API de ubicación de anuncios, debes pasar dos objetos: usuario y zonas. La solicitud se realiza en JSON usando HTTP POST.

usuario

Parámetro	¿Requerido?	Descripción
id	No	El ID del usuario
ip	Recomendado	La dirección IP del usuario.
ua	Sí	El User Agent: una cadena que contiene el navegador/aplicación y el dispositivo/sistema operativo del usuario.
idioma	No	Establece el idioma de la solicitud usando el código ISO estándar de dos caracteres más un código de región opcional de 2 caracteres. p. ej. en-us para inglés de Estados Unidos.
referer	No	La dirección del sitio donde se mostrará el anuncio.
el	No	El correo electrónico del usuario codificado en Base64.
screen_resolution	No	Resolución de pantalla del dispositivo usado por el usuario
window_orientation	No	Esto debería ser "portrait" si el sitio tiene un diseño móvil y "landscape" si es de escritorio.
gdpr	No	Extensiones recomendadas para la privacidad (Objeto).

user.gdpr

Parámetro	Descripción
gdpr	Esto debería ser 0 si quien realiza la llamada considera que el usuario no está bajo el RGPD, y 1 si el usuario está bajo el RGPD.
consentimiento	Esta es la cadena de consentimiento requerida por los estándares de IAB.

zonas

Parámetro	¿Requerido?	Descripción
id	Sí	El ID de la zona de anuncios
sub	No	El Sub ID de la zona de anuncios
palabras clave	No	Cualquier palabras clave asociado al tráfico que pueda coincidir con un tipo específico de publicidad. Si no hay palabras clave, se usará la URL del sitio para la coincidencia
custom_targeting	No	Valores personalizados de la zona (Objeto)

zones.custom_targeting

Parámetro	Descripción
ex_av	Esto debería ser 0 si está indefinido, 1 si la edad está verificada y 2 si la edad no está verificada

Ejemplo

Es posible solicitar muchas zonas de anuncios en una sola solicitud. Cada zona tendrá un ID diferente, como puedes 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": "humor, general"
    },
    {
      "id": 4031015,
      "sub": 222
    },
    {
      "id": 4031019,
      "sub": 222
    }
  ]
}