API para socios

Caché de anuncios

Los anuncios devueltos por los endpoints de generación de anuncios no deben almacenarse en la caché a menos que sea absolutamente necesario, independientemente del tipo de anuncio que sea. Cada vez que se carga una página en el sitio web de un minorista, se debe enviar una nueva solicitud de generación de anuncios a CitrusAd con el contexto correcto para generar un nuevo conjunto de anuncios.

En caso de que el minorista no pueda hacerlo, CitrusAd cuenta con una funcionalidad de almacenamiento en caché en la que el minorista puede mostrar un anuncio a varios clientes en repetidas ocasiones.

🚧

Cualquier impresión y clic que cumpla con los criterios de CitrusAd para clic válido se cobrará en consecuencia. Por este motivo, CitrusAd recomienda encarecidamente reducir al mínimo el tiempo de almacenamiento en caché hasta un límite razonable de minutos para reducir las posibilidades de gasto excesivo.

Requisitos de integración

sessionId ya no es obligatoria en la solicitud de anuncio, ya que el anuncio se puede mostrar en varias sesiones.

Cualquier minorista que desee almacenar anuncios en caché debe:

  • Enviar un nuevo parámetro en la solicitud de anuncio a CitrusAd “cached”: true en la sección de opciones.
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "placement": "search",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "searchTerm": "chocolate",
    "options": {
                         "filterMode": "AndOr",
                         "cached": true
                             },
    "maxNumberOfAds": 3    
}
  • Integrarse con el sessionId método de atribución al informar sobre pedidos.
  • Enviar la sessionId codificada en los informes de impresiones y clics.
  • Enviar una marca de tiempo del evento en los informes de impresiones y clics. Las zonas horarias entre eventos deben ser coherentes, pero la elección de la zona horaria que se emplee corresponde al minorista. Formato ISO-8601.
https://integration.<ENV>.citrusad.com/v1/resource/second-c/<AD_ID>?sessionId=<SESSION_ID>&event_ts=20220127152500

Una vez operativo, se producirá el procesamiento correspondiente por parte de CitrusAd. CitrusAd no requiere ninguna configuración adicional.

Cómo funciona el almacenamiento en caché

Para los anuncios en caché, existe una propiedad configurable llamada "ventana". Esta ventana se aplica a todos los tipos de anuncios. Además, existe la propiedad "vencimiento" que ya se ha transferido en la respuesta de CitrusAd.
Usamos estas propiedades para determinar la forma de tratar las impresiones y los clics. En ciertos casos, CitrusAd crea un nuevo AdId y procesa una impresión / clic en consecuencia.
Así es como CitrusAd garantiza que la atribución sea totalmente funcional en varias sesiones de clientes.

Escenario 1

Cualquier anuncio para la misma sessionId dentro de la "ventana" se tratará como la misma adId.

2640

Escenario 2

Crearemos una nueva adID para cualquier anuncio con diferentes sessionIDs y lo procesaremos como una nueva impresión/clic.

2606

Escenario 3

Cualquier impresión/clic realizado después del vencimiento del anuncio se registrará, pero no se cobrará ni se informará sobre él.

2612

Escenario 4

Cualquier clic que se produzca en una ventana donde no se informa de ninguna impresión será considerado por CitrusAd como un clic, que es el comportamiento actual de todo el sistema.

Esto se puede mitigar aumentando la ventana y reduciendo el minorista su caché.

2650

Cada escenario se producirá de forma independiente en la producción si los anuncios se muestran a varios clientes.

2670

🚧

Riesgo de gasto excesivo

Esta función permite a un minorista mostrar un anuncio a varios clientes y varias veces sin necesidad de solicitar anuncios de CitrusAd.

Esta función no ha aplicado cambios a la forma en que se modifican las campañas/monederos. Cuanto más tiempo se almacene en caché un anuncio, mayor será la probabilidad de mostrar un anuncio para una campaña o monedero que ya no tiene fondos.

CitrusAd seguirá procesando y cobrando por impresión/clic en aquellas campañas/monederos que ya no tengan fondos para un anuncio que se hubiera mostrado cuando el monedero tenía fondos.

Hay tres formas de mitigar el gasto excesivo en estos escenarios.

  • Reducir el almacenamiento en caché al mínimo tiempo posible (preferente)
    Cuanto más tiempo pueda mostrarse un anuncio, mayor será el riesgo de mostrar un anuncio que proceda de una campaña/monedero que se haya agotado.

  • CitrusAd reduce el "vencimiento" de todos los anuncios
    CitrusAd puede reducir el marco temporal en el que los anuncios se consideran "válidos" después de haberse mostrado. Se invalidan las impresiones o los clics posteriores a este vencimiento. Se invalidan las impresiones o los clics posteriores a este vencimiento.

  • CitrusAd expande la "ventana" de todos los anuncios
    Una ventana mayor reducirá el volumen de nuevas impresiones/clics. Sin embargo, esto reduce el número de impresiones/clics de los que se informa