diff --git a/en/docs/1-summary.md b/en/docs/1-summary.md index 06833df..5259532 100644 --- a/en/docs/1-summary.md +++ b/en/docs/1-summary.md @@ -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. diff --git a/en/docs/10-attribution-window.md b/en/docs/10-attribution-window.md index 6c32053..7434c05 100644 --- a/en/docs/10-attribution-window.md +++ b/en/docs/10-attribution-window.md @@ -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? diff --git a/en/docs/2-glossary.md b/en/docs/2-glossary.md index 9905fb5..dee42c5 100644 --- a/en/docs/2-glossary.md +++ b/en/docs/2-glossary.md @@ -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. | diff --git a/en/docs/3-authentication.md b/en/docs/3-authentication.md index 2071ce3..e99c4ab 100644 --- a/en/docs/3-authentication.md +++ b/en/docs/3-authentication.md @@ -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. diff --git a/en/docs/4-data-security.md b/en/docs/4-data-security.md index 975cccc..c376f14 100644 --- a/en/docs/4-data-security.md +++ b/en/docs/4-data-security.md @@ -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 diff --git a/en/docs/5-ad-integration.md b/en/docs/5-ad-integration.md index bf94385..3d5c5a7 100644 --- a/en/docs/5-ad-integration.md +++ b/en/docs/5-ad-integration.md @@ -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 diff --git a/en/docs/5.1-api-integration.md b/en/docs/5.1-api-integration.md index fd25a8c..057e3f1 100644 --- a/en/docs/5.1-api-integration.md +++ b/en/docs/5.1-api-integration.md @@ -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 diff --git a/en/docs/5.2-vtex-integration.md b/en/docs/5.2-vtex-integration.md index 5e28dbb..6b9e9be 100644 --- a/en/docs/5.2-vtex-integration.md +++ b/en/docs/5.2-vtex-integration.md @@ -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** diff --git a/en/docs/5.3-catalog-synchronization.md b/en/docs/5.3-catalog-synchronization.md index d5f2ecd..9d7b47b 100644 --- a/en/docs/5.3-catalog-synchronization.md +++ b/en/docs/5.3-catalog-synchronization.md @@ -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. diff --git a/en/docs/5.4-audience-integration.md b/en/docs/5.4-audience-integration.md index b0154ca..6e6a2e9 100644 --- a/en/docs/5.4-audience-integration.md +++ b/en/docs/5.4-audience-integration.md @@ -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. diff --git a/en/docs/5.5-ad-query.md b/en/docs/5.5-ad-query.md index cd0ea1a..881772c 100644 --- a/en/docs/5.5-ad-query.md +++ b/en/docs/5.5-ad-query.md @@ -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` diff --git a/en/docs/5.5.1-placement-naming.md b/en/docs/5.5.1-placement-naming.md index c7b85e4..6df5d5e 100644 --- a/en/docs/5.5.1-placement-naming.md +++ b/en/docs/5.5.1-placement-naming.md @@ -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: diff --git a/en/docs/5.6-events.md b/en/docs/5.6-events.md index ca2a864..4efd876 100644 --- a/en/docs/5.6-events.md +++ b/en/docs/5.6-events.md @@ -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 diff --git a/en/docs/5.7-transparent-integration.md b/en/docs/5.7-transparent-integration.md index 25f5ac9..d01901c 100644 --- a/en/docs/5.7-transparent-integration.md +++ b/en/docs/5.7-transparent-integration.md @@ -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. diff --git a/en/docs/6-data-export.md b/en/docs/6-data-export.md index 19fe429..b644881 100644 --- a/en/docs/6-data-export.md +++ b/en/docs/6-data-export.md @@ -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 diff --git a/en/docs/7-script-agent.md b/en/docs/7-script-agent.md index 0f22eab..5e8db9c 100644 --- a/en/docs/7-script-agent.md +++ b/en/docs/7-script-agent.md @@ -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. diff --git a/en/docs/8-credit-transfer.md b/en/docs/8-credit-transfer.md index ca9aa4c..bb21022 100644 --- a/en/docs/8-credit-transfer.md +++ b/en/docs/8-credit-transfer.md @@ -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.
diff --git a/en/docs/9-sso.md b/en/docs/9-sso.md index 4c31f94..789d304 100644 --- a/en/docs/9-sso.md +++ b/en/docs/9-sso.md @@ -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` diff --git a/es/docs/1-resumen.md b/es/docs/1-resumen.md index 5230b2d..922d050 100644 --- a/es/docs/1-resumen.md +++ b/es/docs/1-resumen.md @@ -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. diff --git a/es/docs/10-ventana-atribucion.md b/es/docs/10-ventana-atribucion.md index e5744db..a6dfea2 100644 --- a/es/docs/10-ventana-atribucion.md +++ b/es/docs/10-ventana-atribucion.md @@ -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? diff --git a/es/docs/2-glosario.md b/es/docs/2-glosario.md index 2cd744d..2ed0982 100644 --- a/es/docs/2-glosario.md +++ b/es/docs/2-glosario.md @@ -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. | diff --git a/es/docs/3-autenticacion.md b/es/docs/3-autenticacion.md index 12465c4..b40352f 100644 --- a/es/docs/3-autenticacion.md +++ b/es/docs/3-autenticacion.md @@ -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. diff --git a/es/docs/4-seguridad-de-datos.md b/es/docs/4-seguridad-de-datos.md index 6584eed..abd83ac 100644 --- a/es/docs/4-seguridad-de-datos.md +++ b/es/docs/4-seguridad-de-datos.md @@ -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 diff --git a/es/docs/5-integracion-de-anuncios.md b/es/docs/5-integracion-de-anuncios.md index 509e309..8b18148 100644 --- a/es/docs/5-integracion-de-anuncios.md +++ b/es/docs/5-integracion-de-anuncios.md @@ -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 diff --git a/es/docs/5.1-integracion-via-api.md b/es/docs/5.1-integracion-via-api.md index f10e2df..ecbd126 100644 --- a/es/docs/5.1-integracion-via-api.md +++ b/es/docs/5.1-integracion-via-api.md @@ -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 diff --git a/es/docs/5.2-integracion-vtex.md b/es/docs/5.2-integracion-vtex.md index 55e04fe..4183da3 100644 --- a/es/docs/5.2-integracion-vtex.md +++ b/es/docs/5.2-integracion-vtex.md @@ -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** diff --git a/es/docs/5.3-sincronizacion-de-catalogo.md b/es/docs/5.3-sincronizacion-de-catalogo.md index 761d4a3..5f1c5b2 100644 --- a/es/docs/5.3-sincronizacion-de-catalogo.md +++ b/es/docs/5.3-sincronizacion-de-catalogo.md @@ -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. diff --git a/es/docs/5.4-integracion-de-audiencias.md b/es/docs/5.4-integracion-de-audiencias.md index 4fe23f6..1ea4229 100644 --- a/es/docs/5.4-integracion-de-audiencias.md +++ b/es/docs/5.4-integracion-de-audiencias.md @@ -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. diff --git a/es/docs/5.5-consulta-de-anuncios.md b/es/docs/5.5-consulta-de-anuncios.md index 6b1240c..85d99f0 100644 --- a/es/docs/5.5-consulta-de-anuncios.md +++ b/es/docs/5.5-consulta-de-anuncios.md @@ -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` diff --git a/es/docs/5.5.1-recomendacion-de-nombres-de-placements.md b/es/docs/5.5.1-recomendacion-de-nombres-de-placements.md index c9e18d7..342de11 100644 --- a/es/docs/5.5.1-recomendacion-de-nombres-de-placements.md +++ b/es/docs/5.5.1-recomendacion-de-nombres-de-placements.md @@ -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: diff --git a/es/docs/5.6-eventos.md b/es/docs/5.6-eventos.md index 3a1e750..7660ed0 100644 --- a/es/docs/5.6-eventos.md +++ b/es/docs/5.6-eventos.md @@ -1,5 +1,12 @@ ## 5.6. Eventos +> [!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 notificación de eventos es **crucial** para la atribución y la medición. #### Buenas Prácticas diff --git a/es/docs/5.7-integracion-transparente.md b/es/docs/5.7-integracion-transparente.md index 566ff12..2104dfe 100644 --- a/es/docs/5.7-integracion-transparente.md +++ b/es/docs/5.7-integracion-transparente.md @@ -1,5 +1,12 @@ # Integración Transparente +> [!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: Esta herramienta solo está apta para servir anuncios de tipo Banner y Video. La integración transparente tiene como objetivo reducir la fricción al máximo para iniciar la configuración de la integración de VTEX Ads de la forma más sencilla posible. diff --git a/es/docs/6-exportacion-de-datos.md b/es/docs/6-exportacion-de-datos.md index 1d3b019..be0d7eb 100644 --- a/es/docs/6-exportacion-de-datos.md +++ b/es/docs/6-exportacion-de-datos.md @@ -1,5 +1,12 @@ ## 6. Exportación 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 exportación de datos le permite recibir información detallada sobre eventos y datos agregados de forma sistemática y periódica. La integración se realiza a través de una conexión S3, y los datos se entregan en formatos específicos para cada tipo de exportación. ### 6.1. Reportes diff --git a/es/docs/7-script-agent.md b/es/docs/7-script-agent.md index 4816aba..380c524 100644 --- a/es/docs/7-script-agent.md +++ b/es/docs/7-script-agent.md @@ -1,5 +1,12 @@ # 7. VTEX Ads - Script Agent +> [!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. + ## 7.1. Objetivo Este documento detalla el procedimiento para la instalación del script de seguimiento de **VTEX Ads** en todas las páginas de un sitio web (excepto las páginas de checkout) a través de Google Tag Manager (GTM). La correcta implementación de este script es fundamental para la recopilación de datos de navegación que permiten la optimización y el direccionamiento de campañas de Retail Media. diff --git a/es/docs/8-repasse.md b/es/docs/8-repasse.md index f49da5b..36b8068 100644 --- a/es/docs/8-repasse.md +++ b/es/docs/8-repasse.md @@ -1,5 +1,12 @@ ## 7. Transferencia de Créditos +> [!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 transferencia de créditos es el flujo que permite al marketplace transferir créditos de publicidad a sus sellers. Esta documentación detalla los endpoints que el marketplace debe implementar y el webhook que debe consumir para realizar la integración con VTEXAds.
diff --git a/es/docs/9-sso.md b/es/docs/9-sso.md index 2975277..f8f499a 100644 --- a/es/docs/9-sso.md +++ b/es/docs/9-sso.md @@ -1,5 +1,12 @@ ## 8. SSO (Single Sign-On) +> [!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. + API para el inicio de sesión unificado del seller. Al llamar a esta API, Newtail genera una URL de redireccionamiento que permite al usuario acceder a la plataforma de Newtail sin necesidad de un nuevo inicio de sesión. * **Endpoint:** `POST /sso/marketplace` diff --git a/pt/docs/1-resumo.md b/pt/docs/1-resumo.md index dffec7e..ae8526d 100644 --- a/pt/docs/1-resumo.md +++ b/pt/docs/1-resumo.md @@ -5,6 +5,13 @@ title: "1. Resumo" ## 1. Resumo +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + Esta documentação detalha a integração com a **Retail Media API**, o ponto central de conexão entre a solução VTEX Ads e a plataforma do varejista (publisher). A solução foi desenvolvida sob o conceito **API-first**, garantindo total flexibilidade para que os varejistas integrem e exibam anúncios em qualquer canal digital: e-commerce, marketplace, aplicativo ou até mesmo em totens e telas físicas (Digital Signage). Nossa arquitetura é **cookie-less**, o que significa que não dependemos de cookies de terceiros. A identificação e a segmentação são baseadas em identificadores próprios (`user_id`, `session_id`) e dados primários (first-party data), garantindo uma solução robusta, em conformidade com as novas políticas de privacidade e preparada para o futuro do varejo digital. diff --git a/pt/docs/10-janela-atribuicao.md b/pt/docs/10-janela-atribuicao.md index 5acd818..5aa7de9 100644 --- a/pt/docs/10-janela-atribuicao.md +++ b/pt/docs/10-janela-atribuicao.md @@ -1,5 +1,12 @@ # Janela de Atribuição e Modelos de Conversão +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + Este documento detalha as regras, modelos e prazos que regem a atribuição de conversões (vendas) e a cobrança das campanhas de publicidade em nossa plataforma. ## 1. O que é a Janela de Atribuição? diff --git a/pt/docs/2-glossario.md b/pt/docs/2-glossario.md index 5b37b1c..338e116 100644 --- a/pt/docs/2-glossario.md +++ b/pt/docs/2-glossario.md @@ -1,5 +1,12 @@ ## 2. Glossário +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + | Termo | Descrição | | :--- | :--- | | **Advertiser (Anunciante)** | Empresas, sellers ou indivíduos que promovem seus produtos, serviços ou ideias através de campanhas. | diff --git a/pt/docs/3-autenticacao.md b/pt/docs/3-autenticacao.md index 93cf4e8..6cbf808 100644 --- a/pt/docs/3-autenticacao.md +++ b/pt/docs/3-autenticacao.md @@ -1,5 +1,12 @@ ## 3. Autenticação +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + A autenticação é utilizada para envio de catálogo, consumo de relatórios e gerenciamento. As demais chamadas, como consulta de anúncios e notificação de eventos, são públicas e não exigem autenticação. Para os endpoints protegidos, as credenciais devem ser enviadas via header HTTP. Solicite as suas credenciais ao gerente de conta. diff --git a/pt/docs/4-seguranca-de-dados.md b/pt/docs/4-seguranca-de-dados.md index 1dcdfad..712b0f2 100644 --- a/pt/docs/4-seguranca-de-dados.md +++ b/pt/docs/4-seguranca-de-dados.md @@ -1,5 +1,12 @@ # 4. Segurança de Dados +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + A segurança dos dados é um pilar fundamental da nossa plataforma. Desde o início, nossa arquitetura foi projetada para garantir que nenhuma informação sensível seja coletada e que os dados dos usuários permaneçam sempre protegidos e não identificáveis. ## Dados Não Identificáveis diff --git a/pt/docs/5-integracao-de-anuncios.md b/pt/docs/5-integracao-de-anuncios.md index d77636b..c93654a 100644 --- a/pt/docs/5-integracao-de-anuncios.md +++ b/pt/docs/5-integracao-de-anuncios.md @@ -1,5 +1,12 @@ # 5. Integração de Anúncios +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + Esta seção fornece informações detalhadas sobre como se integrar à plataforma VTEX Ads para exibir anúncios em seu site. ## 5.0 Visão Geral do Fluxo de Integração diff --git a/pt/docs/5.1-integracao-via-api.md b/pt/docs/5.1-integracao-via-api.md index e5ce8ae..597f744 100644 --- a/pt/docs/5.1-integracao-via-api.md +++ b/pt/docs/5.1-integracao-via-api.md @@ -1,5 +1,12 @@ # 5.1 Integração via API +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + A integração é fundamentada em três pilares que garantem o funcionamento da solução. ### Pilares da Integração diff --git a/pt/docs/5.2-integracao-vtex.md b/pt/docs/5.2-integracao-vtex.md index ef60b34..cfdeeed 100644 --- a/pt/docs/5.2-integracao-vtex.md +++ b/pt/docs/5.2-integracao-vtex.md @@ -1,4 +1,12 @@ # 5.2 Integração com VTEX (VTEX IO App) + +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + Para lojas na plataforma VTEX, a Newtail oferece um aplicativo de storefront (`Newtail Media APP VTEX`) que simplifica drasticamente a implementação. O app já inclui componentes visuais e toda a lógica para consulta de anúncios e notificação de eventos. * **Passo 1: Sincronização do Catálogo** diff --git a/pt/docs/5.3-sincronizacao-de-catalogo.md b/pt/docs/5.3-sincronizacao-de-catalogo.md index a37925c..cb68d74 100644 --- a/pt/docs/5.3-sincronizacao-de-catalogo.md +++ b/pt/docs/5.3-sincronizacao-de-catalogo.md @@ -1,5 +1,12 @@ ## 5.3. Sincronização de Catálogo +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + O primeiro passo é a sincronização, que ocorre em duas frentes: > **Nota para lojas VTEX:** Para lojas na plataforma VTEX, a sincronização do catálogo ocorre de forma transparente, não sendo necessária nenhuma integração adicional para este fim. diff --git a/pt/docs/5.4-integracao-de-audiencias.md b/pt/docs/5.4-integracao-de-audiencias.md index 8321d86..e098d3a 100644 --- a/pt/docs/5.4-integracao-de-audiencias.md +++ b/pt/docs/5.4-integracao-de-audiencias.md @@ -1,5 +1,12 @@ ## 5.4. Integração de Audiências +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + > **Nota:** A integração de audiências é opcional, mas altamente recomendada para melhorar a segmentação de campanhas e a relevância dos anúncios. A integração de audiências possui uma única forma de integração: **Envio em Lote (Batch)** para o bucket S3 fornecido pela VTEX Ads. diff --git a/pt/docs/5.5-consulta-de-anuncios.md b/pt/docs/5.5-consulta-de-anuncios.md index ca6129a..bd139bf 100644 --- a/pt/docs/5.5-consulta-de-anuncios.md +++ b/pt/docs/5.5-consulta-de-anuncios.md @@ -1,5 +1,12 @@ ## 5.5. Consulta de Anúncios +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + Com o catálogo sincronizado, sua plataforma requisita anúncios para preencher os espaços publicitários (`placements`). A requisição é um `POST` e o `publisher_id` deve ser informado na URL. * **Endpoint:** `POST https://newtail-media.newtail.com.br/v1/rma/:publisher_id` diff --git a/pt/docs/5.5.1-recomendacao-de-nomes-de-placements.md b/pt/docs/5.5.1-recomendacao-de-nomes-de-placements.md index 3b06c7e..db14b18 100644 --- a/pt/docs/5.5.1-recomendacao-de-nomes-de-placements.md +++ b/pt/docs/5.5.1-recomendacao-de-nomes-de-placements.md @@ -1,5 +1,12 @@ # 5.5.1. Recomendação de Nomes de Placements +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + Ter nomes padronizados e claros para os placements é essencial para medir corretamente o desempenho de cada área de anúncios do site/app, facilitar análises e acelerar diagnósticos. Modelo recomendado de nomenclatura: diff --git a/pt/docs/5.6-eventos.md b/pt/docs/5.6-eventos.md index 4331497..8f479fb 100644 --- a/pt/docs/5.6-eventos.md +++ b/pt/docs/5.6-eventos.md @@ -1,5 +1,12 @@ ## 5.6. Eventos +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + A notificação de eventos é **crucial** para a atribuição e mensuração. #### Boas Práticas diff --git a/pt/docs/5.7-integracao-transparente.md b/pt/docs/5.7-integracao-transparente.md index d43f7b3..f1ec8bb 100644 --- a/pt/docs/5.7-integracao-transparente.md +++ b/pt/docs/5.7-integracao-transparente.md @@ -1,5 +1,12 @@ # Integração Transparente +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + > Atenção: Esta ferramenta está apta apenas a servir anúncios do tipo Banner e Vídeo. A integração transparente tem o objetivo de reduzir a fricção ao máximo para iniciar a configuração da integração do VTEX Ads de forma mais simples possível. diff --git a/pt/docs/6-exportacao-de-dados.md b/pt/docs/6-exportacao-de-dados.md index 33c6d50..d83cffb 100644 --- a/pt/docs/6-exportacao-de-dados.md +++ b/pt/docs/6-exportacao-de-dados.md @@ -1,5 +1,12 @@ ## 6. Exportação de Dados +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + A exportação de dados permite que você receba informações detalhadas sobre eventos e dados agregados de forma sistemática e periódica. A integração ocorre através de uma conexão S3, e os dados são entregues em formatos específicos para cada tipo de exportação. ### 6.1. Relatórios diff --git a/pt/docs/7-script-agent.md b/pt/docs/7-script-agent.md index dec5980..fdcec0a 100644 --- a/pt/docs/7-script-agent.md +++ b/pt/docs/7-script-agent.md @@ -1,5 +1,12 @@ # 7. VTEX Ads - Script Agent +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + ## 7.1. Objetivo Este documento detalha o procedimento para a instalação do script de rastreamento da **VTEX Ads** em todas as páginas de um site (exceto as páginas de checkout) através do Google Tag Manager (GTM). A correta implementação deste script é fundamental para a coleta de dados de navegação que permitem a otimização e o direcionamento de campanhas de Retail Media. diff --git a/pt/docs/8-repasse.md b/pt/docs/8-repasse.md index e1ca337..bdaf093 100644 --- a/pt/docs/8-repasse.md +++ b/pt/docs/8-repasse.md @@ -1,5 +1,12 @@ ## 7. Repasse de Créditos +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + O repasse de créditos é o fluxo que permite ao marketplace transferir créditos de anúncio para seus sellers. Esta documentação detalha os endpoints que o marketplace deve implementar e o webhook que deve consumir para realizar a integração com a VTEXAds.
diff --git a/pt/docs/9-sso.md b/pt/docs/9-sso.md index 0457fe4..4bdda9f 100644 --- a/pt/docs/9-sso.md +++ b/pt/docs/9-sso.md @@ -1,5 +1,12 @@ ## 8. SSO (Single Sign-On) +> [!IMPORTANT] +> **Esta página foi movida.** +> +> A documentação da API do VTEX Ads agora faz parte do Portal do Desenvolvedor oficial da VTEX: [VTEX Ads API em developers.vtex.com](https://developers.vtex.com/docs/api-reference/vtex-ads-api). +> +> Atualize seus favoritos. Esta página não é mais mantida. + API para login unificado do seller. Ao chamar esta API, a Newtail gera uma URL de redirecionamento que permite ao usuário acessar a plataforma da Newtail sem a necessidade de um novo login. * **Endpoint:** `POST /sso/marketplace`