Banners e Dispaly Ads

Siga o passo-a-passo abaixo para implantar Banners e Display Ads em sites de e-commerce.




1 - Crie os slots de inventário de banners na plataforma Zaply Ads

Acesse a plataforma Zaply Ads e crie os slots dos banners de seu site ou aplicativo.

 https://app.supademo.com/demo/clzu97sag19qx4oytcq0cwudk 


Cada slot criado terá um identificador único (ID) que será utilizado nas requisições a API de Zaply Ads, para solicitar o resultado do leilão de anúncios que definirá qual criativo / anúncio deverá ser postado em seu app ou site.



2 - Faça o upload de sua estrutura de categorias

Em "Configurações - Slots" você poderá fazer o upload de sua estrutura de categorias via arquivo .csv.

Verifique em "Ajuda" os parâmetros deste arquivo.


https://slite.com/api/files/OaN74vHeGrhqBN/2024-05-22_10-11.png?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiWUhyVkE2QXhlTjVPUHgiLCJpYXQiOjE3Mjk1Njc5MzAsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoiY2NkTFp5WkEtc3ROZjYiLCJleHAiOjE3MzIxNTk5MzB9.86TWc2_u78Ta9WNaTG0j8B2N0bVkR1c4bN0Rxf_oUcM


3 - Criar elementos HTML equivalente aos slots a serem ocupados com banners de anúncios

A API de Zaply Ads retornará os criativos a serem postados de acordo com os lances de anunciantes ativos, orçamento, e parametrizações de localização e targeting do anúncio.

É necessário implementar nas páginas onde os banners devem aparecer, os elementos HTML (no caso de aplicações web) que serão populados com os criativos dos banners de anúncio, e criar a aplicação que fará as requisições a API de Zaply Ads do lado do Cliente.



4 - Integre os anúncios nos slots de banners de seu site ou aplicativo

Para integração da camada de anúncios junto aos banners do site ou aplicativo, é necessário uma requisição à API da Zaply Ads.

Tal infra-estrutura combinada ficará da seguinte forma:

This sketch cannot currently be displayed in exports

Abaixo um exemplo.

METHOD: POST
URL: https://staging.zaply.io
PATH: /banner/campaigns/auction
HEADERS: {
  api-key: {API_TOKEN}
}
PAYLOAD: [
  {
    "slotId": "banner-landing-page",
    "mobile": false,
    "quantity": 3
    "categoryId"(Optional): "id da categoria caso seja um banner em página de categorias"
  }
]

O token a ser incluído nos cabeçalhos da requisição serão disponibilizados por Zaply Ads durante seu processo de integração.

Para o caso de banners estáticos (uma imagem fixa) a resposta da API Zaply Ads consistirá no resultado único do leilão de anúncios para aquele slot, constando a url da imagem do criativo, url de redirecionamento e demais parâmetros necessários a postagem e trackeamento do anúncio.

Para o caso de banners em formato carrossel, deve-se informar a quantidade de banners desejados na resposta, assim a resposta da API Zaply Ads consistirá em uma lista de banners constando todos os resultados de leilão de anúncios para aquele slot, constando a url da imagem dos criativos, urls de redirecionamento e demais parâmetros necessários a postagem e trackeamento dos anúncios.

Para páginas de categorias, deve-se informar o id da categoria enviado no  passo 2⁠ , assim apenas banners referente a categoria serão retornados.

{
  "hasAd": BOOLEAN,
  "ads": [
    {
      "campaignId": STRING,
      "partnershipId": INT,
      "redirectUrl": STRING,
      "bannerUrl": STRING,
      "slotId": STRING,
      "categoryId": STRING,
      "cpm": FLOAT
    }
  ]
}


5 - Setar o disparo de Eventos de Acompanhamento de anúncios


Zaply Ads fornece um dashboard com dados de conversão dos anúncios com acesso em tempo real tanto pelo gestor da Propriedade de Anúncio quanto pelos Anunciantes.

Para podermos coletar informações a respeito do desempenho das campanhas de anúncio exibidas, é necessário que alguns eventos sejam disparados em momentos específicos da jornada de compra de um usuário.

Os eventos são:


Ad View

Evento que é disparado sempre que um banner é exibido.
 ⁠⁠Dicionário de dados⁠ 
METHOD: POST
URL: https://staging.zaply.io
PATH: /events-api
PAYLOAD: {
  event: "view",
  campaignId: INTEGER,
  partnershipId: INTEGER,
  device: "desktop" | "mobile",
  cpm: FLOAT,
  zaplyAdsCustomerId: STRING,
  campaignType: "banner"
  slotId: STRING
  categoryId: STRING (OPCIONAL)
}


Ad Click

Evento disparado quando o usuário clica no banner, com os atributos:
 ⁠⁠Dicionário de dados⁠ 
METHOD: POST
URL: https://staging.zaply.io
PATH: /events-api
PAYLOAD: {
  event: "click",
  campaignId: INTEGER,
  partnershipId: INTEGER,
  productId: STRING,
  device: "desktop" | "mobile",
  zaplyAdsCustomerId: STRING,
  campaignType: "banner",
  slotId: STRING,
  categoryId: STRING (OPCIONAL)
}


Product To Cart

Evento disparado quando o usuário adiciona um produto proveninte da página de destino do banner.
 ⁠⁠Dicionário de dados⁠ 
METHOD: POST
URL: https://staging.zaply.io
PATH: /events-api
PAYLOAD: {
  event: 'add_to_cart',
  campaignId: INTEGER,
  partnershipId: INTEGER,
  cartId: STRING,
  device: "desktop" | "mobile",
  zaplyAdsCustomerId: STRING,
  campaignType: "banner",
  slotId: STRING,
  categoryId: STRING (OPCIONAL)
}


6 - Setar o disparo de Evento de Conversão


Uma das funcionalidades de Zaply Ads é o report em tempo real das vendas realizadas a partir dos anúncios.

Para tanto, é necessário implantar um disparo do Evento de Conversão, quando o cliente finaliza o pedido no site.

Utilizar a rota e corpo da mensagem a seguir:
METHOD: POST
URL: https://staging.zaply.io
PATH: /banner/events/cart
PAYLOAD:  {
    cart: {
        id: STRING,
        zaplyAdsCustomerId: STRING,
        orderDate: DATE,
        products: [{
            id: STRING,
            name: STRING,
            unitPrice: FLOAT,
            quantity: INTEGER,
            totalPrice: FLOAT,
            campaign: {
                id: INTEGER,
                partnershipId: INTEGER,
                slotId: STRING,
                campaignType: "banner",
                categoryId: STRING (OPCIONAL)
             }
         }]
    },
    device: "desktop" | "mobile"
 }

O disparo deste evento deve ocorrer somente quando o carrinho possuir pelo menos 1 produto inserido provenientes de anúncios gerados pela Zaply Ads.

Para a correta implementação deste evento, recomendamos que uma flag seja inserida no carrinho quando um produto proveninte de uma página de destino de banner for adicionado.

No momento em que a compra for concluída, verificar se o carrinho possui a flag, e quando positivo enviar a chamada de Evento de Conversão a API de Zaply Ads.

É importante também que tal flag seja removida caso o carrinho não possua nenhum produto com anúncio, garantindo assim o envio de Evento de Conversão somente com os dados necessários ao correto trackeamento da performance dos anúncios.


Dúvidas? Entre com contato com  suporte@zaply.com.br 

 Zaply Ads  é uma plataforma e marcas registrada da Zaply