Este documento proporciona una guía completa sobre cómo generar anuncios de productos en función de criterios de búsqueda específicos. Cada solicitud de API debe incluir detalles sobre el contexto, como:

• Ubicación
• ID del catálogo
• customerId
• sessionId
• Término de búsqueda
• El número máximo de anuncios que se van a mostrar

Requisitos

Debe completar los siguientes pasos antes de empezar a solicitar anuncios de productos para su ubicación en las búsquedas.

Añadir catálogos de productos

Asegúrese de que los productos se hayan añadido a los catálogos y se hayan sincronizado con la plataforma Epsilon Retail Media.

Crear una campaña y configurar los términos de búsqueda

Asegúrese de haber creado una campaña y configurado los términos de búsqueda. Para obtener más información, consulte el Paso 4b: Configure los términos de búsqueda.

Defina los términos de búsqueda que desee segmentar (incluir y excluir) para los anuncios de productos. Puede especificar la coincidencia exacta, la coincidencia de frase y los términos de búsqueda negativos para sus anuncios.

• Coincidencia exacta:
  • Segmenta los términos de búsqueda que coincidan exactamente con sus palabras clave.
  • Ejemplo: Si su palabra clave es "zapatillas azules para correr", su anuncio solo aparecerá para los usuarios que escriban "zapatillas azules para correr" en ese orden exacto y sin más palabras.
• Coincidencia de frase:
  • Segmenta los términos de búsqueda que coincidan exactamente con sus palabras clave.
  • Su anuncio podrá aparecer en las búsquedas que incluyan palabras adicionales antes o después de la frase.
  • Ejemplo: Si su palabra clave es "zapatillas azules para correr", su anuncio solo aparecerá para los usuarios que escriban "zapatillas azules para correr" en ese orden exacto y sin más palabras.
  • Para obtener más información, consulte Términos de búsqueda en las coincidencias de frase.
• Términos de búsqueda negativos:
  • Excluye palabras o frases específicas de su campaña.
  • Evita que sus anuncios aparezcan en búsquedas no relacionadas.
  • Ejemplo: Si añade "usado" como término negativo para el anuncio de un coche nuevo, el anuncio no se mostrará a quienes busquen coches usados.

Obtener las claves de API y la URL base

1. Debe tener una clave de API válida. Para obtener las claves de API, haga lo siguiente:

   1. Inicie sesión en la cuenta de equipo de Epsilon Retail Media.

   2. Navegue hasta la parte superior derecha de la página y haga clic en el menú desplegable.

   3. Seleccione Configuración de integración en el menú desplegable.

      

   4. Haga clic en la pestaña Clave API . Su clave API secreta estará inicialmente oculta. Para verla, haga clic en el botón Mostrar . Una vez sea visible, copie su clave API secreta. Utilice esta clave para realizar llamadas a la API.

2. Debe tener la URL base del punto de conexión de la API. Por ejemplo, https://staging-test.citrusad.com/v1/ads/generate HTTP/1.1. Consulte a su gestor técnico de cuentas para conocer la URL base.

Generar anuncios

Siga los siguientes pasos para generar anuncios de productos.

Solicitud HTTP

Punto de conexión: /v1/ads/generate

Método: POST

Encabezados:

• accept: application/json
• content-type: application/json
• Authorization: Basic <API_KEY>

Solicitar parámetros

El cuerpo de la solicitud debe ser un objeto JSON que contenga los siguientes campos:

Ejemplo de solicitud

Esta solicitud se utiliza para generar hasta 3 anuncios que sean relevantes para el término de búsqueda chocolate. Estos anuncios se mostrarán en los resultados de búsqueda para un cliente (customerId: "wertg5432a") y sesión (sessionId: "ec9-4e07-881d-3e9") específicos. Los anuncios se generarán a partir del catálogo identificado por el catalogId "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", con opciones de filtrado adicionales especificadas (filterMode: "AndOr").

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9",
    "dtmCookieId": "AAAF8xLBTA968AB6TOthAAAAAAE",
    "placement": "search",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "searchTerm": "chocolate",
    "options": {
   						 "filterMode": "AndOr"
 							 },
    "maxNumberOfAds": 3    
}

Ejemplo de respuesta

📘

Al recibir respuestas a anuncios de productos, dicha respuesta suele incluir códigos de producto, como los GTIN de este ejemplo. Los minoristas deben utilizar los códigos de producto proporcionados en las respuestas a los anuncios para buscar los metadatos necesarios para mostrar los productos.

En este ejemplo, "gtin": "024100191345" es el código del producto. Los minoristas usarán este GTIN para identificar y mostrar un producto patrocinado específico.

{
    "ads": [
        {
            "id": "display_QqHaKRrKlFm1Wxr9c_DXJN4HSE3NzMzNjM2",
            "gtin": "7733636",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400902957Z",
            "position": 1
        },
        {
            "id": "display_NzsHqP0_iQedlo9VnrO2vqkwi_k3NzMzNjI4",
            "gtin": "7733628",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400908257Z",
            "position": 2
        },
        {
            "id": "display_xNeShqidaMuEqiJ0zNdt-Gzygjs3NzE0MTA3",
            "gtin": "7714107",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400912929Z",
            "position": 3
        },
        {
            "id": "display_3rGiryPskhQusmsf43nghbQwnqo3NzMzNjU3",
            "gtin": "7733657",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400917769Z",
            "position": 4
        }
    ],
    "banners": [],
    "products": [],
}

Siguientes pasos

• Generar anuncios de productos mediante ubicaciones de categorías
• Optimizar la orientación de anuncios