Partager via

Objet de données FlyerAdExtension - Gestion des campagnes

  • Article

Les extensions de flyer permettent aux annonceurs de distribuer des catalogues de produits ou de magasins (flyers) à des clients potentiels.

Ils peuvent s’afficher en évidence sur des requêtes étendues telles que les « offres hebdomadaires » ou les « ventes hebdomadaires » et donc encourager les acheteurs à cliquer sur votre annonce au lieu de celle de la concurrence. De par leur nature, ils aident à mieux informer les personnes qui recherchent et, par conséquent, à augmenter l’engagement des utilisateurs, par exemple, le taux de clics.

Remarque

Les extensions Flyer sont disponibles pour les clients dans le pilote de fonctionnalité (GetCustomerPilotFeatures retourne 802).

Syntaxe

<xs:complexType name="FlyerAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q62="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q62:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q63="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q63:ArrayOfstring" />
        <xs:element minOccurs="0" name="FlyerName" nillable="true" type="xs:string" />
        <xs:element xmlns:q64="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q64:ArrayOflong" />
        <xs:element xmlns:q65="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaUrls" nillable="true" type="q65:ArrayOfstring" />
        <xs:element minOccurs="0" name="StoreId" nillable="true" type="xs:long" />
        <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 FlyerAdExtension contient les éléments suivants : Description, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, FlyerName, ImageMediaIds, ImageMediaUrls, StoreId, TrackingUrlTemplate, UrlCustomParameters.

Élément Description Type de données
Description Description qui peut être utilisée par l’annonceur, l’agence ou le responsable de compte pour suivre, étiqueter ou gérer les extensions de prospectus.

Cette description n’est pas affichée avec l’annonce ou l’image.

La longueur maximale de cet élément est de 1 024 caractères.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié.		 chaîne
FinalAppUrls Réservé à une utilisation future. 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é.		 chaîne
FlyerName Nom du flyer.

La longueur maximale de cet élément est de 150 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
ImageMediaIds Identificateur de l’image à inclure dans l’annonce.

Vous ne pouvez définir qu’un seul ID de média. Le type de données est une liste de valeurs longues au cas où la prise en charge de plusieurs images est ajoutée ultérieurement.

Chaque ID de média correspond à une Image du sous-type Média « GenericImage ».

Vous pouvez obtenir l’identificateur de chaque image lorsque vous les ajoutez à la bibliothèque d’images en appelant l’opération AddMedia . Sinon, une fois le média ajouté à votre bibliothèque d’images, vous pouvez obtenir les identificateurs multimédias avec l’opération GetMediaMetaDataByAccountId . L’image doit avoir une largeur et une hauteur minimales de 220 px et une taille de fichier maximale de 3,9 Mo.

Ajouter: Obligatoire
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié.		 tableau long
ImageMediaUrls URL du média que vous avez déjà ajouté.

Ajouter: En lecture seule
Mettre à jour: En lecture seule		 tableau de chaînes
StoreId Identificateur unique d’un magasin Microsoft Merchant Center utilisé pour les annonces de produits.

Ajouter: Optionnel
Mettre à jour: En lecture seule. Vous ne pouvez pas mettre à jour l’ID du magasin une fois qu’il a été défini.		 long
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 FlyerAdExtension contient des éléments hérités.

Éléments hérités

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

L’objet FlyerAdExtension 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 à FlyerAdExtension 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. La date de fin doit être dans les 30 jours suivant la date de début.

Ajouter: Les planifications StartDate et EndDate sont requises pour les extensions publicitaires de flyer.
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. Vous ne pouvez pas définir cet élément sur un objet Schedule vide, car cela tenterait de supprimer toute la planification. Cela entraînerait une erreur, car StartDate et EndDate sont requis pour les extensions publicitaires de flyer.		 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 FlyerAdExtension lorsque vous récupérez une extension publicitaire de flyer.

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