> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/es/partner-api-overview/campaign-field-definitions.md).
# Definiciones de campos de campaña
## Campos comunes de la campaña
Esta sección proporciona descripciones breves y ejemplos para ayudarte a entender los campos comunes de la campaña en diferentes tipos, como anuncios de productos, banners y banner X. Cada entrada incluye el propósito del campo y un ejemplo representativo de implementación para tu plataforma.
| Campo | Propósito y ejemplo |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Se recomienda incluir detalles como el producto promocionado, el marco temporal o la estrategia, como 'Cadbury Chocolate June Clearance', para ayudar a identificar la campaña fácilmente. El nombre puede tener hasta 255 caracteres. |
| `namespaceId` | El identificador único de tu espacio de nombres, ubicado en la URL base. Por ejemplo, en exampleretailer.citrusad.com, el namespaceId is exampleretailer.
Asegúrate de que el recurso exista para el ID que proporciones como espacio de nombres.
|
| `approval.state` | El estado de aprobación de la campaña solo puede utilizar valores enum especificados. Los estados admitidos son APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.
Ten en cuenta queAPPROVAL\_STATE\_UNSPECIFIED no se puede utilizar.
|
| `approval.rejectionReason` | El motivo por el cual se ha rechazado una campaña. Este es un campo obligatorio si el status es `APPROVAL_STATE_REJECTED`. |
| `campaignState` | El estado activo de la campaña indica si está activa, en pausa, en borrador o archivada. Por ejemplo, CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.
Ten en cuenta que CAMPAIGN\_STATE\_UNSPECIFIED no se puede utilizar.
|
| `teamId` | El teamId es el identificador único del equipo de la campaña.
Asegúrate de que el recurso exista para el ID de equipo dado y no tenga activada la marca de archivado. Además, el ID de equipo de la plantilla debe coincidir con el ID de equipo de la campaña.
|
| `startTime` | La hora de inicio de la campaña mediante una marca de tiempo precisa ISO-8601. Por ejemplo, 2024-09-01T12:00:00Z.
Omite este valor para las campañas de always on .
|
| `endTime` | La hora de finalización de la campaña utiliza una marca de tiempo precisa ISO-8601 y debe configurarse si startTime está especificado. Por ejemplo, 2024-09-30T23:59:59Z. La hora de finalización debe ser posterior a la hora de inicio.
Omite este valor para las campañas dealways on .
|
| `walletId` | El identificador único del monedero que se cobrará por la campaña, por ejemplo, wallet\_123456789.
- If campaignType no es 'Wildcard', debe existir un objeto para el ID.
– El ID de equipo del monedero debe coincidir con el ID de equipo de la campaña.
– El código de moneda del monedero debe coincidir con el código de moneda del catálogo de la campaña. Si no estás seguro de esto, consulta con tu ingeniero de integración de clientes (CIE).
|
| `placementId` | El identificador único de la ubicación de la campaña. Por ejemplo, placement\_987654321.
Asegúrate de que el recurso exista para el ID de ubicación dado y que corresponda a la campaña correcta.
|
| `catalogIds` | El identificador único del catálogo o catálogos del minorista. Por ejemplo, \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].
Asegúrate de que el recurso exista para el ID de catálogo dado y que corresponda a la campaña correcta.
|
| `advertisedProducts.
productsByKey` | Las combinaciones de códigos de producto e ID de catálogo que se anuncian en la campaña. Si una campaña aparece en dos catálogos, proporciona dos emparejamientos de catálogo-producto.
Por ejemplo, \[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}].
|
| `targeting.searchTerms` | Los términos de búsqueda y sus tipos de coincidencia a los que se dirigirá la campaña. Incluye esta información solo para ubicaciones de búsqueda. Por ejemplo, `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. |
| `targeting.excludeFilters` | Filtros para excluir durante la etapa de segmentación, que solo deben ser filtros de ubicación o categoría alineados con tu filterClassId. La mayoría de las integraciones pueden omitir estos valores. Si usas dos clases de filtro, especifica un objeto por clase de filtro:
{"excludeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:chocolate" \
}, \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "location:florida" \
} \
] \
}
|
| `targeting.includeFilters` | Filtros explícitos a los que se dirigirá la campaña. Omite esto para integraciones estándar. Solo completa este campo si se indica o al crear campañas de Ubicación fija.
{"includeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:flavoured-milk" \
} \
] \
}
|
| `targeting.negativeSearchTerms` | Los términos de búsqueda negativos excluyen palabras o frases específicas de tu campaña, evitando que tus anuncios aparezcan en búsquedas no relacionadas. Esta estrategia precisa tu audiencia, reduce los costos e impulsa la eficiencia de la campaña. Por ejemplo, añadir `used` como un término negativo para un anuncio de automóvil nuevo evita mostrarlo a quienes buscan automóviles usados. |
| `targeting.crossSell` | Especifica la segmentación en ubicaciones de venta cruzada. |
| `targeting.crossSell.
targetProductsByKey` | Especifica emparejamientos explícitos de productos de catálogo a los que dirigir la campaña.
\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]
– Los catálogos de productos de destino deben coincidir con los catálogos de la campaña.
– Debe existir un producto para cada par de catálogo-producto.
– Los productos de destino no pueden estar entre los productos anunciados.
– Los productos de destino y los productos anunciados deben compartir categorías coincidentes.
|
| `targeting.upSell.
targetProductsByKey` | Especifica emparejamientos explícitos de productos de catálogo a los que dirigir la campaña.
\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]
|
| `strategy.auction.maxBid` | La puja de coste por clic máximo (CPC) de tu campaña. Por ejemplo, 2.99.
– Debe ser un BigDecimal válido.
– Debe ser superior a la puja mínima.
},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},
|
| `strategy.auction.spendLimit` | Especifica el gasto máximo diario o total para una campaña.
Omite esto para una campaña always on la cual continuará gastando mientras haya fondos en el monedero de la campaña. Por ejemplo: "daily": "1000". Asegúrate de que el límite de gasto sea un valor BigDecimal mayor que 0.
},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},
|
| `strategy.fixedTenancy.cost` | Representa el costo total de la campaña, utilizado únicamente con fines de generación de informes y no deducido del monedero. Este valor se puede actualizar si el minorista optimiza en todo un paquete u orden de inserción (IO). Por ejemplo: 1000.99.
"fixedTenancy": {
"cost": "1000.99",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0
}
]
}
|
| `strategy.fixedTenancy.
catalogCostPercentage` | Un valor entre 0 y 1 que indica la porción del costo asignada a cada catálogo. Si se usan varios catálogos, asigna una porción (por ejemplo, 0.5). Para un solo catálogo, usa el valor 1.
"fixedTenancy": {
"cost": "string",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0.5
}
]
}
|
| `strategy.fixedTenancy.
fixedCosts` | Especifica costos adicionales para datos externos, trabajo de Creatividad u otros servicios relacionados con la campaña. Estos cargos se aplican cuando la campaña es aprobada y no se pueden modificar. Omite esto a menos que apliquen costos adicionales a tu anunciante.
{
"dataCost": "150",
"creativeCost": "200",
"otherCost": "400"
}
|
| `fixedCosts.dataCost` | El costo asociado con los datos para la campaña. Por ejemplo, $100.00. |
| `fixedCosts.creativeCost` | El costo asociado con la producción de la Creatividad para la campaña. Por ejemplo, $200.00. |
| `fixedCosts.otherCost` | El costo asociado con otros gastos para la campaña. Por ejemplo, $50.00. |
| `customFields.customFieldId` | Especifica el customFieldId único que se está configurando. Los campos personalizados no son requeridos en una integración estándar y es probable que no se use este campo a menos que lo aconseje tu Ingeniero de Integración de Clientes (CIE).
{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}
|
| `customFields.content` | El contenido para el campo personalizado en la campaña.
{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}
|
| `customQuestions.customQuestionId` | Especifica la pregunta de segmentación personalizada única que se está configurando. Las preguntas personalizadas no son requeridas en una integración estándar y es probable que no se use este campo a menos que lo aconseje tu Ingeniero de Integración de Clientes (CIE).
{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}
|
| `customQuestions.answers` | Especifica las respuestas seleccionadas por los anunciantes para la segmentación de clientes. Debe alinearse con el cliente targetingData valores.
{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}
|
## Banner X campos de la campaña
| Campo | Propósito y ejemplo |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentStandardId` | Un identificador único para el estándar de contenido. Los estándares de contenido son directrices y parámetros técnicos que dictan cómo debe mostrarse un anuncio de banner dentro de un espacio designado en un sitio web o plataforma digital.
Este identificador es necesario para verificar que el recurso banner X creado cumpla con los estándares de contenido del minorista.
|
| `slotId` | Un identificador único para el espacio en la configuración, como 'homepage\_banner\_slot\_1'. Este identificador garantiza que el banner use el espacio correcto según lo definido por el minorista, como mosaico único, mosaico doble o banner. |
| `slotType` | El espacio único dentro del estándar de contenido donde se colocará la imagen. Garantiza que la imagen cumpla con las validaciones y requisitos del espacio predefinidos. Los ejemplos incluyen left\_ribbon, top\_banner o side\_panel. |
| `headingText` | El texto del encabezado para el banner. |
| `bannerText` | El texto del banner es el texto que se muestra en tu anuncio de banner. |
| `bannerTextColourHex` | El color del texto del banner en formato hexadecimal. |
| `ctaFlag` | Una marca que indica si el banner tiene una llamada a la acción habilitada. |
| `ctaText` | El texto de la llamada a la acción en el banner. Una llamada a la acción (CTA) es un texto o botón en el que se puede hacer clic que le pide a los usuarios que actúen, como realizar una compra o visitar otra página. Por ejemplo, "Shop Now". |
| `ctaTextAccessibility` | El texto de la llamada a la acción para fines de accesibilidad. |
| `ctaLink` | La URL para el enlace de la llamada a la acción. |
| `backgroundColourHex` | El color de la imagen de fondo principal del banner X en formato hexadecimal. |
| `backgroundImageId` | Este es el identificador único de la imagen de fondo principal. |
| `backgroundImagePosition` | La alineación o posición de la imagen de fondo principal dentro de su contenedor. |
| `secondaryBackgroundImageId` | El identificador único para la imagen de fondo secundaria. |
| `secondaryBackgroundImagePosition` | La alineación o posición de la imagen de fondo secundaria dentro de su contenedor. |
| `heroImageId` | El identificador único para la imagen principal hero. La imagen principal hero es la imagen promocional principal, utilizada típicamente para mostrar tu producto o logotipo. |
| `heroImageAltText` | El texto alternativo para la imagen principal hero, que ayuda con la accesibilidad. |
| `heroMode` | El modo o estilo de visualización de la sección principal hero. |
| `secondaryHeroImageId` | El identificador único para la imagen secundaria hero. |
| `secondaryHeroImageAltText` | El texto alternativo para la imagen secundaria hero, que ayuda con la accesibilidad. |
| `secondaryHeroMode` | El modo o estilo de visualización de la sección secundaria hero. |
| `trackingTags` | Una matriz requerida de objetos utilizada para especificar los proveedores de seguimiento y sus etiquetas asociadas para monitorear y analizar el rendimiento de una campaña de banner X. |
| `additionalFields` | Una matriz requerida de objetos que proporciona opciones de configuración adicionales para banner X. |
## Campos de campaña de banner
| Campo | Propósito y ejemplo |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentStandardId` | Un identificador único para el estándar de contenido. Los estándares de contenido son directrices y parámetros técnicos que dictan cómo debe mostrarse un anuncio de banner dentro de un espacio designado en un sitio web o plataforma digital.
Este identificador es necesario para verificar que el recurso de banner creado cumpla con los estándares de contenido del minorista.
|
| `slotId` | Un identificador único para el espacio en la configuración, como 'homepage\_banner\_slot\_1'. Este identificador garantiza que el banner use el espacio correcto según lo definido por el minorista, como mosaico único, mosaico doble o banner. |
| `artworkImageId` | Un identificador único para la imagen de la obra de arte cargada para el banner. Este ID (fileId) lo devuelve la API Cargar las Creatividades. |
| `link` | Esta es la URL vinculada al Espacio de banner, que dirige a los usuarios a una página de destino cuando hacen clic en el anuncio. Ejemplo: |
| `altText` | Texto alternativo que describe la imagen de la obra de arte para fines de accesibilidad. Ejemplo: 'Promotional banner for summer sale'. |
| `text` | Texto de visualización en el banner. El texto de visualización para el espacio, que proporciona información o un mensaje adicional. Ejemplo: 'Get 20% off your first purchase!' |
| `trackingTags` | Una lista de etiquetas de seguimiento del proveedor, utilizadas para monitorear interacciones con el espacio. Ejemplo: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Estas etiquetas se incluyen con su anuncio para verificación de terceros. |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://help.citrusad.com/retail-media-interface/partner/es/partner-api-overview/campaign-field-definitions.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.