Requisitos de integración

Descripción general de alto nivel

Como parte de esta integración, tendrá que hacer lo siguiente

  1. Aplicar una solicitud de anuncio adicional para la ubicación por categorías de venta cruzada.
    1. Esto incluye el trabajo de posicionar y mostrar anuncios en su sitio, así como el informe de clics e impresiones
    2. Los pedidos deben proporcionarse a CitrusAd como parte de la integración estándar
  2. Si sincroniza los ID de categoría con CitrusAd, deberá utilizar la API filterMapping para proporcionar valores legibles por humanos para la selección de categorías de la IU
    1. Esto solo se aplica si está integrado con ID de categoría en lugar de nombres. (como cuando solicita anuncios, sus filtros son category:123j-dsef-er en lugar de category:Milk
  3. (Recomendado): sincronice las asignaciones de categorías de venta cruzada para automatizar la aprobación y reducir la carga de gestión de campañas.

Solicitud de anuncios e integración del sitio

Solicitud de anuncio

Como la venta cruzada por categorías requiere una ubicación independiente, deberá integrar una solicitud de anuncio adicional por tipo de anuncio para el que esté integrando la venta cruzada por categorías.

El formato de su solicitud debe coincidir con la solicitud de anuncio de categoría de venta cruzada, como se indica a continuación

Informes de impresiones y clics

Una vez que haya integrado su solicitud de anuncio, también tendrá que asegurarse de informar correctamente de los clics y las impresiones de cada anuncio mostrado. Asegúrese de leer Informes de impresiones y clics.

Información de pedidos

Por lo general, la mayoría de las integraciones informan de toda la información del pedido a CitrusAd según una integración estándar. Debe asegurarse de informar correctamente de todos los pedidos a CitrusAd según los datos del pedido.

Asignaciones de filtros

El endpoint de asignación de filtros se puede utilizar para asignar sus ID de categoría a valores legibles por humanos. Esto es necesario si sincroniza ID de categoría, ya que la IU muestra los valores a sus usuarios.

📘

Si sincroniza categorías legibles por humanos de su catálogo de productos con CitrusAd, este paso no será necesario.

Los usuarios no entenderán qué category:12345-abcde es. La API filterMapping se puede usar para asignar el valor al nombre de categoría relevante en su sitio, como category:Pantry.

No hay ningún método basado en archivos para sincronizar esta información, debe hacerse a través de la API filterMapping.

🚧

A medida que cree categorías adicionales en su sitio, deberá asegurarse de que la API filterMapping se usa para actualizar las categorías.

Asignaciones de venta cruzada por categorías (recomendado)

Al integrar este tipo de ubicación, se recomienda encarecidamente proporcionar una asignación de las categorías que pueden segmentarse entre sí. Esto puede agilizar sus operaciones tras los trabajos de integración iniciales. La experiencia del anunciante está optimizada para permitir solo seleccionar las categorías que ya están permitidas.

Además, también es posible configurar la aprobación automática para campañas de categorías de venta cruzada cuando se proporcionan asignaciones de venta cruzada.

Métodos de integración

  • Puede utilizar la API CrossSellCategory para crear y gestionar asignaciones según sea necesario.
  • Como alternativa, puede proporcionar un archivo TSV a un depósito de GCS alojado por CitrusAd con el formato que se indica a continuación.

Integración de API

Puede consultar toda la información necesaria en la referencia de la API crossSellCategory.

Integración de archivos

Si se integra por archivos, CitrusAd requiere un archivo por catálogo, cuyas categorías pueden segmentarse entre sí.

Cada fila del archivo representa una única asignación de una categoría y la categoría a la que puede segmentarse. Cada asignación es unidireccional (si sincroniza chocolate -> leche, los productos de chocolate pueden aparecer en la categoría de lácteos. Si es necesario que los productos lácteos aparezcan en chocolate, se requiere una fila adicional).

Se necesita una fuente de datos en formato TSV que cumpla con las siguientes especificaciones:

Nombre de la columnaObligatorioTipo de datosDescripciónEjemplo
categoryObligatorioTextoEste es un ID de categoría único que identifica la categoría del producto anunciado.category:cookies
cross_category_idObligatorioTextoEste es un ID de categoría único que identifica una categoría elegible en la que los productos de category_id pueden venderse de forma cruzada.category:milk

A continuación se detallan las especificaciones adicionales de los archivos:

  • Solo son compatibles los archivos TSV
  • El TSV debe estar en LF, no en CRLF
  • El TSV debe estar codificado en UTF-8; cualquier otro código hará que falle el feed
  • Se requiere convención de nomenclatura: ^cross_sell_category.*.tsv$

A modo de ejemplo, el aspecto del snippet será el siguiente:

Categoríacross_category_id
categoría:galletascategoría:Leche
categoría:galletascategoría:Chocolate
categoría:Lechecategoría:galletas

Este snippet anterior permite que la categoría de galletas realice ventas cruzadas en las categorías de leche y chocolate. La categoría leche puede realizar ventas cruzadas en la categoría galletas. La categoría chocolate se puede segmentar, pero no puede segmentarse a ninguna otra categoría.

❗️

Cada fila es una combinación de asignación única

Debe sincronizar filas únicas para cada asignación de categorías de venta cruzada única. Al intentar sincronizar varios cross_category_id en una sola fila, la ingestión de archivos fallará.

Proceso de activación de funciones

Cuando lo tenga todo listo para empezar a sincronizar el feed de términos de búsqueda sugeridos, CitrusAd le configurará un depósito de GCS en el que colocar sus archivos.

Esta capacidad solo es compatible con depósitos GCS. No se admiten depósitos externos como AWS/Azure/otros.

Su gestor técnico de cuentas podrá guiarle a través de la activación de esta función. En caso de que el equipo de operaciones de la plataforma de CitrusAD deba realizar una configuración, tenga en cuenta que hay un plazo adicional para la activación.