Integração de Anúncios de Banner: 3 etapas

Configurações de Banner: Criar e compartilhar espaços publicitários.
Leilões para Banners: Trabalhar com variáveis de leilão, solicitações e respostas
Renderizar Banners: renderizar e exibir os assets de banner vencedores

Os anúncios de banner podem ser usados como sliders de página inicial, marcas destacadas e carrosséis.

Configurações de Banner

Forneça uma lista de páginas com identificadores únicos para cada espaço de banner.

Landing Pages: Homepage ou Páginas Personalizadas

Crie espaços para páginas iniciais de alto tráfego ou outras páginas de destino. Um espaço inclui:

SlotID: Um identificador único que pode conter caracteres alfanuméricos e os seguintes símbolos: !"#$%&'()*+,-._/:;<>?@[]^{}~=
Name: Um nome descritivo (por exemplo, Homepage Slide 1, Acima dos Produtos em Tendência).
URL or Deeplink: A URL onde o espaço está localizado.
Landing Page name: A página de destino correspondente ao espaço.
Largura e Altura de imagem, se necessitar de tamanhos diferentes em dispositivos diferentes, suportamos mais 1 conjunto de tamanhos de imagem

SlotID	Landing Page Name	URL or Deeplinks	Width	Height	Additional Width (optional)	Additional Height (optional)
top-slot-1	Homepage Christmas	http://example.com/home	100	50	40	40
right-slot-2	Homepage Christmas	http://example.com/home	50	200

Use este arquivo de amostra para carregar configurações de banner em massa.

Categoria e Busca

Permita que os vendedores segmentem categorias e palavras-chave específicas. Defina espaços de banner e compartilhe-os. Exemplo:

SlotID	Width	Height	Alternative Width (optional)	Alternative Height (optional)
category-bottom	100	50	40	40

Solicitações de Leilão para Banners

Armazenar o resolvedBidId.O resolvedbidId simplifica a atribuição de eventos e o registro para você e seus vendedores, similar ao auctionID em listagens patrocinadas. Precisa ser armazenado para que os eventos possam ser reportados posteriormente, seja como um cookie ou variável de sessão para aplicações web, ou armazenado como uma variável interna para aplicações móveis.

Campos de Solicitação

Variable	Type	Definition	Required/optional	Notes
type	string	Tipo de leilão	required	Deve ser definido como “banners”
slots	integer	Número máximo de vencedores do leilão	required	número de vencedores que você gostaria que o leilão retornasse
slotId	string	ID de espaço externo fornecido pelo marketplace.	required	Formato: `^[\w!\"#$%&'()_+,\-._/:;<>?@\[\]^\{\}~=\\]\_$`
categoryId	string	ID de categoria do marketplace para o leilão.	required apenas se forem banners de categoria	Por padrão é leilão de homepage se não for fornecido ID de categoria.
searchQuery	string		required apenas se forem banners de busca *pode passar tanto categoryID quanto searchQuery na mesma chamada	Exemplo “blue running shoes”
device	string	Dispositivo alvo: desktop ou mobile.	optional	Enum: “desktop” ou “mobile.” Por padrão é “desktop.”

Campos de Resposta

Variable	Type	Definition
resultType	string	”banners”
winners.resolvedBidId	string	Um ID da Topsort que será usado quando houver interação com este item (para reportar impressões ou cliques)
winners.type	string	Tipo da oferta vencedora. Enum: “product”, “vendor”, “brand”, “url”.
winners.rank	integer	A classificação do leilão do produto indica sua posição, sendo 1 o vencedor. Na resposta do leilão, o array de vencedores está ordenado, e a classificação corresponde ao índice da entrada.
winners.id	string	O ID único do marketplace para a entidade vencedora.
winners.asset	array
winners.asset.url	string	URL de origem para um asset de banner. O asset é servido pelo CDN da Topsort, contido no array de assets
`winners.asset.content`	object	Metadados opcionais associados ao criativo de banner.
`winners.asset.content.altText`	string	Texto alternativo opcional fornecido pelo anunciante para o criativo de banner.
`winners.asset.content.aiGenerated`	string	Presente como `"true"` quando o anunciante declarou que a imagem foi gerada ou modificada com IA.

Renderizar Banners

Configure as configurações de banner dentro do painel de administração da Topsort. Insira o banner no DOM da sua aplicação web ou adicione um componente ao código da sua aplicação móvel.

Aplicações Web

Para aplicações web, use o elemento picture, que permitirá fornecer múltiplas fontes ao navegador do cliente. Por exemplo, se o asset tiver 2 fontes:

"asset": [
  {
    "url": "https://topsort.cdnprovider.com/lhs-banner-image-for-p_PJbnN-1x.png",
    "mimeType": "image/png",
    "dimensions": {
      "width": 400,
      "height": 100,
    }
  },
  {
    "url": "https://topsort.cdnprovider.com/lhs-banner-image-for-p_PJbnN-2x.png",
    "mimeType": "image/png",
    "dimensions": {
      "width": 800,
      "height": 200,
    }
  }
]

Então você pode gerar o seguinte HTML: Quando asset[].content.altText for retornado, use o valor no atributo HTML alt da imagem para que leitores de tela comuniquem a descrição do anunciante. Trate o alt text como texto não confiável escrito pelo anunciante e atribua ou faça escape com segurança ao renderizar HTML.

<picture>
  <source
    width="400"
    srcset="
      https://topsort.cdnprovider.com/lhs-banner-image-for-p_PJbnN-1x.png 400w,
      https://topsort.cdnprovider.com/lhs-banner-image-for-p_PJbnN-2x.png 800w
    "
  />
  <img
    src="https://topsort.cdnprovider.com/lhs-banner-image-for-p_PJbnN-1x.png"
    alt="A red bottle of soda on a picnic table"
  />
</picture>

Se asset[].content.aiGenerated for "true", o anunciante declarou que a imagem foi gerada ou modificada com IA. Os marketplaces podem usar esses metadados ao implementar os próprios requisitos de declaração de conteúdo de IA. O navegador do cliente então escolherá o tamanho mais adequado dependendo das capacidades do dispositivo do usuário e obterá apenas o tamanho que melhor se ajusta ao dispositivo do usuário.

Native iOS (Swift)

Recomendamos usar AlamofireImage para lidar com opções de download e renderização. Você pode obter o fator de escala do dispositivo do seu cliente chamando e escolhendo o tamanho correto.

[UIScreen mainScreen].scale;

No Android (Java)

Use a biblioteca Glide para renderizar e armazenar em cache imagens. Assim como no iOS, você precisará verificar o fator de escala do dispositivo para determinar qual imagem baixar:

// Get the screen's density scale
final float scale = getResources().getDisplayMetrics().density;

Geral

Exemplos de leilões

Exemplos de webhooks

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

Placement API

API Reference

Banners Patrocinados

Configurações de Banner

Landing Pages: Homepage ou Páginas Personalizadas

Categoria e Busca

Solicitações de Leilão para Banners

Campos de Solicitação

Campos de Resposta

Renderizar Banners

Aplicações Web

Native iOS (Swift)

No Android (Java)

​Configurações de Banner

​Landing Pages: Homepage ou Páginas Personalizadas

​Categoria e Busca

​Solicitações de Leilão para Banners

​Campos de Solicitação

​Campos de Resposta

​Renderizar Banners

​Aplicações Web

​Native iOS (Swift)

​No Android (Java)

Configurações de Banner

Landing Pages: Homepage ou Páginas Personalizadas

Categoria e Busca

Solicitações de Leilão para Banners

Campos de Solicitação

Campos de Resposta

Renderizar Banners

Aplicações Web

Native iOS (Swift)

No Android (Java)