Histórico de Alterações da API

​

23 de outubro de 2026

​

Alterado

• Datas de depreciação: As operações, os parâmetros e os campos depreciados da API pública agora incluem a data em que foram marcados como depreciados. As datas abaixo são o momento em que cada item foi marcado pela primeira vez na especificação OpenAPI pública.
  • POST /public/v1/toptimize/forecasting/campaign — 2026-08-06. Use POST /public/v1/toptimize/forecasting/campaigns/listing.
  • DELETE /public/v1/media-service/slots/{slot_id}/fallback — 2026-09-10. O endpoint sempre retorna 403. Gerencie os fallbacks de banner no dashboard da Topsort.
  • sort_by_date em GET /public/v1/campaign-service/campaigns — 2025-06-19. Use order_by.
  • amountRemaining, amountCarryover e amountUsed em budget — 2025-12-19.
  • bidCount nas respostas de campanhas — 2025-12-19.
  • externalVendorId nas respostas de campanhas — 2022-11-30. Use vendorId.
  • campaignBehaviorData e campaignBehaviorDataByDay nas respostas de campanhas — 2023-08-31.
  • bidsBehaviorData nas respostas de lances — 2023-09-22.
  • parentId nas categorias — 2026-02-09. Use path.
  • ean em produtos e atualizações parciais de produtos — 2026-08-06. Use gtin.

​

16 de outubro de 2026

​

Adicionado

• Exportações assíncronas: Escolha e combine as dimensões e métricas compatíveis, incluindo novas opções indisponíveis nos endpoints de reporting anteriores. Exporte conjuntos de dados maiores como um único arquivo Parquet de até 1 GiB, com janelas de tempo de até 31 dias e dados de até 120 dias atrás. As exportações são executadas em segundo plano: solicite uma exportação, receba um ID e baixe o arquivo quando estiver pronto. Consulte Exportações de dados personalizadas.
  • /public/v1/export-service/exports (POST)
  • /public/v1/export-service/datasets (GET)
  • /public/v1/export-service/exports/{export_id} (GET)

​

9 de outubro de 2026

​

Alterado

• Respostas de orçamento de campanhas: amountRemaining, amountCarryover e amountUsed nos objetos budget das campanhas estão depreciados. Em 19 de outubro de 2026, esses campos serão removidos por completo das respostas. amount e type permanecem inalterados. O mesmo objeto budget é retornado nas campanhas de sponsored brand. Consulte a referência de Get campaigns.

​

Alterado

• Coleções da Assets API: Os cinco endpoints beta de coleções abaixo estão depreciados desde 18 de agosto de 2026. Continuam funcionando como antes até serem removidos em 27 de agosto de 2026; após essa data, as solicitações a esses endpoints falharão. Os endpoints de assets individuais não são afetados. Consulte a referência da Assets API.
  • /public/v1/assets/collection (POST)
  • /public/v1/assets/collections (GET)
  • /public/v1/assets/collection/{collection-id} (GET, PATCH, DELETE)

​

Alterado

• Respostas de campanhas: promotionType está marcado como depreciado desde 21 de novembro de 2024; utilize adFormat nas respostas de campanhas e formatProperties nas respostas de lances em vez disso. Consulte a referência de Get campaigns. A partir de 23 de abril de 2026, promotionType será retornado como null; a remoção de solicitações e respostas está planejada para 30 de abril de 2026 (sujeito a confirmação).

​

Removido

• /public/v1/campaign-service/estimated-clicks foi removido após 1 ano de descontinuação. Não recebeu tráfego por 7 meses.

​

Adicionado

• Endpoint /public/v1/offsite-ads/audiences/user-list para gerenciar públicos de lista de usuários em anúncios fora do site.

​

Alterado

• /v2/auctions: Campo filter adicionado com esquema AttributesFilter para filtragem de atributos de produto (suporta operadores and/or com array de atributos).

​

Alterado

• /v2/auctions: Objeto page adicionado às solicitações de leilão de listagens patrocinadas e banners.
• /v2/auctions/sponsored-brand: Campo opcional page adicionado à solicitação.

​

Adicionado

• Endpoints /public/v1/campaign-service/campaigns/exclusive-banner (POST) e /public/v1/campaign-service/campaigns/exclusive-banner/{campaign-id} (GET, PATCH) para gerenciamento de campanhas de banner exclusivo.
• Endpoints /public/v1/campaign-service/campaigns/exclusive-listing (POST) e /public/v1/campaign-service/campaigns/exclusive-listing/{campaign-id} (GET, PATCH) para gerenciamento de campanhas de listagem exclusiva.
• Endpoint /public/v1/media-service/slots/{slot-id} com métodos DELETE e PATCH para gerenciamento individual de slot.
• Método POST adicionado a /public/v1/offsite-ads/audiences para criar trabalhos de público.

​

Adicionado

• Endpoints /public/v1/campaign-service/json-templates (GET, POST) e /public/v1/campaign-service/json-templates/{json-template-id} (GET, PATCH) para gerenciar modelos JSON de campanha.
• Endpoint /public/v1/media-service/slots (GET, POST) para listar e criar slots de mídia.
• Endpoint /public/v1/media-service/slots/{slot-id}/fallback (DELETE) para configurar comportamento de fallback do slot.
• Endpoint /public/v1/offsite-ads/audiences (GET) para listar públicos em anúncios fora do site.
• Método DELETE adicionado a /public/v1/campaign-service/campaigns/{campaign-id}/bids para excluir todos os lances.

​

Adicionado

• Endpoint /public/v1/toppie/reporting/file-reports/daily-kpis-by-product (GET) para exportar KPIs diários por produto.
• Endpoint /public/v1/campaign-service/campaigns/{campaign-id}/products (GET, PUT) para gerenciar produtos dentro de uma campanha.
• Endpoints públicos de API de anúncios fora do site em /public/v1/offsite-ads

​

Adicionado

• Endpoints /public/v1/toptimize/forecasting/campaign (POST), /public/v1/toptimize/forecasting/inventory (POST) e /public/v1/toptimize/forecasting/marketplace (GET) para previsão de campanha e inventário.

​

Adicionado

• Endpoints beta de Anúncios Fora do Site (/v2/offsite-ads/)
• Endpoint beta /toptimize/v1/predictions para previsões de CTR/CVR.
• Endpoint beta /toptimize/v1/retrieval para recuperação de objetos.
• Endpoint /public/v1/segment-service/segments/{segment-id}/upload (POST) para upload de dados de segmento.
• Endpoints /public/v1/campaign-service/campaigns/{campaign-id}/restrictions (GET, POST) e /public/v1/campaign-service/campaigns/{campaign-id}/restrictions/{restriction-id} (PATCH) para gerenciamento de restrições de campanha.
• Endpoints /public/v1/campaign-service/restriction-types (GET) e /public/v1/campaign-service/restriction-types/{restriction-type-id} (GET) para gerenciar definições de tipos de restrição.
• Endpoint /public/v1/reporting-service/file-reports/scored-attribution (GET) para relatórios de arquivo de atribuição pontuada.
• Endpoint /public/v1/reporting-service/file-reports/interactions (GET) para exportar dados de interação.
• Método DELETE adicionado a /public/v1/toppie/campaigns/{campaign-id} para excluir campanhas.

​

Alterado

• Eventos: Referências ausentes adicionadas para exibir novo objeto pageview.
• /v2/events: Campos opcionais deviceType e channel adicionados para impressões, cliques, compras e pageviews.

​

Adicionado

• Endpoint beta /toptimize/v1/rank para classificar objetos.
• Endpoints /public/v1/segment-service/segments (GET, PUT) e /public/v1/segment-service/segments/{segment-id} (DELETE) para gerenciamento de segmentos.
• Endpoint /public/v1/segment-service/segments/{segment-id}/signed-url (GET) para obter URLs assinadas para uploads de segmento.
• Endpoint /public/v1/toppie/products (GET) para listar produtos de fornecedor no Toppie.
• Endpoint /public/v1/reporting-service/interactions (GET) para consultar dados de interação.
• Endpoint /public/v1/toppie/account/balance (GET) para visualizar saldo da conta.
• Endpoint /public/v1/toppie/account/topups (GET) para visualizar recargas da conta.
• Endpoint /public/v1/billing-service/campaign-billing-contact (GET, PUT).
• Endpoints /public/v1/billing-service/billing-contacts (GET) e /public/v1/billing-service/billing-contacts/{billing-contact-id} (GET, PUT) para gerenciamento de contato de faturamento em nível de marketplace.
• Endpoints /public/v1/billing-service/vendor-billing-contact (PUT) e /public/v1/billing-service/vendors/{external-vendor-id}/vendor-billing-contact/{billing-contact-id} (DELETE) para contatos de faturamento em nível de fornecedor.
• Método PATCH adicionado a /public/v1/toppie/campaigns/{campaign-id} para atualizar campanhas.

​

Alterado

• /v2/auctions/sponsored-brand: Campos opcionais opaqueUserId e vendorId adicionados.
• Eventos: Exemplo de rastreamento de posicionamento adicionado para análise de carrossel.
• /v2/auctions/travel: Estendido para suportar voos além de hotéis.

​

Adicionado

• Endpoints /public/v1/toppie/campaigns (GET, POST) e /public/v1/toppie/campaigns/{campaign-id} (GET) para gerenciamento de campanhas Toppie.
• Endpoint /public/v1/toppie/campaigns/{campaign-id}/bids (GET) para gerenciar lances de campanha.
• Endpoints de relatórios Toppie (/public/v1/toppie/reporting)
• Endpoints /public/v1/billing-service/vendors/{external-vendor-id}/wallets (GET, POST) e /public/v1/billing-service/vendors/{external-vendor-id}/wallets/{wallet-id}/adjust (POST) para gerenciamento de carteira de fornecedor.
• Método PATCH adicionado a /public/v1/catalog-search-service/catalogs/products para atualizar produtos.

​

Alterado

• Eventos: Documentado que atribuição halo requer vendorId.

​

Adicionado

• Endpoint /v2/auctions/travel para leilões de viagens de hotel.
• Endpoint beta /v2/events/beta/link-users para vincular contas de usuário.
• Endpoints /public/v1/reporting-service/marketplace/campaigns-kpis (GET) e /public/v1/reporting-service/marketplace/vendors-kpis (GET) para relatórios de KPI em nível de marketplace.