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

  • Artículo

Define una extensión de anuncio que especifica una imagen con texto alternativo para incluirla en un anuncio de texto expandido.

Puede asociar una extensión de anuncio de imagen a la cuenta o a campañas y grupos de anuncios de la cuenta. Para cada cuenta, solo se pueden asociar 1000 campañas y 1000 grupos de anuncios con extensiones de anuncios de imagen. Cada entidad (cuenta, campaña o grupo de anuncios) se puede asociar con hasta 6 extensiones de anuncio de imagen.

Sintaxis

<xs:complexType name="ImageAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q43="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q43:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q44="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q44:ArrayOfstring" />
        <xs:element xmlns:q45="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q45:ArrayOflong" />
        <xs:element minOccurs="0" name="Images" nillable="true" type="tns:ArrayOfAssetLink">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element xmlns:q46="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Layouts" nillable="true" type="q46:ArrayOfstring">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <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 ImageAdExtension tiene los siguientes elementos: AlternativeText, Description, DestinationUrl, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, ImageMediaIds, Images, Layouts, TrackingUrlTemplate, UrlCustomParameters.

Elemento Descripción Tipo de datos
AlternativeText Descripción alternativa del medio de imagen para su facilidad de uso. Si no se pudo mostrar la imagen, se usa el texto alternativo en su lugar.

La longitud máxima de este elemento es de 35 caracteres.

Añadir: Obligatorio
Actualizar: Obligatorio		 string
Descripción Descripción que puede usar el anunciante, la agencia o el administrador de cuentas para realizar un seguimiento, etiquetar o administrar medios de imagen.

Esta descripción no se muestra con el anuncio o la imagen.

La longitud máxima de este elemento es de 100 caracteres.

Añadir: Opcional
Actualizar: Opcional. Si establece este elemento null, se eliminará la configuración anterior.		 string
DestinationUrl Dirección URL de la página web a la que se va a llevar al usuario cuando hace clic en la imagen.

La dirección URL puede contener cadenas de texto dinámicas como {keyword}. Para obtener más información, consulte ¿Qué parámetros de seguimiento o dirección URL puedo usar?.

La dirección URL puede contener un máximo de 1024 caracteres. Si la dirección URL no especifica un protocolo, el sistema usa el protocolo HTTP cuando un usuario hace clic en el anuncio. Si la dirección URL especifica el protocolo HTTP al agregar un anuncio, el servicio quitará la cadena de protocolo http:// (la cadena de protocolo HTTP no cuenta con el límite de 1024 caracteres); sin embargo, el servicio no quitará una cadena de protocolo HTTPS (https://) de la dirección URL.

Si no se especifica la dirección URL para la extensión de anuncio de imagen, se usa la dirección URL del anuncio.

Añadir: Opcional
Actualizar: Opcional. Si establece este elemento null, se eliminará la configuración anterior.		 string
DisplayText Texto para mostrar de la extensión de imagen.

La longitud máxima de este elemento es de 35 caracteres.

Añadir: Obligatorio cuando layouts contiene SearchMultiple, de lo contrario, opcional.
Actualizar: Obligatorio cuando layouts contiene SearchMultiple, de lo contrario, opcional. Si establece este elemento null, se eliminará la configuración anterior.		 string
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.
- No puede especificar FinalMobileUrls si DevicePreference está establecido en 30001 (móvil).

Añadir: Opcional
Actualizar: Opcional. Si no se establece ningún valor para la actualización, se quita 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.
- No puede especificar FinalMobileUrls si DevicePreference está establecido en 30001 (móvil).

Añadir: Opcional
Actualizar: Opcional. Si no se establece ningún valor para la actualización, se quita la configuración anterior.		 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, se quita la configuración anterior.		 string
ImageMediaIds Identificadores de las imágenes que se incluirán en el anuncio. No puede especificar identificadores multimedia para más de una imagen de la misma relación de aspecto. En otras palabras, cada una de las imágenes a las que se hace referencia debe tener relaciones de aspecto diferentes.

Puede especificar hasta cuatro (4) identificadores multimedia de imagen. Aunque el mínimo necesario es un identificador de medio de imagen, para calificar para todas las ubicaciones de anuncios, debe proporcionar cuatro identificadores de medios de imagen, donde cada identificador corresponde a una imagen de uno de los cuatro tipos de medios admitidos (relaciones de aspecto). Las relaciones de aspecto admitidas para los anuncios de audiencia son 16:9, 1.5:1, 4:3 y 1.2:1. Para obtener más información, consulte la documentación de referencia del objeto de datos image .

Puede obtener el identificador de cada imagen cuando los agregue a la biblioteca de imágenes llamando a la operación AddMedia . De lo contrario, una vez agregado el medio a la biblioteca de imágenes, puede obtener los identificadores multimedia con la operación GetMediaMetaDataByAccountId .

Añadir: Obligatorio
Actualizar: Obligatorio		 matriz larga
Imágenes Recursos de imagen con diferentes tamaños y proporciones de aspecto para que puedan mostrarse de forma flexible en una variedad de publicadores y ubicaciones.

Incluya uno o varios objetos AssetLink que contengan un ImageAsset con subtipo y opciones de recorte que coincidan con la relación de aspecto deseada.

Añadir: Obligatorio
Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si incluye imágenes durante la actualización, se reemplazarán las imágenes establecidas anteriormente.		 Matriz AssetLink
Diseños Lista de diseños de imagen aptos.

Los valores admitidos son SearchSingle y SearchMultiple. Es posible que en el futuro se agreguen nuevos diseños, por lo que no debe depender de un conjunto fijo de valores.

Añadir: Obligatorio
Actualizar: Opcional. Si no se establece ningún valor para la actualización, esta configuración no cambia. Si incluye diseños durante la actualización, se reemplazarán los diseños establecidos anteriormente.		 matriz de cadenas
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, se quita 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, se quita la configuración anterior.		 CustomParameters

El objeto ImageAdExtension tiene elementos heredados.

Elementos heredados

Elementos heredados de AdExtension

El objeto ImageAdExtension deriva del objeto AdExtension y hereda los siguientes elementos: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. Las descripciones siguientes son específicas de ImageAdExtension 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 ImageAdExtension cuando se recupera una extensión de anuncio de imagen.

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