Partager via

Objet de données VideoAdExtension - Gestion des campagnes

  • Article

Définit une extension d’annonce avec une vidéo et un bouton d’appel à l’action.

Syntaxe

<xs:complexType name="VideoAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="ActionText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q66="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q66:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q67="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q67:ArrayOfstring" />
        <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ThumbnailId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="ThumbnailUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
        <xs:element minOccurs="0" name="VideoId" nillable="true" type="xs:long" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Éléments

L’objet VideoAdExtension contient les éléments suivants : ActionText, AlternativeText, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Name, ThumbnailId, ThumbnailUrl, TrackingUrlTemplate, UrlCustomParameters, VideoId.

Élément Description Type de données
ActionText Texte de l’action de la ressource vidéo. chaîne
AlternativeText Texte de remplacement de la ressource vidéo. chaîne
DisplayText Texte d’affichage de la ressource vidéo. 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
Nom Nom de la ressource vidéo. chaîne
ThumbnailId ID de la ressource miniature. long
ThumbnailUrl URL miniature de la ressource vidéo.

Ajouter : non pris en charge
Mise à jour : non pris en charge		 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 vous définissez cet élément null, 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 8 premiers objets CustomParameter que vous incluez dans l’objet CustomParameters , et si vous incluez plus de 8 paramètres personnalisés, une erreur est retournée. 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 vous définissez cet élément null, le paramètre précédent est supprimé.		 CustomParameters
VideoId ID de la vidéo. long

L’objet VideoAdExtension contient des éléments hérités.

Éléments hérités

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

L’objet VideoAdExtension 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 à VideoAdExtension 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 Cet élément détermine si la préférence est que l’extension d’annonce s’affiche sur les appareils mobiles ou sur tous les appareils.

Pour spécifier une préférence pour les appareils mobiles, définissez cet élément sur 30001.

Pour spécifier tous les appareils, définissez cet élément sur 0 (zéro) ou laissez l’élément zéro. Par défaut, cet élément est nul.

Cet élément s’applique uniquement aux types AppAdExtension et SitelinkAdExtension .		 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.

Les modifications de compatibilité avant seront notées ici dans les versions ultérieures. Il n’existe actuellement aucune modification de compatibilité avant pour cet objet.		 Tableau KeyValuePairOfstringstring
Id Identificateur Microsoft Advertising unique de l’extension de publicité. long
Planification Détermine le jour calendaire et les intervalles de temps où l’extension d’annonce peut être affichée dans des annonces. 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. AdExtensionStatus
Type Type d’extension d’annonce.

Pour plus d’informations, consultez Remarques.		 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.		 int

Configuration requise

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