Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions en/docs/1-summary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 1. Summary

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

This document details the integration with the **Retail Media API**, the central connection point between the VTEX Ads solution and the retailer's (publisher's) platform. The solution was developed under an **API-first** concept, ensuring total flexibility for retailers to integrate and display ads on any digital channel: e-commerce, marketplace, app, or even on physical totems and screens (Digital Signage).

Our architecture is **cookie-less**, meaning we do not rely on third-party cookies. Identification and targeting are based on proprietary identifiers (`user_id`, `session_id`) and first-party data, ensuring a robust solution that complies with new privacy policies and is prepared for the future of digital retail.
Expand Down
7 changes: 7 additions & 0 deletions en/docs/10-attribution-window.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Attribution Window and Conversion Models

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

This document details the rules, models, and timelines that govern the attribution of conversions (sales) and the billing of advertising campaigns on our platform.

## 1. What is the Attribution Window?
Expand Down
7 changes: 7 additions & 0 deletions en/docs/2-glossary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 2. Glossary

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

| Term | Description |
| :--- | :--- |
| **Advertiser** | Companies, sellers, or individuals who promote their products, services, or ideas through campaigns. |
Expand Down
7 changes: 7 additions & 0 deletions en/docs/3-authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 3. Authentication

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

Authentication is required for catalog submission, report consumption, and management. Other calls, such as ad queries and event notifications, are public and do not require authentication.

For protected endpoints, credentials must be sent via HTTP header. Request your credentials from your account manager.
Expand Down
7 changes: 7 additions & 0 deletions en/docs/4-data-security.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 4. Data Security

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

Data security is a fundamental pillar of our platform. From the outset, our architecture was designed to ensure that no sensitive information is collected and that user data remains protected and non-identifiable at all times.

## Non-Identifiable Data
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5-ad-integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 5. Ad Integration

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

This section provides detailed information on how to integrate with the VTEX Ads platform to display ads on your website.

## 5.0 Integration Flow Overview
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.1-api-integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 5.1 API Integration

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

The integration is based on three pillars that ensure the solution's functionality.

### Integration Pillars
Expand Down
8 changes: 8 additions & 0 deletions en/docs/5.2-vtex-integration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# 5.1 VTEX Integration (VTEX IO App)

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

For stores on the VTEX platform, Newtail offers a storefront app (`Newtail Media APP VTEX`) that drastically simplifies implementation. The app includes visual components and all the logic for ad queries and event notifications.

* **Step 1: Catalog Synchronization**
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.3-catalog-synchronization.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.2. Catalog Synchronization

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

The first step is synchronization, which occurs on two fronts:

> **Note for VTEX stores:** For stores on the VTEX platform, catalog synchronization occurs transparently, with no additional integration required for this purpose.
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.4-audience-integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.4. Audience Integration

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

> **Note:** Audience integration is optional, but highly recommended to improve campaign targeting and ad relevance.

Audience integration has a single integration method: **Batch Submission** to the S3 bucket provided by VTEX Ads.
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.5-ad-query.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.5. Ad Query

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

With the catalog synchronized, your platform requests ads to fill the ad spaces (`placements`). The request is a `POST` and the `publisher_id` must be provided in the URL.

* **Endpoint:** `POST https://newtail-media.newtail.com.br/v1/rma/:publisher_id`
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.5.1-placement-naming.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 5.5.1. Placement Naming Recommendations

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

Using clear, consistent placement names is essential to correctly measure the performance of each ad area on your site/app, make reporting easier, and speed up troubleshooting.

Recommended naming pattern:
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.6-events.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.6. Events

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

Event notification is **crucial** for attribution and measurement.

#### Best Practices
Expand Down
7 changes: 7 additions & 0 deletions en/docs/5.7-transparent-integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Transparent Integration

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

> Note: This tool is only able to serve Banner and Video ads.

The goal of transparent integration is to reduce friction as much as possible to start the VTEX Ads integration setup in the simplest way possible.
Expand Down
7 changes: 7 additions & 0 deletions en/docs/6-data-export.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 6. Data Export

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

Data export allows you to receive detailed information about events and aggregated data systematically and periodically. The integration occurs through an S3 connection, and the data is delivered in specific formats for each type of export.

### 6.1. Reports
Expand Down
7 changes: 7 additions & 0 deletions en/docs/7-script-agent.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 7. VTEX Ads - Script Agent

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

## 7.1. Objective

This document details the procedure for installing the **VTEX Ads** tracking script on all pages of a website (except for checkout pages) using Google Tag Manager (GTM). The correct implementation of this script is essential for collecting browsing data that allows for the optimization and targeting of Retail Media campaigns.
Expand Down
7 changes: 7 additions & 0 deletions en/docs/8-credit-transfer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 8. Credit Transfer

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

Credit transfer is the flow that allows the marketplace to transfer advertising credits to its sellers. This documentation details the endpoints that the marketplace must implement and the webhook it must consume to integrate with VTEXAds.

<div align="center">
Expand Down
7 changes: 7 additions & 0 deletions en/docs/9-sso.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 8. SSO (Single Sign-On)

> [!IMPORTANT]
> **This page has moved.**
>
> The VTEX Ads API documentation is now part of the official VTEX Developers Portal: [VTEX Ads API on developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Please update your bookmarks. This page is no longer maintained.

API for unified seller login. When calling this API, Newtail generates a redirect URL that allows the user to access the Newtail platform without needing to log in again.

* **Endpoint:** `POST /sso/marketplace`
Expand Down
7 changes: 7 additions & 0 deletions es/docs/1-resumen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 1. Resumen

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

Esta documentación detalla la integración con la **Retail Media API**, el punto central de conexión entre la solución de VTEX Ads y la plataforma del minorista (publisher). La solución fue desarrollada bajo el concepto **API-first**, garantizando flexibilidad total para que los minoristas integren y exhiban anuncios en cualquier canal digital: e-commerce, marketplace, aplicación o incluso en tótems y pantallas físicas (Digital Signage).

Nuestra arquitectura es **cookie-less**, lo que significa que no dependemos de cookies de terceros. La identificación y segmentación se basan en identificadores propios (`user_id`, `session_id`) y datos primarios (first-party data), garantizando una solución robusta, en conformidad con las nuevas políticas de privacidad y preparada para el futuro del retail digital.
Expand Down
7 changes: 7 additions & 0 deletions es/docs/10-ventana-atribucion.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Ventana de Atribución y Modelos de Conversión

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

Este documento detalla las reglas, modelos y plazos que rigen la atribución de conversiones (ventas) y la facturación de las campañas publicitarias en nuestra plataforma.

## 1. ¿Qué es la Ventana de Atribución?
Expand Down
7 changes: 7 additions & 0 deletions es/docs/2-glosario.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 2. Glosario

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

| Término | Descripción |
| :--- | :--- |
| **Advertiser (Anunciante)** | Empresas, sellers o individuos que promocionan sus productos, servicios o ideas a través de campañas. |
Expand Down
7 changes: 7 additions & 0 deletions es/docs/3-autenticacion.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 3. Autenticación

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

La autenticación es necesaria para el envío de catálogos, el consumo de informes y la gestión. Las demás llamadas, como consulta de anuncios y notificación de eventos, son públicas y no requieren autenticación.

Para los endpoints protegidos, las credenciales deben ser enviadas vía encabezado (header) HTTP. Solicite sus credenciales al gerente de cuenta.
Expand Down
7 changes: 7 additions & 0 deletions es/docs/4-seguridad-de-datos.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 4. Seguridad de Datos

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

La seguridad de los datos es un pilar fundamental de nuestra plataforma. Desde el principio, nuestra arquitectura fue diseñada para garantizar que no se recopile información sensible y que los datos de los usuarios permanezcan siempre protegidos y no identificables.

## Datos No Identificables
Expand Down
7 changes: 7 additions & 0 deletions es/docs/5-integracion-de-anuncios.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 5. Integración de Anuncios

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

Esta sección proporciona información detallada sobre cómo integrarse con la plataforma de VTEX Ads para mostrar anuncios en su sitio web.

## 5.0 Visión General del Flujo de Integración
Expand Down
7 changes: 7 additions & 0 deletions es/docs/5.1-integracion-via-api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 5.1 Integración vía API

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

La integración se fundamenta en tres pilares que garantizan el funcionamiento de la solución.

### Pilares de la Integración
Expand Down
8 changes: 8 additions & 0 deletions es/docs/5.2-integracion-vtex.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# 5.1 Integración con VTEX (VTEX IO App)

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

Para tiendas en la plataforma VTEX, Newtail ofrece una aplicación de storefront (`Newtail Media APP VTEX`) que simplifica drásticamente la implementación. La app ya incluye componentes visuales y toda la lógica para la consulta de anuncios y la notificación de eventos.

* **Paso 1: Sincronización del Catálogo**
Expand Down
7 changes: 7 additions & 0 deletions es/docs/5.3-sincronizacion-de-catalogo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.2. Sincronización de Catálogo

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

El primer paso es la sincronización, que ocurre en dos frentes:

> **Nota para tiendas VTEX:** Para tiendas en la plataforma VTEX, la sincronización del catálogo ocurre de forma transparente, no siendo necesaria ninguna integración adicional para este fin.
Expand Down
7 changes: 7 additions & 0 deletions es/docs/5.4-integracion-de-audiencias.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.4. Integración de Audiencias

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

> **Nota:** La integración de audiencias es opcional, pero muy recomendada para mejorar la segmentación de campañas y la relevancia de los anuncios.

La integración de audiencias tiene una única forma de integración: **Envío por Lotes (Batch)** al bucket S3 proporcionado por VTEX Ads.
Expand Down
7 changes: 7 additions & 0 deletions es/docs/5.5-consulta-de-anuncios.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## 5.5. Consulta de Anuncios

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

Con el catálogo sincronizado, su plataforma solicita anuncios para completar los espacios publicitarios (`placements`). La solicitud es un `POST` y el `publisher_id` debe ser informado en la URL.

* **Endpoint:** `POST https://newtail-media.newtail.com.br/v1/rma/:publisher_id`
Expand Down
7 changes: 7 additions & 0 deletions es/docs/5.5.1-recomendacion-de-nombres-de-placements.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# 5.5.1. Recomendación de Nombres de Placements

> [!IMPORTANT]
> **Esta página se ha movido.**
>
> La documentación de la API de VTEX Ads ahora forma parte del Portal de Desarrolladores oficial de VTEX: [VTEX Ads API en developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api).
>
> Actualiza tus marcadores. Esta página ya no recibe mantenimiento.

Usar nombres claros y consistentes para los placements es esencial para medir correctamente el rendimiento de cada área de anuncios del sitio/app, facilitar informes y acelerar diagnósticos.

Patrón de nomenclatura recomendado:
Expand Down
Loading