Pedido

A API de colocação de anúncios pode ser chamada do lado do cliente ou do servidor.

Ao utilizar a implementação do lado do cliente, o navegador pode efetuar um pedido pre-flight. Se quiser evitar isso, no cabeçalho do pedido, use Content-Type: text/plain. Isso garantirá que o navegador qualifique a solicitação como "simples" e, portanto, pule a solicitação de pré-lançamento.

Além disso, ao chamar a API do lado do cliente, os IPs não são realmente necessários, uma vez que pode ser difícil detetar o IP utilizando o frontend e o Javascript. Em vez disso, a nossa API detecta o IP da ligação quando o pedido é efectuado.

Ao utilizar a implementação do lado do servidor, a fim de garantir uma segmentação correta, o IP correto do utilizador deve ser passado explicitamente. Caso contrário, os anúncios serão direcionados para a localização do servidor, o que pode fazer com que as impressões sejam invalidadas posteriormente por uma incompatibilidade de IP.

Quer se trate de um cliente ou de um servidor, se for passado um IP, este terá prioridade sobre o que detectamos.

Para efetuar um pedido à API de colocação de anúncios, é necessário passar dois objectos: user e zones. O pedido é efectuado em JSON utilizando HTTP POST.

utilizador

Parâmetro	Necessário?	Descrição
id	Não	O ID do utilizador
ip	Recomendado	O endereço IP do utilizador.
ua	Sim	O agente do utilizador: Uma cadeia de caracteres que contém o browser/aplicação e o dispositivo/OS do utilizador.
língua	Não	Define o idioma do pedido utilizando o código ISO normalizado de dois caracteres mais um código de região opcional de dois caracteres. Por exemplo, en-us para inglês dos Estados Unidos.
referenciador	Não	O endereço do sítio onde o anúncio será apresentado.
el	Não	O e-mail codificado em Base64 do utilizador.
resolução do ecrã	Não	Resolução do ecrã do dispositivo utilizado pelo utilizador
orientação da janela	Não	Deve ser "retrato" se o sítio tiver uma disposição para telemóvel e "paisagem" se for para computador.
gdpr	Não	Extensões aconselhadas pela privacidade (Objeto).

utilizador.gdpr

Parâmetro	Descrição
gdpr	Este valor deve ser 0 se o autor da chamada considerar que o utilizador não está abrangido pelo RGPD e 1 se o utilizador estiver abrangido pelo RGPD.
consentimento	Esta é a cadeia de consentimento exigida pelas normas IAB.

zonas

Parâmetro	Necessário?	Descrição
id	Sim	O ID da zona de publicidade
submarino	Não	O Sub ID da zona de anúncios
palavras-chave	Não	Quaisquer palavras-chave associadas ao tráfego que possam corresponder a um tipo específico de publicidade. Se não existirem palavras-chave, o URL do sítio será utilizado para correspondência
segmentação_personalizada	Não	Valores de zona personalizados (Objeto)

zonas.custom_targeting

Parâmetro	Descrição
ex_av	Este valor deve ser 0 se não for definido, 1 se a idade for verificada e 2 se a idade não for verificada

Exemplo

É possível pedir muitas zonas de anúncios num único pedido. Cada zona terá um ID diferente, como pode ver no exemplo abaixo.

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