Richiesta

L'API di posizionamento annunci può essere chiamata da entrambi client lato o server lato.

Quando si utilizza client un'implementazione lato, il browser potrebbe eseguire una preflight richiesta. Se si desidera evitarlo, nell'intestazione della richiesta, usare Content-Type: text/plain. Ciò garantirà che il browser consideri la richiesta come "semplice" e quindi salti la richiesta preflight.

Inoltre, quando si chiama l'API sul client lato, gli IP non sono in realtà richiesti poiché può essere difficile rilevare l'IP usando il frontend e JavaScript. Invece, la nostra API rileva l'IP dalla connessione quando viene effettuata la richiesta.

Quando si utilizza server nell'implementazione lato, per garantire un targeting corretto, l'IP corretto dell'utente deve essere passato esplicitamente. Altrimenti, gli annunci saranno indirizzati in base alla posizione del server e ciò potrebbe causare l'invalidazione delle impressioni in seguito a una discrepanza dell'IP.

Sia che si utilizzi il client o il server, se viene passato un IP, avrà priorità su quello che rileviamo.

Per effettuare una richiesta all'API di posizionamento annunci, è necessario passare due oggetti: user e zone. La richiesta viene effettuata in JSON tramite HTTP POST.

user

Parametro	Obbligatorio?	Descrizione
id	No	L'ID dell'utente
ip	Consigliato	L'indirizzo IP dell'utente.
ua	Sì	User Agent: una stringa contenente il browser/app dell'utente e il dispositivo/sistema operativo.
language	No	Imposta la lingua della richiesta utilizzando il codice ISO standard di due caratteri più un codice di regione facoltativo di 2 caratteri. ad es. en-us per l'inglese degli Stati Uniti.
referer	No	L'indirizzo del sito in cui verrà mostrato l'annuncio.
el	No	L'email dell'utente codificata in Base64.
screen_resolution	No	Risoluzione dello schermo del dispositivo utilizzato dall'utente
window_orientation	No	Dovrebbe essere "portrait" se il sito ha un layout mobile e "landscape" se è un layout desktop.
gdpr	No	Estensioni consigliate per la privacy (oggetto).

user.gdpr

Parametro	Descrizione
gdpr	Dovrebbe essere 0 se il chiamante ritiene che l'utente non sia soggetto al GDPR, e 1 se l'utente è soggetto al GDPR.
consent	Questa è la stringa di consenso richiesta dagli standard IAB.

zone

Parametro	Obbligatorio?	Descrizione
id	Sì	L'ID della zona pubblicitaria
sub	No	Il Sub ID della zona pubblicitaria
keywords	No	Qualsiasi keywords associato al traffico che potrebbe corrispondere a uno specifico tipo di pubblicità. Se non ci sono parole chiave, verrà utilizzato l'URL del sito per la corrispondenza
custom_targeting	No	Valori personalizzati della zona (oggetto)

zones.custom_targeting

Parametro	Descrizione
ex_av	Dovrebbe essere 0 se Non definito, 1 se Età verificata e 2 se Età non verificata

Esempio

È possibile richiedere molte zone pubblicitarie in una singola richiesta. Ogni zona avrà un ID diverso, come puoi vedere nell'esempio qui sotto.

{
  "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
    }
  ]
}