Produto Patrocinado

Siga o passo-a-passo abaixo para implantar anúncios em Busca Patrocinada Zaply Ads em aplicativos.




1 - Acesso a API do Sistema de Busca da aplicação

Zaply Ads funciona com a maioria dos sistemas de busca de e-commerce, tais como:
  • Links Impulse
  • Vtex Intelligent Search
  • Algolia
  • SmartHint

É requerida a implementação de um acesso a API do Sistema de Busca de sua aplicação, que é utilizada em Zaply Ads como forma de localizar os produtos disponíveis em seu e-commerce para criação das campanhas.


https://slite.com/api/files/qa47gdN3rILcRY/image.png?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiRGhlZ2FqSFBkRFgwUDkiLCJpYXQiOjE3MzMyNDc5MzcsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoiN1lSYlZuV3g4SmRlM0MiLCJleHAiOjE3MzU4Mzk5Mzd9.JAFQeWiHzNKoVX4aIOFYEw4FWc6QM2LD_uhT_-hNnYE

Como critérios mínimos de implementação, é necessário acessar os seguintes parâmetros através da API:

id(STRING): id do produto
name(STRING): nome do produto
imageUrl(STRING): url de imagem do produto

Um exemplo:
[
  {
    id: "12345"
    name: "Acer Aspire TC-885-UA92 Desktop - Windows 10"
    imageUrl: "https://example.com.br/example.png"
  }
]

A autenticação, os métodos e locais/endpoints são determinados pela infra-esturutra do cliente.

O time de desenvolvimento da Zaply está preparado para ajustar-se às especificações solicitadas para acessar os dados supracitados.

Enviar para  integracao@zaply.com.br  :
  • endpoint
  • método de autenticação e eventual chave de API
  • documentação da API, se houver



2 - Integração de anúncios nos resultados da página de busca e categorias

Para integração da camada de anúncios junto aos resultados de busca do site ou aplicativo, é necessário o envio dos resultados originais da busca (gerados pelo seu Sistema de Busca) à API da Zaply Ads.

Tal infra-estrutura combinada ficará da seguinte forma:

This sketch cannot currently be displayed in exports

A fim de receber e tratar os dados vindos da API do Sistema de Busca corretamente, é necessário tratar esta mensagem, adicionando a propriedade "zaplyAdsOptions".

Dentro desta propriedade, os campos id e price são obrigatórios. Solicitamos uma atenção especial ao campo price, para que as políticas de desconto e especificações para produtos vendidos por peso já estejam aplicadas no momento de requisição a API Zaply Ads.


Abaixo um exemplo.

Se a lista de produtos original for:

[
  {
    "id": "123",
    "gtin": "000000001",
    "name": "Acer Aspire TC-885-UA92 Desktop - Windows 10",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
  },
  {
    "id": "1234",
    "gtin": "000000001",
    "name": "Another product",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
  },
  {
    "id": "12345",
    "gtin": "000000001",
    "name": "Another product 2",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers"
  }
]

Ela precisa ser modificada para:
[
  {
    "id": "123",
    "gtin": "000000001",
    "name": "Acer Aspire TC-885-UA92 Desktop - Windows 10",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "id": "123",
      "price": 2241.882
    }
  },
  {
    "id": "1234",
    "gtin": "000000001",
    "name": "Another product",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "id": "123",
      "price": 2241.882
    }
  },
  {
    "id": "12345",
    "gtin": "000000001",
    "name": "Another product 2",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "id": "123",
      "price": 2241.882
    }
  }
]

Além disso temos uma propriedade limit que indica a quantidade máxima de produtos patrocinados que podem ser retornados. Portando esse número deve indicado na requisição de leilão.
E com isso a requisição final para a API Zaply Ads ficaria da seguinte forma:
METHOD: POST
URL: https://api-staging.zaply.io
PATH: /campaigns/auction
HEADERS: {
  api-key: {API_TOKEN}
}
PAYLOAD: 
  limit: 1,
  products: [
  {
    "id": "123",
    "gtin": "000000001",
    "name": "Acer Aspire TC-885-UA92 Desktop - Windows 10",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "id": "123",
      "price": 2241.882
    }
  },
  {
    "id": "1234",
    "gtin": "000000001",
    "name": "Another product",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "id": "123",
      "price": 2241.882
    }
  },
  {
    "id": "12345",
    "gtin": "000000001",
    "name": "Another product 2",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "id": "123",
      "price": 2241.882
    }
  ]
}

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

A resposta da API Zaply Ads consistirá em uma nova lista de produtos concatenada, contendo as posições de anúncio (caso existentes) somados aos resultados originais gerados pelo Sistema de Busca.
hasCampaign: true,
products: [{
  "id": "123",
  "gtin": "000000001",
  "name": "Acer Aspire TC-885-UA92 Desktop - Windows 10",
  "price": 2490.98,
  "discountPercentage": 10,
  "category": "Computers",
  "zaplyAdsOptions": {
      "sponsor": true,
      "index": 0,
      "campaign": {
        "id": 1,
        "partnershipId": 2,
        "costPerClick": 2
      }
    }
  },
  {
    "id": "1234",
    "gtin": "000000001",
    "name": "Another product",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
    "zaplyAdsOptions": {
      "sponsor": true,
      "index": 2,
      "campaign": {
        "id": 1,
        "partnershipId": 2,
        "costPerClick": 2
      }
    }
    },
    {
    "id": "12345",
    "gtin": "000000001",
    "name": "Another product 2",
    "price": 2490.98,
    "discountPercentage": 10,
    "category": "Computers",
  }
]


3 - 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:


Product View

Evento que é disparado sempre que um produto contendo o objeto "zaplyAdsOptions" é exibido na busca/categoria.
 Dicionário de dados⁠ 
METHOD: POST
URL: https://api.zaply.io
PATH: /events-api
PAYLOAD: {
  event: "view",
  campaignId: INTEGER,
  partnershipId: INTEGER,
  device: "desktop" | "mobile",
  zaplyAdsCustomerId: STRING,
  campaignType: "sponsored"
}


Product Click

Evento disparado quando o usuário clica para ver mais informações dos produtos com o objeto "zaplyAdsOptions".
 Dicionário de dados⁠ 
METHOD: POST
URL: https://api-staging.zaply.io
PATH: /events-api
PAYLOAD: {
  event: "click",
  campaignId: INTEGER,
  partnershipId: INTEGER,
  cpc: FLOAT,
  productId: STRING,
  device: "desktop" | "mobile",
  zaplyAdsCustomerId: STRING,
  campaignType: "sponsored"
}


Product To Cart

Evento disparado quando o usuário adiciona um produto com o objeto "zaplyAdsOptions" no carrinho.
 Dicionário de dados⁠ 

METHOD: POST
URL: https://api-staging.zaply.io
PATH: /events-api
PAYLOAD: {
  event: "add_to_cart",
  campaignId: INTEGER,
  partnershipId: INTEGER,
  cartId: STRING,
  device: "desktop" | "mobile",
  zaplyAdsCustomerId: STRING,
  campaignType: "sponsored"
}


4 - 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://api-staging.zaply.io
PATH: /events/cart
PAYLOAD:  {
    cart: {
        id: STRING,
        zaplyAdsCustomerId: STRING,
        orderDate: DATE,
        products: [{
            id: STRING,
            unitPrice: FLOAT,
            name: STRING
            quantity: INTEGER,
            totalPrice: FLOAT,
            campaign: {
                id: INTEGER,
                partnershipId: INTEGER,
                campaignType: "sponsored"
            }
        }]
    },
    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 com anúncio ativo seja adicionado.

Os produtos com anúncio ativo são identificados com o parâmetro abaixo na chamada de retorno da Zaply Ads.
"zaplyAdsOptions": {
"sponsor": true,

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