Partilhar via

ImageAdExtension Data Object - Gestão de Campanhas

  • Artigo

Define uma extensão de anúncio que especifica uma imagem com texto alternativo a incluir num anúncio de texto expandido.

Pode associar uma extensão de anúncio de imagem à conta ou a campanhas e grupos de anúncios na conta. Para cada conta, apenas 1000 campanhas e 1000 grupos de anúncios podem ser associados a extensões de anúncios de imagem. Cada entidade (conta, campanha ou grupo de anúncios) pode ser associada a até 6 extensões de anúncios de imagem.

Sintaxe

<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="SourceType" 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="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

O objeto ImageAdExtension tem os seguintes elementos: AlternativeText, Description, DestinationUrl, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, ImageMediaIds, Images, Layouts, SourceType, TrackingUrlTemplate, UrlCustomParameters.

Elemento Descrição Tipo de Dados
Texto Alternativo Descrição alternativa do suporte de dados de imagem para utilização. Se não for possível apresentar a imagem, é utilizado o texto alternativo.

O comprimento máximo para este elemento é de 35 carateres.

Adicionar: Necessário
Atualização: Necessário		 cadeia
Descrição Descrição que pode ser utilizada pelo anunciante, agência ou gestor de conta para controlar, etiquetar ou gerir multimédia de imagens.

Esta descrição não é apresentada com o anúncio ou imagem.

O comprimento máximo para este elemento é de 100 carateres.

Adicionar: Opcional
Atualização: Opcional. Se definir este elemento como nulo, a definição anterior será eliminada.		 cadeia
DestinationUrl O URL da página Web para onde levar o utilizador quando clicar na imagem.

O URL pode conter cadeias de texto dinâmicas, como {keyword}. Para obter mais informações, veja Que parâmetros de controlo ou URL posso utilizar?.

O URL pode conter um máximo de 1024 carateres. Se o URL não especificar um protocolo, o sistema utiliza o protocolo HTTP quando um utilizador clica no anúncio. Se o URL especificar o protocolo HTTP ao adicionar um anúncio, o serviço removerá a cadeia de protocolo http:// (a cadeia de protocolo HTTP não conta para o limite de 1024 carateres); no entanto, o serviço não removerá uma cadeia de protocolo HTTPS (https://) do URL.

Se o URL não for especificado para a extensão de anúncio de imagem, é utilizado o URL do anúncio.

Adicionar: Opcional
Atualização: Opcional. Se definir este elemento como nulo, a definição anterior será eliminada.		 cadeia
Texto a Apresentar O texto a apresentar da sua extensão de imagem.

O comprimento máximo para este elemento é de 35 carateres.

Adicionar: Necessário quando Layouts contém SearchMultiple, senão Opcional.
Atualização: Necessário quando Layouts contém SearchMultiple, senão Opcional. Se definir este elemento como nulo, a definição anterior será eliminada.		 cadeia
FinalAppUrls Para utilização futura. Matriz appUrl
FinalMobileUrls O URL da página de destino para dispositivos móveis.

As seguintes regras de validação aplicam-se a URLs Finais e URLs Móveis Finais.
- O comprimento do URL está limitado a 2048 carateres. A cadeia de protocolo HTTP ou HTTPS conta para o limite de 2048 carateres.
- Pode especificar até 10 itens de lista para FinalUrls e FinalMobileUrls; no entanto, apenas o primeiro item em cada lista é utilizado para entrega. O serviço permite até 10 itens de lista para potencial compatibilidade de reencaminhamento.
- A utilização de '{' e '}' só tem permissão para delinear etiquetas, por exemplo {lpurl}.
- Os URLs finais têm de ser um URL bem formado, começando com http:// ou https://.
- Se especificar FinalMobileUrls, também tem de especificar FinalUrls.
- Não pode especificar FinalMobileUrls se o DevicePreference estiver definido como 30001 (móvel).

Adicionar: Opcional
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, a definição anterior será removida.		 matriz de cadeia
FinalUrls O URL da página de destino.

As seguintes regras de validação aplicam-se a URLs Finais e URLs Móveis Finais.
- O comprimento do URL está limitado a 2048 carateres. A cadeia de protocolo HTTP ou HTTPS conta para o limite de 2048 carateres.
- Pode especificar até 10 itens de lista para FinalUrls e FinalMobileUrls; no entanto, apenas o primeiro item em cada lista é utilizado para entrega. O serviço permite até 10 itens de lista para potencial compatibilidade de reencaminhamento.
- A utilização de '{' e '}' só tem permissão para delinear etiquetas, por exemplo {lpurl}.
- Os URLs finais têm de ser um URL bem formado, começando com http:// ou https://.
- Se especificar FinalMobileUrls, também tem de especificar FinalUrls.
- Não pode especificar FinalMobileUrls se o DevicePreference estiver definido como 30001 (móvel).

Adicionar: Opcional
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, a definição anterior será removida.		 matriz de cadeia
FinalUrlSuffix O sufixo de URL final pode incluir parâmetros de controlo que serão anexados ao final do URL da página de destino. Recomendamos que coloque os parâmetros de controlo de que a página de destino necessita num sufixo de URL final para que os seus clientes sejam sempre enviados para a sua página de destino. Para obter mais detalhes e regras de validação, veja Sufixo de URL Final nos guias técnicos.

Esta funcionalidade só está disponível para clientes no piloto Fase 3 do Sufixo de URL Final (GetCustomerPilotFeatures devolve 636). Se não estiver no piloto, esta propriedade será ignorada e não será devolvido nenhum erro.

Adicionar: Opcional
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, a definição anterior será removida.		 cadeia
ImageMediaIds Os identificadores das imagens a incluir no anúncio. Não pode especificar identificadores de multimédia para mais do que uma imagem da mesma proporção. Por outras palavras, cada uma das imagens referenciadas tem de ter proporções diferentes.

Pode especificar até quatro (4) identificadores de multimédia de imagem. Embora o mínimo necessário seja um ID de multimédia de imagem, para se qualificar para todas as colocações de anúncios, tem de fornecer quatro identificadores de multimédia de imagem, em que cada ID corresponde a uma Imagem de um dos quatro tipos de Multimédia suportados (proporções). As proporções suportadas para anúncios de audiência são 16:9, 1.5:1, 4:3 e 1.2:1. Para obter mais informações, veja a Documentação de referência de objetos de dados de imagem.

Pode obter o identificador de cada Imagem ao adicioná-los à biblioteca de imagens ao chamar a operação AddMedia . Caso contrário, depois de o suporte de dados ter sido adicionado à biblioteca de imagens, pode obter os identificadores de multimédia com a operação GetMediaMetaDataByAccountId .

Adicionar: Necessário
Atualização: Necessário		 matriz longa
Imagens Recursos de imagem com diferentes tamanhos e proporções para que possam ser apresentados de forma flexível em vários editores e posicionamentos.

Inclua um ou mais objetos AssetLink que contêm cada um um ImageAsset com o Subtipo e as definições de recorte que correspondem à proporção pretendida.

Adicionar: Necessário
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se incluir imagens durante a atualização, todas as imagens definidas anteriormente serão substituídas.		 Matriz AssetLink
Esquemas A lista de esquemas de imagem elegíveis.

Os valores suportados são SearchSingle e SearchMultiple. Poderão ser adicionados novos esquemas no futuro, pelo que não deve assumir qualquer dependência num conjunto fixo de valores.

Adicionar: Necessário
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se incluir esquemas durante a atualização, todos os esquemas definidos anteriormente serão substituídos.		 matriz de cadeia
Tipo de Origem O tipo de origem. cadeia
TrackingUrlTemplate O modelo de controlo a utilizar como predefinição para todos os FinalUrls e FinalMobileUrls.

As seguintes regras de validação aplicam-se aos modelos de controlo. Para obter mais detalhes sobre os modelos e parâmetros suportados, consulte o artigo de ajuda do Microsoft Advertising Que parâmetros de controlo ou URL posso utilizar?
- Modelos de controlo definidos para entidades de nível inferior, por exemplo, os anúncios substituem os conjuntos de entidades de nível superior, por exemplo, campanha. Para obter mais informações, veja Limites de Entidades.
- O comprimento do modelo de controlo está limitado a 2048 carateres. A cadeia de protocolo HTTP ou HTTPS conta para o limite de 2048 carateres.
- O modelo de controlo tem de ser um URL bem formado, começando por um dos seguintes: http://, https://, {lpurl} ou {unescapedlpurl}.
- O Microsoft Advertising não valida se existem parâmetros personalizados. Se utilizar parâmetros personalizados no seu modelo de controlo e estes não existirem, o URL da página de destino incluirá os marcadores de posição de chave e valor dos parâmetros personalizados sem substituição. Por exemplo, se o seu modelo de controlo for https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} e nem {_season} nem {_promocode} estiverem definidos na campanha, grupo de anúncios, critério, palavra-chave ou nível de anúncio, o URL da página de destino será o mesmo.

Adicionar: Opcional
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, a definição anterior será removida.		 cadeia
UrlCustomParameters A sua coleção personalizada de parâmetros de chave e valor para controlo de URLs.

O Microsoft Advertising aceitará os primeiros 3 objetos CustomParameter que incluir no objeto CustomParameters e quaisquer parâmetros personalizados adicionais serão ignorados. Cada CustomParameter inclui elementos Chave e Valor . Para os clientes no piloto de Aumento do Limite de Parâmetros Personalizados Fase 3 (GetCustomerPilotFeatures devolve 635), o Microsoft Advertising aceitará os primeiros oito pares de chave e valor personalizados incluídos e, se incluir mais de 8 parâmetros personalizados, será devolvido um erro.

Adicionar: Opcional
Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, a definição anterior será removida.		 CustomParameters

O objeto ImageAdExtension tem Elementos Herdados.

Elementos Herdados

Elementos Herdados do AdExtension

O objeto ImageAdExtension deriva do objeto AdExtension e herda os seguintes elementos: DevicePreference, ForwardCompatibilityMap, ID, Scheduling, Status, Type, Version. As descrições abaixo são específicas de ImageAdExtension e podem não se aplicar a outros objetos que herdam os mesmos elementos do objeto AdExtension .

Elemento Descrição Tipo de Dados
DevicePreference Não é suportado para este tipo de extensão de anúncio. Longo
ForwardCompatibilityMap A lista de cadeias de chave e valor para compatibilidade de reencaminhamento para evitar alterações interruptivas quando novos elementos são adicionados na versão atual da API.

Atualmente, não existem alterações de compatibilidade para o objeto AdExtension .

Adicionar: Só de leitura
Atualização: Só de leitura		 Matriz KeyValuePairOfstringstring
ID O identificador exclusivo do Microsoft Advertising da extensão de anúncios.

Adicionar: Só de leitura
Atualização: Só de leitura e Obrigatório		 Longo
Agendamento Determina os intervalos de dia e hora do calendário quando a extensão de anúncios é elegível para ser apresentada em anúncios.

Adicionar: Opcional
Atualização: Opcional. Se definir este elemento como nulo, qualquer conjunto de agendamento existente para a extensão de anúncio permanecerá inalterado. Se definir esta opção para qualquer objeto Schedule não nulo, está efetivamente a substituir as definições de agendamento existentes para a extensão de anúncios. Para remover todo o agendamento, defina este elemento para um objeto Schedule vazio.		 Agenda
Estado O estado da extensão de anúncios. O valor será sempre Ativo porque o serviço Gestão de Campanhas não devolve extensões de anúncios eliminadas.

Adicionar: Só de leitura
Atualização: Só de leitura		 AdExtensionStatus
Tipo O tipo da extensão de anúncios. Este valor é ImageAdExtension quando obtém uma extensão de anúncio de imagem.

Adicionar: Só de leitura
Atualização: Só de leitura

Para obter mais informações sobre os tipos de extensão de anúncios, veja Comentários sobre Objetos de Dados da Extensão do Ad.		 cadeia
Versão Monitoriza o número de vezes que a extensão de anúncios foi atualizada.

A versão é definida como 1 quando a extensão de anúncio é criada e incrementa um após cada atualização.

Adicionar: Não permitido
Atualização: Não permitido		 int

Requisitos

Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13