Partager via

Objet de données PromotionAdExtension - Gestion des campagnes

  • Article

Les extensions de promotion mettent en évidence les ventes et les offres spéciales dans vos annonces texte. En faisant ressortir les offres, les clients potentiels sont plus susceptibles de cliquer sur votre annonce, ce qui contribue à générer plus de ventes pour vous.

Vous pouvez associer une extension de publicité promotionnelle au compte ou à des campagnes et des groupes d’annonces dans le compte. Chaque entité (compte, campagne ou groupe d’annonces) peut être associée à jusqu’à 20 extensions publicitaires de promotion.

Remarque

Les extensions de promotion sont disponibles pour les clients en AU, CA, DE, FR, États-Unis et Royaume-Uni.

Syntaxe

<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:q57="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q57:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q58="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q58: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>

Éléments

L’objet PromotionAdExtension contient les éléments suivants : CurrencyCode, DiscountModifier, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Language, MoneyAmountOff, OrdersOverAmount, PercentOff, PromotionCode, PromotionEndDate, PromotionItem, PromotionOccasion, PromotionStartDate, TrackingUrlTemplate, UrlCustomParameters.

Élément Description Type de données
CurrencyCode Code monétaire du prix ou de la remise de la promotion.

Ce champ s’applique uniquement si vous définissez MoneyAmountOff ou OrdersOverAmount.

Les codes monétaires pris en charge sont ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, DKK, EUR, GBP, HKD, INR, MXN, NZD, PEN, PHP, PLN, SEK, SGD, USD, TWD et VEF.

Ajouter: Obligatoire si MoneyAmountOff ou OrdersOverAmount sont définis.
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez PercentOff ou PromotionCode, ce paramètre n’est plus applicable et sera supprimé.		 chaîne
DiscountModifier Modificateur de remise de promotion.

Par exemple, supposons que le modificateur de remise est défini sur UpTo. Ensuite, si la remise de promotion non modifiée est « 20 $ sur les chaussures », la promotion modifiée est « Jusqu’à 20 $ sur les chaussures ».

Ajouter: Optionnel. Si vous ne spécifiez pas cet élément ou si vous le laissez vide, la valeur par défaut none est définie.
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié.		 PromotionDiscountModifier
FinalAppUrls Pour une utilisation ultérieure. Tableau AppUrl
FinalMobileUrls URL de la page d’accueil des appareils mobiles.

Les règles de validation suivantes s’appliquent aux URL finales et aux URL mobiles finales.
- La longueur de l’URL est limitée à 2 048 caractères. La chaîne de protocole HTTP ou HTTPS compte pour la limite de 2 048 caractères.
- Vous pouvez spécifier jusqu’à 10 éléments de liste pour FinalUrls et FinalMobileUrls. Toutefois, seul le premier élément de chaque liste est utilisé pour la remise. Le service autorise jusqu’à 10 éléments de liste pour une compatibilité descendante potentielle.
- L’utilisation de « { » et de « } » est autorisée uniquement pour délimiter les balises, par exemple {lpurl}.
- Les URL finales doivent chacune être une URL bien formée commençant par http:// ou https://.
- Si vous spécifiez FinalMobileUrls, vous devez également spécifier FinalUrls.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez cet élément sur une liste vide, le paramètre précédent est supprimé.		 tableau de chaînes
FinalUrls URL de la page d’accueil.

Les règles de validation suivantes s’appliquent aux URL finales et aux URL mobiles finales.
- La longueur de l’URL est limitée à 2 048 caractères. La chaîne de protocole HTTP ou HTTPS compte pour la limite de 2 048 caractères.
- Vous pouvez spécifier jusqu’à 10 éléments de liste pour FinalUrls et FinalMobileUrls. Toutefois, seul le premier élément de chaque liste est utilisé pour la remise. Le service autorise jusqu’à 10 éléments de liste pour une compatibilité descendante potentielle.
- L’utilisation de « { » et de « } » est autorisée uniquement pour délimiter les balises, par exemple {lpurl}.
- Les URL finales doivent chacune être une URL bien formée commençant par http:// ou https://.
- Si vous spécifiez FinalMobileUrls, vous devez également spécifier FinalUrls.

Ajouter: Obligatoire
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié.		 tableau de chaînes
FinalUrlSuffix Le suffixe d’URL final peut inclure des paramètres de suivi qui seront ajoutés à la fin de l’URL de votre page d’accueil. Nous vous recommandons de placer les paramètres de suivi requis par votre page d’accueil dans un suffixe d’URL final afin que vos clients soient toujours envoyés à votre page d’accueil. Pour plus d’informations et les règles de validation, consultez Suffixe d’URL final dans les guides techniques.

Cette fonctionnalité n’est disponible que pour les clients dans le pilote Final URL Suffix Phase 3 (GetCustomerPilotFeatures renvoie 636). Si vous n’êtes pas dans le pilote, cette propriété sera ignorée et aucune erreur ne sera retournée.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez cet élément sur une chaîne vide («  »), le paramètre précédent est supprimé.		 chaîne
Langue Langue dans laquelle l’extension de publicité sera servie.

L’extension est toujours servie dans cette langue, quels que soient les paramètres linguistiques de la campagne ou du groupe d’annonces.

Les chaînes de langue prises en charge sont les suivantes : danois, néerlandais, anglais, finnois, français, allemand, italien, norvégien, portugais, espagnol, suédois et traditionnelchinese.

Ajouter: Obligatoire
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié.		 chaîne
MoneyAmountOff La valeur de la promotion de l’argent.

Par exemple, pour promouvoir « $20 off shoes - On orders over $100 », définissez PromotionItem sur « shoes », définissez CurrencyCode sur « USD », définissez MoneyAmountOff sur 20 et définissez OrdersOverAmount sur 100.

Ajouter: Obligatoire. Vous devez définir MoneyAmountOff ou PercentOff, mais vous ne pouvez pas définir les deux.
Mettre à jour: Optionnel. Vous pouvez définir MoneyAmountOff ou PercentOff, mais vous ne pouvez pas définir les deux.		 double
OrdersOverAmount Valeur des commandes sur le montant ajoutée à la cible de promotion.

Par exemple, pour promouvoir « $20 off shoes - On orders over $100 », définissez PromotionItem sur « shoes », définissez CurrencyCode sur « USD », définissez MoneyAmountOff sur 20 et définissez OrdersOverAmount sur 100.

Ajouter: Optionnel. Vous ne pouvez pas définir OrdersOverAmount et PromotionCode.
Mettre à jour: Optionnel. Vous ne pouvez pas définir OrdersOverAmount et PromotionCode. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez cet élément sur « 0 » (zéro), le paramètre précédent est supprimé.		 double
PercentOff Pourcentage de la valeur de la promotion.

Par exemple, 10.0 représente une remise de 10 %.

Ajouter: Obligatoire. Vous devez définir MoneyAmountOff ou PercentOff, mais vous ne pouvez pas définir les deux.
Mettre à jour: Optionnel. Vous pouvez définir MoneyAmountOff ou PercentOff, mais vous ne pouvez pas définir les deux. Si vous définissez cette propriété, le paramètre CurrencyCode n’est plus applicable et sera supprimé s’il a été précédemment défini.		 double
Code de promotion Code de promotion ajouté à la cible de promotion.

Par exemple, pour promouvoir « $20 off shoes - Promocode SAVE20 », définissez PromotionItem sur « shoes », définissez CurrencyCode sur « USD », définissez MoneyAmountOff sur 20 et définissez PromotionCode sur « SAVE20 ».

La chaîne peut contenir un maximum de 15 caractères.

Ajouter: Optionnel. Vous ne pouvez pas définir OrdersOverAmount et PromotionCode.
Mettre à jour: Optionnel. Vous ne pouvez pas définir OrdersOverAmount et PromotionCode. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez cet élément sur une chaîne vide («  »), le paramètre précédent est supprimé. Si vous définissez cette propriété, le paramètre CurrencyCode n’est plus applicable et sera supprimé s’il a été précédemment défini.		 chaîne
PromotionEndDate La date de fin permet d’informer la ou les dates de promotion qui seront affichées dans l’annonce.

Par exemple, si les dates PromotionStartDate et PromotionEndDate sont toutes deux définies sur le 14 février, le texte « Valid Feb 14 » peut être inclus dans la promotion affichée.

La date PromotionStartDate doit être antérieure ou égale à la date PromotionEndDate .

Cette propriété ne remplace pas la plage de remise inhérente pour une promotion. La promotion PromotionOccasion et la planification déterminent à quel moment la promotion est éligible pour être affichée dans des publicités.

Si la date de fin est déjà dépassée pour l’année en cours, chaque date de début et de fin doit être définie pour les dates de l’année suivante.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Pour supprimer la date de fin actuelle et ne définir aucune date de fin, définissez le Jour, le Mois et l’Année sur « 0 » (zéro). Lorsque vous récupérez l’extension d’annonce de promotion la prochaine fois, cet élément n’est pas défini.		 Date
PromotionItem La cible ou l’élément de promotion.

Par exemple, vous pouvez exécuter une promotion pour les « chaussures » avec une remise de 20 $ ou de 20 %. Pour exécuter une promotion pour « Jusqu’à 20 $ sur chaussures », définissez l’élément PromotionItem sur « chaussures », définissez DiscountModifier sur UpTo, définissez CurrencyCode sur « USD » et définissez MoneyAmountOff sur 20.

La chaîne peut contenir un maximum de 20 caractères.

Ajouter: Obligatoire
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié.		 chaîne
PromotionOccasion L’occasion de la promotion.

Les éléments PromotionOccasion et Planification déterminent quand la promotion est éligible pour être affichée dans des publicités.

La PromotionOccasion détermine la période ou la saisonnalité, par exemple, WomensDay du 15 février au 31 mars de chaque année. La promotion ne s’exécutera que dans les dates correspondant à l’occasion que vous définissez. Pour plus d’informations sur la plage de dates définie pour chaque occasion , consultez PromotionOccasion .

La planification peut limiter la promotion à une période plus courte dans la plage de dates de l’occasion, par exemple, limiter la promotion à s’exécuter du 20 février au 8 mars. La planification peut également être utilisée pour exécuter la même promotion plusieurs années, par exemple, exécuter la promotion WomensDay chaque année du 15 février au 31 mars.

Ajouter: Optionnel. Si vous ne spécifiez pas cet élément ou si vous le laissez vide, la valeur par défaut none est définie.
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez cet élément, PromotionStartDate et PromotionEndDate doivent également être définis pour conserver ou mettre à jour les paramètres précédents.		 PromotionOccasion
PromotionStartDate La date de début permet d’indiquer la ou les dates de promotion qui seront affichées dans l’annonce.

Par exemple, si les dates PromotionStartDate et PromotionEndDate sont toutes deux définies sur le 14 février, le texte « Valid Feb 14 » peut être inclus dans la promotion affichée.

La date PromotionStartDate doit être antérieure ou égale à la date PromotionEndDate .

Cette propriété ne remplace pas la plage de remise inhérente pour une promotion. La promotion PromotionOccasion et la planification déterminent à quel moment la promotion est éligible pour être affichée dans des publicités.

Si la date de fin est déjà dépassée pour l’année en cours, chaque date de début et de fin doit être définie pour les dates de l’année suivante.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Pour supprimer la date de fin actuelle et ne définir aucune date de fin, définissez le Jour, le Mois et l’Année sur « 0 » (zéro). Lorsque vous récupérez l’extension d’annonce de promotion la prochaine fois, cet élément n’est pas défini.		 Date
TrackingUrlTemplate Modèle de suivi à utiliser comme valeur par défaut pour tous les FinalUrls et FinalMobileUrls.

Les règles de validation suivantes s’appliquent aux modèles de suivi. Pour plus d’informations sur les modèles et paramètres pris en charge, consultez l’article d’aide Microsoft Advertising Quels paramètres de suivi ou d’URL puis-je utiliser ?
- Les modèles de suivi définis pour les entités de niveau inférieur, par exemple, les publicités remplacent celles définies pour les entités de niveau supérieur, par exemple la campagne. Pour plus d’informations, consultez Limites d’entité.
- La longueur du modèle de suivi est limitée à 2 048 caractères. La chaîne de protocole HTTP ou HTTPS compte pour la limite de 2 048 caractères.
- Le modèle de suivi doit être une URL bien formée commençant par l’une des suivantes : http://, https://, {lpurl} ou {unscapedlpurl}.
- Microsoft Advertising ne valide pas l’existence de paramètres personnalisés. Si vous utilisez des paramètres personnalisés dans votre modèle de suivi et qu’ils n’existent pas, l’URL de la page d’accueil inclut les espaces réservés de clé et de valeur de vos paramètres personnalisés sans substitution. Par exemple, si votre modèle de suivi est https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} et que ni {_season} ni {_promocode} ne sont définis au niveau de la campagne, du groupe d’annonces, du critère, du mot clé ou de la publicité, l’URL de la page d’accueil sera la même.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous définissez cet élément sur une chaîne vide («  »), le paramètre précédent est supprimé.		 chaîne
UrlCustomParameters Votre collection personnalisée de paramètres de clé et de valeur pour le suivi des URL.

Microsoft Advertising accepte les 3 premiers objets CustomParameter que vous incluez dans l’objet CustomParameters , et tous les paramètres personnalisés supplémentaires sont ignorés. Chaque CustomParameter comprend des éléments Key et Value . Pour les clients dans le pilote d’augmentation de la limite des paramètres personnalisés phase 3 (GetCustomerPilotFeatures retourne 635), Microsoft Advertising accepte les 8 premières paires clé/valeur de paramètre personnalisé que vous incluez, et si vous incluez plus de 8 paramètres personnalisés, une erreur est retournée.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Définissez l’élément UrlCustomParameters sur null ou vide pour conserver tous les paramètres personnalisés existants. Pour supprimer tous les paramètres personnalisés, définissez l’élément Parameters de l’objet CustomParameters sur null ou vide. Pour supprimer un sous-ensemble de paramètres personnalisés, spécifiez les paramètres personnalisés que vous souhaitez conserver dans l’élément Parameters de l’objet CustomParameters .		 CustomParameters

L’objet PromotionAdExtension a des éléments hérités.

Éléments hérités

Éléments hérités d’AdExtension

L’objet PromotionAdExtension dérive de l’objet AdExtension et hérite des éléments suivants : DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. Les descriptions ci-dessous sont spécifiques à PromotionAdExtension et peuvent ne pas s’appliquer à d’autres objets qui héritent des mêmes éléments de l’objet AdExtension .

Élément Description Type de données
DevicePreference Non pris en charge pour ce type d’extension d’annonce. long
ForwardCompatibilityMap Liste des chaînes de clé et de valeur pour la compatibilité avant afin d’éviter les changements cassants lorsque de nouveaux éléments sont ajoutés dans la version actuelle de l’API.

Il n’existe actuellement aucune modification de compatibilité avant pour l’objet AdExtension .

Ajouter: En lecture seule
Mettre à jour: En lecture seule		 Tableau KeyValuePairOfstringstring
Id Identificateur Microsoft Advertising unique de l’extension de publicité.

Ajouter: En lecture seule
Mettre à jour: Lecture seule et Obligatoire		 long
Planification Détermine le jour calendaire et les intervalles de temps où l’extension d’annonce peut être affichée dans des annonces.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si vous définissez cet élément null, tout jeu de planification existant pour l’extension d’annonce reste inchangé. Si vous définissez ce paramètre sur n’importe quel objet Schedule non null, vous remplacez efficacement les paramètres de planification existants pour l’extension d’annonce. Pour supprimer toutes les planifications, définissez cet élément sur un objet Schedule vide.		 Schedule
Statut Status de l’extension d’annonce. La valeur sera toujours Active , car le service Campaign Management ne retourne pas d’extensions publicitaires supprimées.

Ajouter: En lecture seule
Mettre à jour: En lecture seule		 AdExtensionStatus
Type Type de l’extension d’annonce. Cette valeur est PromotionAdExtension lorsque vous récupérez une extension d’annonce de promotion.

Ajouter: En lecture seule
Mettre à jour: En lecture seule

Pour plus d’informations sur les types d’extensions publicitaires, consultez les remarques relatives aux objets de données d’extension d’annonce.		 chaîne
Version Effectue le suivi du nombre de mises à jour de l’extension d’annonce.

La version est définie sur 1 lors de la création de l’extension d’annonce et incrémente d’un après chaque mise à jour.

Ajouter: Non autorisé
Mettre à jour: Non autorisé		 int

Configuration requise

Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13