Objeto de datos PromotionAdExtension: Administración de campañas

Artículo
12/21/2023

Las extensiones de promoción resaltan las ventas y ofertas especiales en tus anuncios de texto. Al destacar las ofertas, es más probable que los clientes potenciales hagan clic en su anuncio, lo que le ayudará a generar más ventas.

Puedes asociar una extensión de anuncio de promoción a la cuenta o a campañas y grupos de anuncios de la cuenta. Cada entidad (cuenta, campaña o grupo de anuncios) se puede asociar con hasta 20 extensiones de anuncios de promoción.

Nota:

Las extensiones de promoción están disponibles para los clientes en AU, CA, DE, FR, EE. UU. y Reino Unido.

Sintaxis

<xs:complexType name="PromotionAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DiscountModifier" nillable="true" type="tns:PromotionDiscountModifier" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q56="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q56:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q57="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q57:ArrayOfstring" />
        <xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="MoneyAmountOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="OrdersOverAmount" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PercentOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PromotionCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionEndDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="PromotionItem" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionOccasion" nillable="true" type="tns:PromotionOccasion" />
        <xs:element minOccurs="0" name="PromotionStartDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elementos

El objeto PromotionAdExtension tiene los siguientes elementos: CurrencyCode, DiscountModifier, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Language, MoneyAmountOff, OrdersOverAmount, PercentOff, PromotionCode, PromotionEndDate, PromotionItem, PromotionOccasion, PromotionStartDate, TrackingUrlTemplate, UrlCustomParameters.

Elemento	Descripción	Tipo de datos
CurrencyCode	Código de moneda para el precio o descuento de la promoción. Este campo solo es aplicable si establece MoneyAmountOff o OrdersOverAmount. Los códigos de moneda admitidos son ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, DKK, EUR, GBP, HKD, INR, MXN, NZD, PEN, PHP, PLN, SEK, SGD, USD, TWD y VEF. Añadir: Obligatorio si se establecen MoneyAmountOff o OrdersOverAmount . Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece PercentOff o PromotionCode, esta configuración ya no es aplicable y se eliminará.	string
DiscountModifier	Modificador de descuento de promoción. Por ejemplo, supongamos que el modificador de descuento está establecido en UpTo. A continuación, si el descuento de promoción sin modificar sería "$20 de descuento en zapatos", la promoción modificada es "Hasta $20 de descuento en zapatos". Añadir: Opcional. Si no especifica este elemento o lo deja vacío, se establecerá el valor predeterminado de None . Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia.	PromotionDiscountModifier
FinalAppUrls	Reservado para uso futuro.	Matriz AppUrl
FinalMobileUrls	Dirección URL de la página de aterrizaje para dispositivos móviles. Las siguientes reglas de validación se aplican a las direcciones URL finales y las direcciones URL de Final Mobile. - La longitud de la dirección URL está limitada a 2048 caracteres. La cadena de protocolo HTTP o HTTPS cuenta para el límite de 2048 caracteres. - Puede especificar hasta 10 elementos de lista para FinalUrls y FinalMobileUrls; sin embargo, solo se usa el primer elemento de cada lista para la entrega. El servicio permite hasta 10 elementos de lista para una posible compatibilidad con reenvíos. - El uso de '{' y '}' solo puede delinear etiquetas, por ejemplo {lpurl}. - Las direcciones URL finales deben ser una dirección URL bien formada a partir de http:// o https://. - Si especifica FinalMobileUrls, también debe especificar FinalUrls. Añadir: Opcional Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece este elemento en una lista vacía, se eliminará la configuración anterior.	matriz de cadenas
FinalUrls	Dirección URL de la página de aterrizaje. Las siguientes reglas de validación se aplican a las direcciones URL finales y las direcciones URL de Final Mobile. - La longitud de la dirección URL está limitada a 2048 caracteres. La cadena de protocolo HTTP o HTTPS cuenta para el límite de 2048 caracteres. - Puede especificar hasta 10 elementos de lista para FinalUrls y FinalMobileUrls; sin embargo, solo se usa el primer elemento de cada lista para la entrega. El servicio permite hasta 10 elementos de lista para una posible compatibilidad con reenvíos. - El uso de '{' y '}' solo puede delinear etiquetas, por ejemplo {lpurl}. - Las direcciones URL finales deben ser una dirección URL bien formada a partir de http:// o https://. - Si especifica FinalMobileUrls, también debe especificar FinalUrls. Añadir: Obligatorio Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia.	matriz de cadenas
FinalUrlSuffix	El sufijo de dirección URL final puede incluir parámetros de seguimiento que se anexarán al final de la dirección URL de la página de aterrizaje. Se recomienda colocar los parámetros de seguimiento que requiere la página de aterrizaje en un sufijo de dirección URL final para que los clientes siempre se envíen a la página de aterrizaje. Para obtener más detalles y reglas de validación, consulte Sufijo de dirección URL final en las guías técnicas. Esta característica solo está disponible para los clientes de la fase 3 del sufijo final url (GetCustomerPilotFeatures devuelve 636). Si no está en el piloto, esta propiedad se omitirá y no se devolverá ningún error. Añadir: Opcional Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece este elemento en una cadena vacía (""), se eliminará la configuración anterior.	string
Idioma	Idioma en el que se proporcionará la extensión del anuncio. La extensión siempre se servirá en este idioma, independientemente de la configuración de idioma de la campaña o del grupo de anuncios. Las cadenas de idioma admitidas son: danés, holandés, inglés, finés, francés, alemán, italiano, noruego, portugués, español, sueco y tradicional chino. Añadir: Obligatorio Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia.	string
MoneyAmountOff	El dinero de la promoción. Por ejemplo, para promover "$20 off shoes - On orders over $100", establezca PromotionItem en "shoes", establezca CurrencyCode en "USD", establezca MoneyAmountOff en 20 y OrdersOverAmount en 100. Añadir: Obligatorio. Debe establecer MoneyAmountOff o PercentOff, pero no puede establecer ambos. Actualizar: Opcional. Puede establecer MoneyAmountOff o PercentOff, pero no puede establecer ambos.	Doble
OrdersOverAmount	Los pedidos sobre el valor de importe anexados al destino de promoción. Por ejemplo, para promover "$20 off shoes - On orders over $100", establezca PromotionItem en "shoes", establezca CurrencyCode en "USD", establezca MoneyAmountOff en 20 y OrdersOverAmount en 100. Añadir: Opcional. No se pueden establecer OrdersOverAmount y PromotionCode. Actualizar: Opcional. No se pueden establecer OrdersOverAmount y PromotionCode. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece este elemento en '0' (cero), se eliminará la configuración anterior.	Doble
PercentOff	Porcentaje de descuento en el valor de promoción. Por ejemplo, 10,0 representa un descuento del 10 %. Añadir: Obligatorio. Debe establecer MoneyAmountOff o PercentOff, pero no puede establecer ambos. Actualizar: Opcional. Puede establecer MoneyAmountOff o PercentOff, pero no puede establecer ambos. Si establece esta propiedad, el valor de CurrencyCode ya no es aplicable y se eliminará si se estableció anteriormente.	Doble
PromotionCode	Código de promoción anexado al destino de promoción. Por ejemplo, para promover "$20 off shoes - Promocode SAVE20", establezca PromotionItem en "shoes", establezca CurrencyCode en "USD", establezca MoneyAmountOff en 20 y establezca PromotionCode en "SAVE20". La cadena puede contener un máximo de 15 caracteres. Añadir: Opcional. No se pueden establecer OrdersOverAmount y PromotionCode. Actualizar: Opcional. No se pueden establecer OrdersOverAmount y PromotionCode. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece este elemento en una cadena vacía (""), se eliminará la configuración anterior. Si establece esta propiedad, el valor de CurrencyCode ya no es aplicable y se eliminará si se estableció anteriormente.	string
PromotionEndDate	La fecha de finalización ayuda a informar de la fecha de promoción o las fechas que se mostrarán en el anuncio. Por ejemplo, si las fechas PromotionStartDate y PromotionEndDate se establecen en 14 de febrero, el texto "Valid Feb 14" podría incluirse en la promoción mostrada. La fecha PromotionStartDate debe ser anterior o igual a la fecha PromotionEndDate . Esta propiedad no invalida el intervalo de entrega inherente para una promoción. Tanto la promoción PromotionOccasion como Scheduling determinan cuándo se puede mostrar la promoción en los anuncios. Si la fecha de finalización ya ha pasado para el año actual, cada fecha de inicio y finalización debe establecerse para las fechas durante el año siguiente. Añadir: Opcional Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Para eliminar la fecha de finalización actual y no establecer eficazmente ninguna fecha de finalización, establezca day,month y year cada uno en "0" (cero). Cuando recupere la extensión de anuncio de promoción la próxima vez, este elemento no se establecerá.	Date
PromotionItem	Destino o elemento de promoción. Por ejemplo, puede ejecutar una promoción para "zapatos" con un descuento del 20 % o del 20 %. Para ejecutar una promoción para "Hasta 20 USD de zapatos", establezca PromotionItem en "shoes", establezca DiscountModifier en UpTo, establezca CurrencyCode en "USD" y establezca MoneyAmountOff en 20. La cadena puede contener un máximo de 20 caracteres. Añadir: Obligatorio Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia.	string
PromotionOccasion	La ocasión de promoción. Tanto los elementos PromotionOccasion como Scheduling determinan cuándo se puede mostrar la promoción en los anuncios. PromotionOccasion determina el período de tiempo o la estacionalidad, por ejemplo, WomensDay del 15 de febrero al 31 de marzo de cada año. La promoción solo se ejecutará dentro de las fechas correspondientes a la ocasión que establezca. Consulte PromotionOccasion para obtener más información sobre el intervalo de fechas definido para cada ocasión. La programación puede limitar la promoción a un período de tiempo más corto dentro del intervalo de fechas de la ocasión, por ejemplo, limitar la promoción para que se ejecute del 20 de febrero al 8 de marzo. La programación también se puede usar para ejecutar la misma promoción varios años, por ejemplo, ejecutar la promoción WomensDay cada año del 15 de febrero al 31 de marzo. Añadir: Opcional. Si no especifica este elemento o lo deja vacío, se establecerá el valor predeterminado de None . Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece este elemento, PromotionStartDate y PromotionEndDate también deben establecerse para conservar o actualizar la configuración anterior.	PromotionOccasion
PromotionStartDate	La fecha de inicio ayuda a informar de la fecha de promoción o las fechas que se mostrarán en el anuncio. Por ejemplo, si las fechas PromotionStartDate y PromotionEndDate se establecen en 14 de febrero, el texto "Valid Feb 14" podría incluirse en la promoción mostrada. La fecha PromotionStartDate debe ser anterior o igual a la fecha PromotionEndDate . Esta propiedad no invalida el intervalo de entrega inherente para una promoción. Tanto la promoción PromotionOccasion como Scheduling determinan cuándo se puede mostrar la promoción en los anuncios. Si la fecha de finalización ya ha pasado para el año actual, cada fecha de inicio y finalización debe establecerse para las fechas durante el año siguiente. Añadir: Opcional Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Para eliminar la fecha de finalización actual y no establecer eficazmente ninguna fecha de finalización, establezca day,month y year cada uno en "0" (cero). Cuando recupere la extensión de anuncio de promoción la próxima vez, este elemento no se establecerá.	Date
TrackingUrlTemplate	Plantilla de seguimiento que se va a usar como valor predeterminado para todos los FinalUrls y FinalMobileUrls. Las siguientes reglas de validación se aplican a las plantillas de seguimiento. Para obtener más información sobre las plantillas y los parámetros admitidos, consulte el artículo de ayuda de Microsoft Advertising ¿Qué parámetros de seguimiento o dirección URL puedo usar? - Las plantillas de seguimiento definidas para entidades de nivel inferior, por ejemplo, los anuncios, reemplazan a las establecidas para entidades de nivel superior, por ejemplo, campaña. Para obtener más información, vea Límites de entidad. - La longitud de la plantilla de seguimiento está limitada a 2048 caracteres. La cadena de protocolo HTTP o HTTPS cuenta para el límite de 2048 caracteres. - La plantilla de seguimiento debe ser una dirección URL bien formada que comience por una de las siguientes: http://, https://, {lpurl}o {unescapedlpurl}. - Microsoft Advertising no valida si existen parámetros personalizados. Si usa parámetros personalizados en la plantilla de seguimiento y no existen, la dirección URL de la página de aterrizaje incluirá los marcadores de posición de clave y valor de los parámetros personalizados sin sustitución. Por ejemplo, si la plantilla de seguimiento es `https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}` y no se definen {_season} ni {_promocode} en el nivel de campaña, grupo de anuncios, criterio, palabra clave o anuncio, la dirección URL de la página de aterrizaje será la misma. Añadir: Opcional Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si establece este elemento en una cadena vacía (""), se eliminará la configuración anterior.	string
UrlCustomParameters	Colección personalizada de parámetros de clave y valor para el seguimiento de direcciones URL. Microsoft Advertising aceptará los tres primeros objetos CustomParameter que incluya en el objeto CustomParameters y se omitirán los parámetros personalizados adicionales. Cada CustomParameter incluye elementos Key y Value . Para los clientes de la fase 3 de aumento de límite de parámetros personalizados piloto (GetCustomerPilotFeatures devuelve 635), Microsoft Advertising aceptará los primeros 8 pares de clave y valor de parámetro personalizados que incluya y, si incluye más de 8 parámetros personalizados, se devolverá un error. Añadir: Opcional Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Establezca el elemento UrlCustomParameters en null o vacío para conservar los parámetros personalizados existentes. Para quitar todos los parámetros personalizados, establezca el elemento Parameters del objeto CustomParameters en null o vacío. Para quitar un subconjunto de parámetros personalizados, especifique los parámetros personalizados que desea conservar en el elemento Parameters del objeto CustomParameters .	CustomParameters

El objeto PromotionAdExtension tiene elementos heredados.

Elementos heredados

Elementos heredados de AdExtension

El objeto PromotionAdExtension deriva del objeto AdExtension y hereda los siguientes elementos: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. Las descripciones siguientes son específicas de PromotionAdExtension y es posible que no se apliquen a otros objetos que hereden los mismos elementos del objeto AdExtension .

Elemento	Descripción	Tipo de datos
DevicePreference	No se admite para este tipo de extensión de anuncio.	Largo
ForwardCompatibilityMap	Lista de cadenas de clave y valor para la compatibilidad con reenvíos para evitar cambios importantes en caso contrario cuando se agregan nuevos elementos en la versión actual de la API. Actualmente no hay cambios de compatibilidad de reenvío para el objeto AdExtension . Añadir: Solo lectura Actualizar: Solo lectura	Matriz KeyValuePairOfstringstring
Id	Identificador único de Microsoft Advertising de la extensión de anuncio. Añadir: Solo lectura Actualizar: Solo lectura y Obligatorio	Largo
Programar	Determina los intervalos de día y hora del calendario cuando la extensión del anuncio es apta para mostrarse en los anuncios. Añadir: Opcional Actualizar: Opcional. Si establece este elemento null, cualquier programación existente establecida para la extensión de anuncio permanecerá sin cambios. Si establece esto en cualquier objeto Schedule que no sea NULL, está reemplazando eficazmente la configuración de programación existente para la extensión de anuncio. Para quitar toda la programación, establezca este elemento en un objeto Schedule vacío.	Schedule
Estado	Estado de la extensión del anuncio. El valor siempre será Activo porque el servicio Administración de campañas no devuelve extensiones de anuncios eliminadas. Añadir: Solo lectura Actualizar: Solo lectura	AdExtensionStatus
Tipo	Tipo de la extensión de anuncio. Este valor es PromotionAdExtension cuando se recupera una extensión de anuncio de promoción. Añadir: Solo lectura Actualizar: Solo lectura Para obtener más información sobre los tipos de extensión de anuncio, consulte comentarios sobre los objetos de datos de extensión de anuncios.	string
Versión	Realiza un seguimiento del número de veces que se ha actualizado la extensión del anuncio. La versión se establece en 1 cuando se crea la extensión del anuncio y aumenta en uno después de cada actualización. Añadir: No permitido Actualizar: No permitido	int

Requisitos

Servicio: CampaignManagementService.svc v13
Nombres: https://bingads.microsoft.com/CampaignManagement/v13