Objeto de Dados PromotionAdExtension - Gestão de Campanhas

Artigo
12/21/2023

As Extensões de Promoção realçam as vendas e ofertas especiais nos seus anúncios de texto. Ao destacar as ofertas, é mais provável que os potenciais clientes cliquem no seu anúncio, ajudando a gerar mais vendas por si.

Pode associar uma extensão de anúncios de promoção à conta ou a campanhas e grupos de anúncios na conta. Cada entidade (conta, campanha ou grupo de anúncios) pode ser associada a até 20 extensões de anúncios de promoção.

Nota

As Extensões de Promoção estão disponíveis para clientes na AU, CA, DE, FR, E.U.A. e Reino Unido.

Sintaxe

<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

O objeto PromotionAdExtension tem os seguintes elementos: CurrencyCode, DiscountModifier, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Language, MoneyAmountOff, OrdersOverAmount, PercentOff, PromotionCode, PromotionEndDate, PromotionItem, PromotionOccasion, PromotionStartDate, TrackingUrlTemplate, UrlCustomParameters.

Elemento	Descrição	Tipo de Dados
CurrencyCode	O código de moeda para o preço de promoção ou desconto. Este campo só é aplicável se definir MoneyAmountOff ou OrdersOverAmount. Os códigos de moeda suportados são ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, DKK, EUR, GBP, HKD, INR, MXN, NZD, PEN, PHP, PLN, SEK, SGD, USD, TWD e VEF. Adicionar: Necessário se MoneyAmountOff ou OrdersOverAmount estiverem definidos. Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se definir PercentOff ou PromotionCode, esta definição já não é aplicável e será eliminada.	cadeia
DiscountModifier	O modificador de desconto de promoção. Por exemplo, digamos que o modificador de desconto está definido como UpTo. Então, se o desconto de promoção não modificado seria "$20 fora dos sapatos", a promoção modificada é "Até $20 fora dos sapatos". Adicionar: Opcional. Se não especificar este elemento ou o deixar vazio, o valor predefinido de Nenhum será definido. Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada.	PromotionDiscountModifier
FinalAppUrls	Reservado 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. Adicionar: Opcional Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se definir este elemento para uma lista vazia, a definição anterior será eliminada.	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. Adicionar: Necessário Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada.	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, esta definição não será alterada. Se definir este elemento como uma cadeia vazia ("", a definição anterior será eliminada.	cadeia
Idioma	O idioma em que a extensão de anúncios será fornecida. A extensão será sempre servida neste idioma, independentemente das definições de idioma da campanha ou do grupo de anúncios. As cadeias de idioma suportadas são: dinamarquês, neerlandês, inglês, finlandês, francês, alemão, italiano, norueguês, português, espanhol, sueco e tradicionalchinês. Adicionar: Necessário Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada.	cadeia
MoneyAmountOff	O dinheiro fora do valor de promoção. Por exemplo, para promover "$20 sem sapatos – em encomendas superiores a 100 $", defina PromotionItem como "shoes", defina CurrencyCode como "USD", defina MoneyAmountOff como 20 e defina OrdersOverAmount como 100. Adicionar: Obrigatório. Tem de definir MoneyAmountOff ou PercentOff, mas não pode definir ambos. Atualização: Opcional. Pode definir MoneyAmountOff ou PercentOff, mas não pode definir ambos.	duplo
OrdersOverAmount	O valor das encomendas sobre o valor acrescentado ao destino da promoção. Por exemplo, para promover "$20 sem sapatos – em encomendas superiores a 100 $", defina PromotionItem como "shoes", defina CurrencyCode como "USD", defina MoneyAmountOff como 20 e defina OrdersOverAmount como 100. Adicionar: Opcional. Não pode definir OrdersOverAmount e PromotionCode. Atualização: Opcional. Não pode definir OrdersOverAmount e PromotionCode. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se definir este elemento como "0" (zero), a definição anterior será eliminada.	duplo
Percentagem Desativado	A percentagem de desconto no valor da promoção. Por exemplo, 10,0 representa um desconto de 10%. Adicionar: Obrigatório. Tem de definir MoneyAmountOff ou PercentOff, mas não pode definir ambos. Atualização: Opcional. Pode definir MoneyAmountOff ou PercentOff, mas não pode definir ambos. Se definir esta propriedade, a definição CurrencyCode já não é aplicável e será eliminada se tiver sido definida anteriormente.	duplo
PromotionCode	O código de promoção acrescentado ao destino da promoção. Por exemplo, para promover "$20 off shoes - Promocode SAVE20", defina PromotionItem como "shoes", defina CurrencyCode como "USD", defina MoneyAmountOff como 20 e defina PromotionCode como "SAVE20". A cadeia pode conter um máximo de 15 carateres. Adicionar: Opcional. Não pode definir OrdersOverAmount e PromotionCode. Atualização: Opcional. Não pode definir OrdersOverAmount e PromotionCode. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se definir este elemento como uma cadeia vazia ("", a definição anterior será eliminada. Se definir esta propriedade, a definição CurrencyCode já não é aplicável e será eliminada se tiver sido definida anteriormente.	cadeia
PromotionEndDate	A data de fim ajuda a informar a data ou datas de promoção que serão apresentadas no anúncio. Por exemplo, se as datas PromotionStartDate e PromotionEndDate estiverem definidas para 14 de fevereiro, o texto "14 de fevereiro válido" pode ser incluído na promoção apresentada. A data PromotionStartDate tem de ser anterior ou igual à data PromotionEndDate . Esta propriedade não substitui o intervalo de entrega inerente para uma promoção. Tanto a promoção PromotionOccasion como o Agendamento determinam quando a promoção é elegível para ser apresentada em anúncios. Se a data de fim já tiver passado para o ano atual, cada data de início e de fim tem de ser definida para datas durante o ano seguinte. Adicionar: Opcional Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Para eliminar a data de fim atual e definir efetivamente nenhuma data de fim, defina o Dia, Mês e Ano para "0" (zero). Quando obter a extensão de anúncios de promoção da próxima vez, este elemento não será definido.	Data
PromotionItem	O destino ou item de promoção. Por exemplo, pode fazer uma promoção para "sapatos" com um desconto de 20 $ ou 20%. Para executar uma promoção para "Até 20 $ sem sapatos", defina o PromotionItem como "shoes", defina DiscountModifier como UpTo, defina CurrencyCode como "USD" e defina MoneyAmountOff como 20. A cadeia pode conter um máximo de 20 carateres. Adicionar: Necessário Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada.	cadeia
PromotionOccasion	A ocasião de promoção. Tanto os elementos PromotionOccasion como Scheduling determinam quando a promoção é elegível para ser apresentada em anúncios. A PromotionOccasion determina o período de tempo ou sazonalidade, por exemplo, WomensDay de 15 de fevereiro a 31 de março de cada ano. A promoção só será executada nas datas correspondentes à ocasião que definiu. Veja PromotionOccasion para obter detalhes sobre o intervalo de datas definido para cada ocasião. O Agendamento pode limitar a promoção a um período de tempo mais curto dentro do intervalo de datas da ocasião, por exemplo, limitar a promoção a ser executada de 20 de fevereiro a 8 de março. O Agendamento também pode ser usado para executar a mesma promoção vários anos, por exemplo, executar a promoção WomensDay todos os anos de 15 de fevereiro a 31 de março. Adicionar: Opcional. Se não especificar este elemento ou o deixar vazio, o valor predefinido de Nenhum será definido. Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Se definir este elemento, promotionStartDate e PromotionEndDate também têm de ser definidos para manter ou atualizar as definições anteriores.	PromotionOccasion
PromotionStartDate	A data de início ajuda a informar a data ou datas de promoção que serão apresentadas no anúncio. Por exemplo, se as datas PromotionStartDate e PromotionEndDate estiverem definidas para 14 de fevereiro, o texto "14 de fevereiro válido" pode ser incluído na promoção apresentada. A data PromotionStartDate tem de ser anterior ou igual à data PromotionEndDate . Esta propriedade não substitui o intervalo de entrega inerente para uma promoção. Tanto a promoção PromotionOccasion como o Agendamento determinam quando a promoção é elegível para ser apresentada em anúncios. Se a data de fim já tiver passado para o ano atual, cada data de início e de fim tem de ser definida para datas durante o ano seguinte. Adicionar: Opcional Atualização: Opcional. Se não estiver definido nenhum valor para a atualização, esta definição não será alterada. Para eliminar a data de fim atual e definir efetivamente nenhuma data de fim, defina o Dia, Mês e Ano para "0" (zero). Quando obter a extensão de anúncios de promoção da próxima vez, este elemento não será definido.	Data
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, esta definição não será alterada. Se definir este elemento como uma cadeia vazia ("", a definição anterior será eliminada.	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, esta definição não será alterada. Defina o elemento UrlCustomParameters como nulo ou vazio para manter quaisquer parâmetros personalizados existentes. Para remover todos os parâmetros personalizados, defina o elemento Parâmetros do objeto CustomParameters como nulo ou vazio. Para remover um subconjunto de parâmetros personalizados, especifique os parâmetros personalizados que pretende manter no elemento Parâmetros do objeto CustomParameters .	CustomParameters

O objeto PromotionAdExtension tem Elementos Herdados.

Elementos Herdados

Elementos Herdados do AdExtension

O objeto PromotionAdExtension 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 PromotionAdExtension 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.	long
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	long
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 é PromotionAdExtension quando obtém uma extensão de anúncio de promoção. 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

Partilhar via