Partager via

Objet de données ImageAdExtension - Gestion des campagnes

  • Article

Définit une extension d’annonce qui spécifie une image avec un texte de remplacement à inclure dans une annonce de texte développé.

Vous pouvez associer une extension d’image publicitaire au compte ou à des campagnes et des groupes d’annonces dans le compte. Pour chaque compte, seuls 1 000 campagnes et 1 000 groupes d’annonces peuvent être associés à des extensions d’annonce d’image. Chaque entité (compte, campagne ou groupe d’annonces) peut être associée à jusqu’à 6 extensions publicitaires d’image.

Syntaxe

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

Éléments

L’objet ImageAdExtension contient les éléments suivants : AlternativeText, Description, DestinationUrl, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, ImageMediaIds, Images, Layouts, SourceType, TrackingUrlTemplate, UrlCustomParameters.

Élément Description Type de données
AlternativeText Autre description du support d’image pour plus de facilité d’utilisation. Si l’image n’a pas pu être affichée, le texte de remplacement est utilisé à la place.

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

Ajouter: Obligatoire
Mettre à jour: Obligatoire		 chaîne
Description Description qui peut être utilisée par l’annonceur, l’agence ou le responsable de compte pour suivre, étiqueter ou gérer les médias d’image.

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

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

Ajouter: Optionnel
Mettre à jour: Optionnel. Si vous définissez cet élément null, le paramètre précédent est supprimé.		 chaîne
DestinationUrl URL de la page web vers laquelle l’utilisateur doit se connecter lorsqu’il clique sur l’image.

L’URL peut contenir des chaînes de texte dynamiques telles que {mot clé}. Pour plus d’informations, consultez Quels paramètres de suivi ou d’URL puis-je utiliser ?.

L’URL peut contenir un maximum de 1 024 caractères. Si l’URL ne spécifie pas de protocole, le système utilise le protocole HTTP lorsqu’un utilisateur clique sur la publicité. Si l’URL spécifie le protocole HTTP lorsque vous ajoutez une publicité, le service supprime la chaîne de protocole http:// (la chaîne de protocole HTTP ne compte pas dans la limite de 1 024 caractères) ; Toutefois, le service ne supprime pas de chaîne de protocole HTTPS (https://) de l’URL.

Si l’URL n’est pas spécifiée pour l’extension d’annonce d’image, l’URL de la publicité est utilisée.

Ajouter: Optionnel
Mettre à jour: Optionnel. Si vous définissez cet élément null, le paramètre précédent est supprimé.		 chaîne
DisplayText Texte d’affichage de votre extension d’image.

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

Ajouter: Obligatoire lorsque Layouts contient SearchMultiple, sinon Facultatif.
Mettre à jour: Obligatoire lorsque Layouts contient SearchMultiple, sinon Facultatif. Si vous définissez cet élément null, le paramètre précédent est supprimé.		 chaîne
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.
- Vous ne pouvez pas spécifier FinalMobileUrls si DevicePreference est défini sur 30001 (mobile).

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, 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.
- Vous ne pouvez pas spécifier FinalMobileUrls si DevicePreference est défini sur 30001 (mobile).

Ajouter: Optionnel
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, le paramètre précédent est supprimé.		 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, le paramètre précédent est supprimé.		 chaîne
ImageMediaIds Identificateurs des images à inclure dans l’annonce. Vous ne pouvez pas spécifier d’identificateurs de média pour plusieurs images des mêmes proportions. En d’autres termes, chacune des images référencées doit avoir des proportions différentes.

Vous pouvez spécifier jusqu’à quatre (4) identificateurs de média d’image. Bien que le minimum requis soit un ID de média d’image, pour pouvoir bénéficier de tous les placements publicitaires, vous devez fournir quatre identificateurs de média d’image, où chaque ID correspond à une image de l’un des quatre types de médias pris en charge (proportions). Les proportions prises en charge pour les publicités d’audience sont 16:9, 1.5:1, 4:3 et 1.2:1. Pour plus d’informations, consultez la documentation de référence sur l’objet de données Image .

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 .

Ajouter: Obligatoire
Mettre à jour: Obligatoire		 tableau long
Images Ressources d’image avec des tailles et des proportions différentes afin qu’elles puissent s’afficher de manière flexible sur une variété d’éditeurs et de placements.

Incluez un ou plusieurs objets AssetLink qui contiennent chacun un Objet ImageAsset avec des paramètres SubType et rognage qui correspondent aux proportions souhaitées.

Ajouter: Obligatoire
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous incluez des images pendant la mise à jour, toutes les images précédemment définies seront remplacées.		 Tableau AssetLink
Dispositions Liste des dispositions d’image éligibles.

Les valeurs prises en charge sont SearchSingle et SearchMultiple. De nouvelles dispositions étant susceptibles d’être ajoutées à l’avenir, vous ne devez pas dépendre d’un ensemble fixe de valeurs.

Ajouter: Obligatoire
Mettre à jour: Optionnel. Si aucune valeur n’est définie pour la mise à jour, ce paramètre n’est pas modifié. Si vous incluez des dispositions pendant la mise à jour, toutes les dispositions précédemment définies sont remplacées.		 tableau de chaînes
SourceType Le type de la source. chaîne
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, 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, le paramètre précédent est supprimé.		 CustomParameters

L’objet ImageAdExtension possède des éléments hérités.

Éléments hérités

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

L’objet ImageAdExtension 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 à ImageAdExtension 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 ImageAdExtension lorsque vous récupérez une extension d’annonce d’image.

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