Partager via

Migrer vers la version 13

  • Article

Notes

L’API Bing Ads version 12 prend fin le 31 octobre 2019.

Les sections ci-dessous décrivent les modifications apportées à l’API Bing Ads de la version 12 à la version 13.

Authentification pour tous les services

Le point de terminaison de la plateforme d’identités Microsoft pour les développeurs est désormais disponible. Le point de terminaison de la plateforme d’identités Microsoft autorise les comptes professionnels ou scolaires d’Azure AD et les comptes Microsoft personnels (MSA), tels que hotmail.com, outlook.com et msn.com. Le point de terminaison Live Connect autorise uniquement l’authentification avec des comptes personnels.

Bien que la migration du point de terminaison Live Connect vers le point de terminaison de la plateforme d’identités Microsoft soit indépendante de la migration de la version 12 vers la version 13, nous comprenons que de nombreux développeurs souhaitent effectuer une mise à niveau au cours du même sprint.

Importante

Le point de terminaison Live Connect n’est plus l’approche recommandée pour les utilisateurs de Microsoft Advertising. Effectuez une mise à niveau vers le point de terminaison de la plateforme d’identités Microsoft pour vous assurer que votre application peut prendre en charge tous les utilisateurs sans friction ou interruption du service. Seul le point de terminaison de la plateforme d’identités Microsoft (v2.0) vous permet d’obtenir des jetons d’accès pour authentifier les comptes professionnels et personnels via l’API Bing Ads.

Insights d’annonces

Pour obtenir une documentation de référence complète sur le service version 13, consultez Ad Insight.

Changements cassants

Proxy Client

Mettez à jour votre client proxy pour utiliser la nouvelle adresse de point de terminaison et l’espace de noms.

L’espace de noms cible est https://bingads.microsoft.com/AdInsight/v13.

Le point de terminaison de production est https://adinsight.api.bingads.microsoft.com/Api/Advertiser/AdInsight/v13/AdInsightService.svc.

Le point de terminaison du bac à sable est https ://adinsight.api.sandbox.bingads.microsoft.com/Api/Advertiser/AdInsight/v13/AdInsightService.svc.

Espace de noms de contrat de données

Auparavant, dans la version 12, l’espace de noms de contrat de données pour certaines entités était différents de l’espace de noms cible Ad Insight. Si vous avez utilisé l’un des espaces de noms de version 12 suivants, vous devez l’utiliser https://bingads.microsoft.com/AdInsight/v13 dans la version 13.

  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity.SearchParameters
  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity.Common
  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity.Criterions
  • Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity

Les clients qui encodent l’enveloppe SOAP e.g. PHP les clients qui encodent un pour DateRangeSearchParameter, vous devez effectuer une SoapVar mise à jour vers l’espace de noms cible Ad Insight Version 13, https://bingads.microsoft.com/AdInsight/v13c’est-à-dire .

Les clients du Kit de développement logiciel (SDK) Python Bing Ads devront mettre à jour plusieurs préfixes d’espace de noms pour les objets de fabrique de client SUDS , par exemple, si vous avez utilisé ns4 :DateRangeSearchParameter dans la version 12 de l’API Bing Ads, vous utiliserez DateRangeSearchParameter (sans le préfixe « ns4 ») dans la version 13. Pour plus d’informations sur la détermination du préfixe d’espace de noms, consultez Utilisation de SUDS .

Courrier en nombre

Pour obtenir une documentation de référence complète sur le service version 13, consultez Bulk.

Changements cassants

Proxy Client

Mettez à jour votre client proxy pour utiliser la nouvelle adresse de point de terminaison et l’espace de noms.

L’espace de noms cible est https://bingads.microsoft.com/CampaignManagement/v13.

Le point de terminaison de production est https://bulk.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/BulkService.svc.

Le point de terminaison du bac à sable est https://bulk.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/BulkService.svc.

Ressources d’image publicitaire réactive

Les colonnes Landscape Image Media Id, Landscape Logo Media Id, Square Image Media ID et Square Logo Media ID sont déconseillées de l’enregistrement De l’annonce réactive . Ils seront toujours visibles dans le fichier de téléchargement, bien qu’étant donné qu’ils seront supprimés dans une version ultérieure, vous ne devriez pas prendre de dépendances sur ces colonnes. Utilisez plutôt la colonne Images .

Données de performances d’entité

Le téléchargement en bloc des données de performances a été précédemment mis à jour dans la version 12. Désormais, dans la version 13, la valeur EntityPerformanceData du jeu de valeurs DataScope est supprimée du contrat de service. En outre, les objets Date et PerformanceStatsDateRange et la valeur ReportTimePeriod sont supprimés Si vous souhaitez que les données soient agrégées par jour, semaine ou mois, vous pouvez utiliser l’API de création de rapports. Pour plus d’informations, consultez Guides de l’API de création de rapports.

Gestion des campagnes

Pour obtenir une documentation de référence complète sur le service version 13, consultez Gestion des campagnes.

Changements cassants

Proxy Client

Mettez à jour votre client proxy pour utiliser la nouvelle adresse de point de terminaison et l’espace de noms.

L’espace de noms cible est https://bingads.microsoft.com/CampaignManagement/v13.

Le point de terminaison de production est https://campaign.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/CampaignManagementService.svc.

Le point de terminaison du bac à sable est https://campaign.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/CampaignManagementService.svc.

Ressources d’image publicitaire réactive

Les éléments LandscapeImageMediaId, LandscapeLogoMediaId, SquareImageMediaId et SquareLogoMediaId sont supprimés de l’objet ResponsiveAd . Vous devez utiliser l’élément Images à la place.

Ressources de texte d’annonce réactive

Si vous avez utilisé l’élément de chaîne LongHeadline dans la version 12, vous devez utiliser l’élément LongHeadlineString (string) dans la version 13. Le type de données de LongHeadline est mis à jour de string vers AssetLink. Ce lien de ressource est réservé pour une utilisation ultérieure.

Les listes de liens de ressources Titres et Descriptions sont ajoutées pour une utilisation ultérieure.

Pagination par défaut pour GetMediaMetaDataByAccountId

Si l’élément PageInfo n’est pas défini lorsque vous appelez l’opération GetMediaMetaDataByAccountId , l’index de page de défaut est 0 et la valeur par défaut Size est 1 000. Dans la version 12, si PageInfo n’a pas été défini, toutes les métadonnées de média du compte sont retournées.

Critère Enchère ignorée pour un type de données non valide

Pour les versions 12 et 13 lors de l’ajout et de la mise à jour d’un BiddableCampaignCriterion, les exigences de type d’objet CriterionBid dérivées varient en fonction du contexte du type d’objet Criterion dérivé avec lequel il est associé. Par exemple, si le critère hérité est un critère ProductScope , vous devez utiliser un objet FixedBid (et non un BidMultiplier).

Dans la version 13, si vous n’utilisez pas l’objet Critère correct, votre enchère demandée est ignorée : si l’enchère est requise, l’opération échoue ; Si l’enchère est facultative, l’enchère par défaut est utilisée.

Dans la version 12, si vous n’utilisez pas l’objet Critère correct, votre enchère demandée aurait été honorée ; Toutefois, lorsque vous récupérez l’objet ultérieurement, le type correct est retourné. En d’autres termes, le type de données que vous définissez n’est pas le même que le type de données récupéré.

Ce changement de la version 12 à la version 13 s’applique uniquement aux critères biddables au niveau de la campagne. Pour les critères de groupe d’annonces biddable version 12 et 13, si vous n’utilisez pas l’objet Critère correct, votre enchère demandée sera ignorée : si l’enchère est requise, l’opération échoue ; Si l’enchère est facultative, l’enchère par défaut est utilisée.

Enchère de mot clé facultative

Lorsque vous appelez l’opération AddKeywords , l’élément Bid du mot clé est facultatif. Auparavant dans la version 12, l’enchère était requise pour ajouter des mots clés. Si vous souhaitez hériter de l’enchère de groupe d’annonces par défaut pour le mot clé et le type de correspondance, vous pouvez laisser l’enchère de mot clé vide.

Type de correspondance de mot clé négatif

L’élément MatchType de NegativeKeyword est nillable. Si vous aviez précédemment pris une dépendance sur la valeur MatchType par défaut dans la version 12, c’est-à-dire Exact, vous devez définir explicitement cet élément requis dans la version 13.

Source des annonces de recherche dynamique

L’élément Source de DynamicSearchAdsSetting est nillable. L’élément IncludeDynamicSearchAdsSource est supprimé des messages de demande AddCampaigns et UpdateCampaigns . Si vous êtes activé pour les flux de page, dans la version 13, vous pouvez définir la source.

Description de la campagne

L’élément Description est supprimé de l’objet Campaign . Vous pouvez toujours utiliser l’élément Name pour fournir un nom de campagne unique.

Retourner des champs supplémentaires

L’élément ReturnAdditionalFields est supprimé de GetAdExtensionsAssociations, GetAdExtensionsByIds, GetAdGroupCriterionsByIds, GetAdGroupsByCampaignId, GetAdGroupsByIds, GetAdsByAdGroupId, GetAdsByEditorialStatus, GetAdsByIds, GetCampaignsByAccountId, GetCampaignsByIds, GetKeywordsByAdGroupId, GetKeywordsByEditorialStatus, et Messages de demande GetKeywordsByIds . Tous les éléments de chaque annonce, extension de publicité, groupe d’annonces, critère de groupe d’annonces biddable, campagne et mot clé sont retournés par défaut.

En parallèle, les jeux de valeurs AdAdditionalField, AdExtensionAdditionalField, AdGroupAdditionalField, AdGroupCriterionAdditionalField, CampaignAdditionalField et KeywordAdditionalField associés sont supprimés.

Migration cible terminée

La migration d’une cible partagée vers des critères de campagne exclusive et de cible de groupe d’annonces a été effectuée précédemment. L’élément IsMigrated est désormais supprimé de la réponse des opérations AddAdGroupCriterions, UpdateAdGroupCriterions, AddCampaignCriterions et UpdateCampaignCriterions .

Nouvelles fonctionnalités

Nouveaux types de stratégie d’enchère

Les types de stratégie d’enchère MaxRoasBiddingScheme et TargetRoasBiddingScheme sont ajoutés pour une utilisation ultérieure dans la version 13.

Partage client

L’élément CustomerShare est ajouté aux objets Audience et UetTag . Cet élément est réservé pour une utilisation ultérieure.

Objectif de conversion Exclure des enchères

L’élément ExcludeFromBidding est ajouté à l’objet ConversionGoal . Cet élément est réservé pour une utilisation ultérieure.

Facturation des clients

Pour obtenir une documentation de référence complète sur le service version 13, consultez Facturation client.

Changements cassants

Proxy Client

Mettez à jour votre client proxy pour utiliser la nouvelle adresse de point de terminaison et l’espace de noms.

L’espace de noms cible est https://bingads.microsoft.com/Billing/v13.

Le point de terminaison de production est https://clientcenter.api.bingads.microsoft.com/Api/Billing/v13/CustomerBillingService.svc.

Le point de terminaison du bac à sable est https://clientcenter.api.sandbox.bingads.microsoft.com/Api/Billing/v13/CustomerBillingService.svc.

Objet Ordre d’insertion

Plusieurs propriétés sont ajoutées à l’objet InsertionOrder .

L’élément BalanceAmount est supprimé et remplacé par l’élément BudgetRemaining.

GetInsertionOrdersByAccount est supprimé

L’opération GetInsertionOrdersByAccount est supprimée. Vous pouvez utiliser SearchInsertionOrders dans la version 13.

Gestion des clients

Pour obtenir une documentation de référence complète sur le service version 13, consultez Gestion des clients.

Changements cassants

Proxy Client

Mettez à jour votre client proxy pour utiliser la nouvelle adresse de point de terminaison et l’espace de noms.

L’espace de noms cible est https://bingads.microsoft.com/Customer/v13.

Le point de terminaison de production est https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc.

Le point de terminaison du bac à sable est https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc.

Plusieurs modifications sont apportées à l’objet ClientLink .

Adresse du client

Dans la version 13, l’élément CustomerAddress est inclus dans tous les objets Customer retournés par défaut. Vous n’avez pas besoin de demander explicitement cet élément. L’élément IncludeCustomerAddress est supprimé des messages de demande GetCustomer et SearchCustomers.

ID de compte lié

Dans la version 13, l’élément LinkedAccountIds est inclus dans tous les objets CustomerRole retournés par défaut. Vous n’avez pas besoin de demander explicitement cet élément. L’élément IncludeLinkedAccountIds est supprimé du message de requête GetUser .

Informations fiscales pour l’Australie et le Brésil

Les clés TaxId et TaxType ne sont plus disponibles lorsque vous définissez le compte TaxInformation pour l’Australie et le Brésil. Pour l’Australie, utilisez AUGSTNumber comme clé et définissez la valeur sur votre identificateur fiscal. Pour le Brésil, les clés possibles sont CCM, CPF et CNPJ.

Description Version 12 Version 13
Comptes en Australie TaxId=YourTaxId AUGSTNumber=YourTaxId
Comptes d’entreprise au Brésil TaxId=YourTaxId ; TaxType=Business CPNJ=YourTaxId
Comptes personnels au Brésil TaxId=YourTaxId ; TaxType=Personal CPF=YourTaxId

Pour les comptes d’entreprise dans la ville de Sao Paulo, brésil, il n’y a aucune modification de la clé CCM entre les versions 12 et 13.

Nouvelles fonctionnalités

Autorisation de liaison de rôle client

L’élément CustomerLinkPermission est ajouté à l’objet CustomerRole . Cet élément est réservé pour une utilisation ultérieure.

Reporting

Pour obtenir une documentation de référence complète sur le service version 13, consultez Création de rapports.

Changements cassants

Proxy Client

Mettez à jour votre client proxy pour utiliser la nouvelle adresse de point de terminaison et l’espace de noms.

L’espace de noms cible est https://bingads.microsoft.com/Reporting/v13.

Le point de terminaison de production est https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.

Le point de terminaison du bac à sable est https://reporting.api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.

Colonnes requises pour ProductMatchCountReportRequest

Les colonnes requises sont mises à jour lors de l’envoi du ProductMatchCountReportRequest. Dans la version 13, les colonnes AccountName, CampaignName, MatchedProductsAtProductGroup et ProductGroup sont requises.

Précédemment dans la version 12, en plus des exigences AccountName et CampaignName, une ou plusieurs des colonnes de statistiques de performances MatchedProductsAtAdGroup, MatchedProductsAtCampaign ou MatchedProductsAtProductGroup étaient requises.

Filtre de rapport de langue

Le jeu de valeurs LanguageReportFilter est ajouté. L’élément LanguageCode (string) est remplacé par l’élément Languages (LanguageReportFilter) dans les filtres de rapport suivants.

Rapport sur toutes les conversions et le chiffre d’affaires pour les objectifs

Les colonnes Conversions et Revenue dans GoalsAndFunnelsReportColumn sont respectivement renommées AllConversions et AllRevenue . La signification des données n’a pas changé de la version 12 à la version 13.

En-têtes de rapport français

La prise en charge du téléchargement d’un rapport avec des en-têtes en français est supprimée. Seuls les en-têtes anglais sont pris en charge dans la version 13. L’élément Language est supprimé de l’objet ReportRequest et le jeu de valeurs ReportLanguage est supprimé.

Suppression de AgeGenderDemographicReportRequest

AgeGenderDemographicReportRequest est supprimé. Au lieu de cela, vous pouvez utiliser ageGenderAudienceReportRequest.

Type de campagne de recherche

Pour les campagnes de recherche, les données retournées dans la colonne CampaignType sont « Search ». Dans la version 12, la valeur retournée était « Rechercher & contenu ». La colonne CampaignType est disponible via les jeux de valeurs AdGroupPerformanceReportColumn, AdPerformanceReportColumn, CampaignPerformanceReportColumn et SearchQueryPerformanceReportColumn .

Format des données du groupe de produits

Le format des données retournées dans la colonne ProductGroup est mis à jour.

Version Description Exemple
12 Utilise « \ » (barre oblique descendante) pour délimiter les niveaux.

Les valeurs d’attribut ne sont pas entourées de « » (guillemets doubles).

Le niveau de catégorie est ajouté aux valeurs d’attribut, le cas échéant, par exemple, « (1er niveau) », « (2e niveau) », etc.		 * \ Category=Animals & Pet Supplies(1st Level) \ Category=Pet Supplies(2nd Level) \ Category=Bird Supplies(3rd Level)
13 Utilise « / » (barre oblique) pour délimiter les niveaux.

Les valeurs d’attribut sont entourées de « » (guillemets doubles).

N’indique pas le niveau de catégorie, par exemple, « (1er niveau) » est supprimé.		 * / Category="Animals & Pet Supplies » / Category="Pet Supplies » / Category="Bird Supplies »

Cette modification s’applique à la colonne ProductGroup via les jeux de valeurs suivants.

Tiret pour le score de qualité non disponible

Dans la version 13, si le score de qualité n’a pas été calculé, les données retournées sont « -- » (tiret double) dans les colonnes AdRelevance, ExpectedCtr, HistoricalAdRelevance, HistoricalExpectedCtr, HistoricalLandingPageExperience, HistoricalQualityScore, LandingPageExperience et QualityScore. Dans la version 12, la valeur « 0 » (zéro) avait été retournée. Ces colonnes sont disponibles dans les ensembles de valeurs AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn, KeywordPerformanceReportColumn et ShareOfVoiceReportColumn .

Colonnes de partage d’impression remplacées

Les colonnes ImpressionLostToAdRelevancePercent, ImpressionLostToBidPercent, ImpressionLostToExpectedCtrPercent, ImpressionLostToRelevancePercent et ImpressionLostToRankPercent sont supprimées des jeux de valeurs AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn et ShareOfVoiceReportColumn .

Dans la version 13, les données qui avaient été fractionnées entre ces colonnes de la version 12 sont agrégées et disponibles via la colonne ImpressionLostToRankAggPercent, qui prend tous ces facteurs en compte lors du calcul de l’impression perdue pour le pourcentage de classement.

Suppression des colonnes AverageCpp, ClickCalls et ManualCalls

Les colonnes AverageCpp, ClickCalls et ManualCalls sont supprimées des jeux de valeurs AccountPerformanceReportColumn, AdGroupPerformanceReportColumn et CampaignPerformanceReportColumn .

Suppression des colonnes CallStatus et CallTypeName

Les colonnes CallStatus et CallTypeName sont supprimées du jeu de valeurs CallDetailReportColumn . Microsoft Advertising a cessé de facturer les appels manuels à un numéro suivi le 12 mars 2014.

Exiger l’étendue du compte, de la campagne ou du groupe d’annonces

Dans la version 13, vous devez limiter la demande à des comptes, des campagnes ou des groupes d’annonces spécifiques. Par exemple, vous pouvez inclure jusqu’à 1 000 comptes, 300 campagnes ou 300 groupes d’annonces via AccountThroughAdGroupReportScope. Auparavant, dans la version 12, vous pouviez laisser l’étendue du rapport null pour certains types de rapports, et les données étaient retournées pour tous les comptes auxquels vous pouviez accéder.