Migrieren zu Version 13
Hinweis
Version 12 der Bing Ads-API endet am 31. Oktober 2019.
In den folgenden Abschnitten werden Änderungen der Bing Ads-API von Version 12 zu Version 13 beschrieben.
Authentifizierung für alle Dienste
Der Microsoft Identity Platform-Endpunkt für Entwickler ist jetzt verfügbar. Der Microsoft Identity Platform-Endpunkt ermöglicht sowohl Geschäfts-, Schul- oder Unikonten von Azure AD als auch persönliche Microsoft-Konten (MSA), z. B. hotmail.com, outlook.com und msn.com. Der Live Connect-Endpunkt lässt nur die Authentifizierung mit persönlichen Konten zu.
Obwohl die Migration vom Live Connect-Endpunkt zum Microsoft Identity Platform-Endpunkt unabhängig von der Migration von Version 12 zu Version 13 ist, wissen wir, dass viele Entwickler ein Upgrade während desselben Sprints durchführen möchten.
Wichtig
Der Live Connect-Endpunkt ist nicht mehr der empfohlene Ansatz für Microsoft Advertising-Benutzer. Führen Sie ein Upgrade auf den Microsoft Identity Platform-Endpunkt durch, um sicherzustellen, dass Ihre Anwendung alle Benutzer ohne Reibung oder Unterbrechung des Diensts unterstützen kann. Nur der Microsoft Identity Platform-Endpunkt (v2.0) ermöglicht es Ihnen, Zugriffstoken zum Authentifizieren von Geschäftlichen und persönlichen Konten über die Bing Ads-API abzurufen.
Ad Insight
Eine umfassende Referenzdokumentation zur Dienstversion 13 finden Sie unter Ad Insight.
Breaking Changes
Proxyclient
Aktualisieren Sie Ihren Proxyclient so, dass er die neue Endpunktadresse und den neuen Namespace verwendet.
Der Zielnamespace ist https://bingads.microsoft.com/AdInsight/v13
.
Der Produktionsendpunkt ist https://adinsight.api.bingads.microsoft.com/Api/Advertiser/AdInsight/v13/AdInsightService.svc.
Der Sandboxendpunkt ist https://adinsight.api.sandbox.bingads.microsoft.com/Api/Advertiser/AdInsight/v13/AdInsightService.svc.
Datenvertragsnamespace
Zuvor in Version 12 war der Datenvertragsnamespace für einige Entitäten vom Ad Insight-Zielnamespace abgekommen. Wenn Sie einen der folgenden Namespaces der Version 12 verwendet haben, müssen Sie die Verwendung in Version 13 nicht mehr verwenden https://bingads.microsoft.com/AdInsight/v13
.
- 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
Clients, die den SOAP-Umschlag e.g. PHP Clients codieren, die einen SoapVar
für DateRangeSearchParameter codieren, müssen Sie auf den Ad Insight Version 13-Zielnamespace aktualisieren, https://bingads.microsoft.com/AdInsight/v13
d. h. .
Bing Ads Python SDK-Clients müssen mehrere Namespacepräfixe für die SUDS-Clientfactoryobjekte aktualisieren. Wenn Sie z. B. ns4:DateRangeSearchParameter in Version 12 der Bing Ads-API verwendet haben, verwenden Sie DateRangeSearchParameter (ohne das Präfix "ns4") in Version 13. Ausführliche Informationen zum Bestimmen des Namespacepräfixes finden Sie unter Verwenden von SUDS .
Masse
Eine umfassende Referenzdokumentation zur Dienstversion 13 finden Sie unter Bulk.
Breaking Changes
Proxyclient
Aktualisieren Sie Ihren Proxyclient so, dass er die neue Endpunktadresse und den neuen Namespace verwendet.
Der Zielnamespace ist https://bingads.microsoft.com/CampaignManagement/v13
.
Der Produktionsendpunkt ist https://bulk.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/BulkService.svc.
Der Sandboxendpunkt ist https://bulk.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/BulkService.svc.
Responsive Ad Image Assets
Die Spalten Querformat-Medien-ID, Querformat-Logo-Medien-ID, Quadratische Bildmedien-ID und Quadrat-Logo-Medien-ID sind aus dem Responsive Ad-Datensatz veraltet. Sie sind weiterhin in der Downloaddatei sichtbar, obwohl sie in einer zukünftigen Version entfernt werden, sollten Sie keine Abhängigkeiten von diesen Spalten annehmen. Verwenden Sie stattdessen die Spalte Bilder .
Entitätsleistungsdaten
Der Massendownload von Leistungsdaten wurde zuvor in Version 12 beendet. In Version 13 wird nun der EntityPerformanceData-Wert des DataScope-Wertsatzes aus dem Dienstvertrag entfernt. Außerdem werden die Date - und PerformanceStatsDateRange-Objekte und der ReportTimePeriod-Wertsatz entfernt. Wenn Daten nach Tag, Woche oder Monat aggregiert werden sollen, können Sie die Berichterstellungs-API verwenden. Weitere Informationen finden Sie unter Anleitungen zur Berichterstellungs-API.
Kampagnenmanagement
Eine umfassende Referenzdokumentation zur Dienstversion 13 finden Sie unter Kampagnenverwaltung.
Breaking Changes
Proxyclient
Aktualisieren Sie Ihren Proxyclient so, dass er die neue Endpunktadresse und den neuen Namespace verwendet.
Der Zielnamespace ist https://bingads.microsoft.com/CampaignManagement/v13
.
Der Produktionsendpunkt ist https://campaign.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/CampaignManagementService.svc.
Der Sandboxendpunkt ist https://campaign.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v13/CampaignManagementService.svc.
Responsive Ad Image Assets
Die Elemente LandscapeImageMediaId, LandscapeLogoMediaId, SquareImageMediaId und SquareLogoMediaId werden aus dem ResponsiveAd-Objekt entfernt. Sie müssen stattdessen das Images-Element verwenden.
Reaktionsfähige Anzeigentextobjekte
Wenn Sie das LongHeadline-Zeichenfolgenelement in Version 12 verwendet haben, sollten Sie das LongHeadlineString-Element (string) in Version 13 verwenden. Der Datentyp von LongHeadline wird von string in AssetLink aktualisiert. Dieser Ressourcenlink ist für die zukünftige Verwendung reserviert.
Die Ressourcenlinklisten "Überschriften " und " Beschreibungen " werden zur zukünftigen Verwendung hinzugefügt.
Standard paging für GetMediaMetaDataByAccountId
Wenn das PageInfo-Element beim Aufrufen des GetMediaMetaDataByAccountId-Vorgangs nicht festgelegt wird, ist der Index der defaut-Seite 0, und die Standardgröße ist 1.000. Wenn PageInfo in Version 12 nicht festgelegt wurde, werden alle Medienmetadaten im Konto zurückgegeben.
Kriteriumgebot für ungültigen Datentyp ignoriert
Sowohl für Version 12 als auch für Version 13 beim Hinzufügen und Aktualisieren eines BiddableCampaignCriterion-Objekts variieren die Anforderungen des abgeleiteten CriterionBid-Objekttyps je nach Kontext des abgeleiteten Criterion-Objekttyps , mit dem er gekoppelt ist. Wenn das geerbte Kriterium beispielsweise ein ProductScope-Kriterium ist, sollten Sie ein FixedBid-Objekt (kein BidMultiplier) verwenden.
Wenn Sie in Version 13 nicht das richtige Criterion-Objekt verwenden, wird Das angeforderte Gebot ignoriert: Wenn das Gebot erforderlich ist, schlägt der Vorgang fehl; Wenn das Gebot optional ist, wird das Standardgebot verwendet.
Wenn Sie in Version 12 nicht das richtige Criterion-Objekt verwenden, wäre Ihr angefordertes Gebot berücksichtigt worden; Wenn Sie das Objekt später abrufen, wird jedoch der richtige Typ zurückgegeben. Anders ausgedrückt: Der von Ihnen festgelegte Datentyp ist nicht mit dem abgerufenen Datentyp identisch.
Diese Änderung von Version 12 zu Version 13 gilt nur für gebotsfähige Kriterien auf Kampagnenebene. Wenn Sie nicht das richtige Criterion-Objekt verwenden, wird das angeforderte Gebot für die Version 12 und 13 ignoriert: Wenn das Gebot erforderlich ist, schlägt der Vorgang fehl; Wenn das Gebot optional ist, wird das Standardgebot verwendet.
Optionales Schlüsselwortgebot
Wenn Sie den AddKeywords-Vorgang aufrufen, ist das Bid-Element des Schlüsselworts optional. Zuvor war in Version 12 das Gebot erforderlich, um Schlüsselwörter hinzuzufügen. Wenn Sie das Standardmäßige Anzeigengruppengebot für das Schlüsselwort und den Übereinstimmungstyp erben möchten, können Sie das Schlüsselwortgebot leer lassen.
Negativer Schlüsselwort-Übereinstimmungstyp
Das MatchType-Element von NegativeKeyword kann nicht aktiviert werden. Wenn Sie zuvor eine Abhängigkeit vom Standardmäßigen MatchType-Wert in Version 12 ( Exact) übernommen haben, müssen Sie dieses erforderliche Element explizit in Version 13 festlegen.
Quelle für dynamische Suchanzeigen
Das Source-Element von DynamicSearchAdsSetting ist nillable. Das IncludeDynamicSearchAdsSource-Element wird aus den Anforderungsmeldungen AddCampaigns und UpdateCampaigns entfernt. Wenn Sie für Seitenfeeds aktiviert sind, können Sie in Version 13 die Quelle festlegen.
Kampagnenbeschreibung
Das Description-Element wird aus dem Campaign-Objekt entfernt. Sie können weiterhin das Name-Element verwenden, um einen eindeutigen Kampagnennamen anzugeben.
Zusätzliche Felder zurückgeben
Das ReturnAdditionalFields-Element wird aus getAdExtensionsAssociations entfernt. GetAdExtensionsByIds, GetAdGroupCriterionsByIds, GetAdGroupsByCampaignId, GetAdGroupsByIds, GetAdsByAdGroupId, GetAdsByEditorialStatus, GetAdsByIds, GetCampaignsByAccountId, GetCampaignsByIds, GetKeywordsByAdGroupId, GetKeywordsByEditorialStatus und GetKeywordsByIds-Anforderungsnachrichten . Alle Elemente jeder Anzeige, Anzeigenerweiterung, Anzeigengruppe, gebotsfähiges Anzeigengruppenkriterium, Kampagne und Schlüsselwort werden standardmäßig zurückgegeben.
Parallel dazu werden die zugehörigen Wertesätze AdAdditionalField, AdExtensionAdditionalField, AdGroupAdditionalField, AdGroupCriterionAdditionalField, CampaignAdditionalField und KeywordAdditionalField entfernt.
Zielmigration abgeschlossen
Die Migration von einem gemeinsamen Ziel zu exklusiven Kampagnen- und Anzeigengruppenzielkriterien wurde zuvor abgeschlossen. Das IsMigrated-Element wird jetzt aus der Antwort der Vorgänge AddAdGroupCriterions, UpdateAdGroupCriterions, AddCampaignCriterions und UpdateCampaignCriterions entfernt.
Neue Features
Neue Gebotsstrategietypen
Die Gebotsstrategietypen MaxRoasBiddingScheme und TargetRoasBiddingScheme werden zur zukünftigen Verwendung in Version 13 hinzugefügt.
Kundenfreigabe
Das CustomerShare-Element wird den Objekten Audience und UetTag hinzugefügt. Dieses Element ist für die zukünftige Verwendung reserviert.
Konvertierungsziel vom Gebot ausschließen
Das ExcludeFromBidding-Element wird dem ConversionGoal-Objekt hinzugefügt. Dieses Element ist für die zukünftige Verwendung reserviert.
Kundenabrechnung
Eine umfassende Referenzdokumentation zur Dienstversion 13 finden Sie unter Kundenabrechnung.
Breaking Changes
Proxyclient
Aktualisieren Sie Ihren Proxyclient so, dass er die neue Endpunktadresse und den neuen Namespace verwendet.
Der Zielnamespace ist https://bingads.microsoft.com/Billing/v13
.
Der Produktionsendpunkt ist https://clientcenter.api.bingads.microsoft.com/Api/Billing/v13/CustomerBillingService.svc.
Der Sandboxendpunkt ist https://clientcenter.api.sandbox.bingads.microsoft.com/Api/Billing/v13/CustomerBillingService.svc.
Einfügereihenfolge-Objekt
Dem InsertionOrder-Objekt werden mehrere Eigenschaften hinzugefügt.
- Die Elemente IsInSeries, SeriesFrequencyType und SeriesName werden für wiederkehrende Einfügeaufträge hinzugefügt. Sie können eine Einfügereihenfolge über die Bing Ads-API abrufen, aber mit sehr wenigen Ausnahmen nicht hinzufügen oder aktualisieren. Informationen zum Verwalten von wiederkehrenden Einfügeaufträgen in der Microsoft Advertising-Webanwendung finden Sie im Hilfeartikel Wie erstelle und bearbeite ich einen Einfügeauftrag? .
- Die Elemente BudgetRemaining, BudgetRemainingPercent, BudgetSpent und BudgetSpentPercent werden der Einfachheit halber hinzugefügt.
- Der Einfachheit halber wird die AccountNumber hinzugefügt.
- Der Queued-Statuswert wird dem InsertionOrderStatus-Wertsatz hinzugefügt. Dieser Wert ist für die zukünftige Verwendung reserviert.
Das BalanceAmount-Element wird entfernt und durch das BudgetRemaining-Element ersetzt.
GetInsertionOrdersByAccount wird entfernt
Der Vorgang GetInsertionOrdersByAccount wird entfernt. Sie können SearchInsertionOrders in Version 13 verwenden.
Customer Relationship Management (CRM)
Eine umfassende Referenzdokumentation zur Dienstversion 13 finden Sie unter Kundenverwaltung.
Breaking Changes
Proxyclient
Aktualisieren Sie Ihren Proxyclient so, dass er die neue Endpunktadresse und den neuen Namespace verwendet.
Der Zielnamespace ist https://bingads.microsoft.com/Customer/v13
.
Der Produktionsendpunkt ist https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc.
Der Sandboxendpunkt ist https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc.
Clientlinks
Am ClientLink-Objekt werden mehrere Änderungen vorgenommen.
- Das ClientAccountId-Element wird in ClientEntityId umbenannt.
- Das ClientAccountNumber-Element wird in ClientEntityNumber umbenannt.
- Das ClientEntityName-Element wird hinzugefügt.
- Das ManagingCustomerName-Element wird hinzugefügt.
- Das CustomerLinkPermission-Element wird zur zukünftigen Verwendung hinzugefügt.
- Das IsBillToClient-Element ist nillable.
Kundenadresse
In Version 13 ist das CustomerAddress-Element standardmäßig in allen zurückgegebenen Customer-Objekten enthalten. Sie müssen dieses Element nicht explizit anfordern. Das IncludeCustomerAddress-Element wird aus den Anforderungsnachrichten GetCustomer und SearchCustomers entfernt.
Verknüpfte Konto-IDs
In Version 13 ist das LinkedAccountIds-Element standardmäßig in allen zurückgegebenen CustomerRole-Objekten enthalten. Sie müssen dieses Element nicht explizit anfordern. Das IncludeLinkedAccountIds-Element wird aus der GetUser-Anforderungsnachricht entfernt.
Steuerinformationen für Australien und Brasilien
Die Schlüssel "TaxId" und "TaxType" sind nicht mehr verfügbar, wenn Sie das Konto TaxInformation für Australien und Brasilien festlegen. Verwenden Sie für Australien AUGSTNumber als Schlüssel, und legen Sie den Wert auf Ihren Steuerbezeichner fest. Für Brasilien sind die möglichen Schlüssel CCM, CPF und CNPJ.
Beschreibung | Version 12 | Version 13 |
---|---|---|
Konten in Australien | TaxId=YourTaxId | AUGSTNumber=YourTaxId |
Geschäftskonten in Brasilien | TaxId=YourTaxId; TaxType=Business | CPNJ=YourTaxId |
Persönliche Konten in Brasilien | TaxId=YourTaxId; TaxType=Personal | CPF=YourTaxId |
Für Geschäftskonten innerhalb der Stadt Sao Paulo, Brasilien gibt es keine Änderung am CCM-Schlüssel zwischen den Versionen 12 und 13.
Neue Features
Berechtigung "Kundenrollenlink"
Das CustomerLinkPermission-Element wird dem CustomerRole-Objekt hinzugefügt. Dieses Element ist für die zukünftige Verwendung reserviert.
Reporting
Eine umfassende Referenzdokumentation zur Dienstversion 13 finden Sie unter Berichterstellung.
Breaking Changes
Proxyclient
Aktualisieren Sie Ihren Proxyclient so, dass er die neue Endpunktadresse und den neuen Namespace verwendet.
Der Zielnamespace ist https://bingads.microsoft.com/Reporting/v13
.
Der Produktionsendpunkt ist https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.
Der Sandboxendpunkt ist https://reporting.api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/v13/ReportingService.svc.
Erforderliche Spalten für ProductMatchCountReportRequest
Die erforderlichen Spalten werden beim Übermitteln von ProductMatchCountReportRequest aktualisiert. In Version 13 sind die Spalten AccountName, CampaignName, MatchedProductsAtProductGroup und ProductGroup erforderlich.
Zuvor war in Version 12 zusätzlich zu den Anforderungen AccountName und CampaignName mindestens eine der Leistungsstatistikspalten MatchedProductsAtAdGroup, MatchedProductsAtCampaign oder MatchedProductsAtProductGroup erforderlich.
Sprachberichtsfilter
Der LanguageReportFilter-Wertsatz wird hinzugefügt. Das LanguageCode-Element (string) wird in den folgenden Berichtsfiltern durch das Languages (LanguageReportFilter)-Element ersetzt.
- AdDynamicTextPerformanceReportFilter
- AdGroupPerformanceReportFilter
- AdPerformanceReportFilter
- AgeGenderAudienceReportFilter
- DestinationUrlPerformanceReportFilter
- DSAAutoTargetPerformanceReportFilter
- DSACategoryPerformanceReportFilter
- DSASearchQueryPerformanceReportFilter
- GeographicPerformanceReportFilter
- KeywordPerformanceReportFilter
- ProductDimensionPerformanceReportFilter
- ProductPartitionPerformanceReportFilter
- ProductPartitionUnitPerformanceReportFilter
- ProductSearchQueryPerformanceReportFilter
- ProfessionalDemographicsAudienceReportFilter
- PublisherUsagePerformanceReportFilter
- SearchQueryPerformanceReportFilter
- ShareOfVoiceReportFilter
- UserLocationPerformanceReportFilter
Bericht "Alle Konvertierungen und Umsatz für Ziele"
Die Spalten Conversions und Revenue in GoalsAndFunnelsReportColumn werden in AllConversions bzw. AllRevenue umbenannt. Die Bedeutung der Daten hat sich von Version 12 in Version 13 nicht geändert.
Französische Berichtsheader
Die Unterstützung für das Herunterladen eines Berichts mit Kopfzeilen in Französisch wird entfernt. In Version 13 werden nur englische Header unterstützt. Das Language-Element wird aus dem ReportRequest-Objekt entfernt, und der ReportLanguage-Wertsatz wird entfernt.
AgeGenderDemographicReportRequest entfernt
AgeGenderDemographicReportRequest wird entfernt. Stattdessen können Sie AgeGenderAudienceReportRequest verwenden.
Suchkampagnentyp
Bei Suchkampagnen werden in der CampaignType-Spalte die Daten "Search" zurückgegeben. In Version 12 lautete der zurückgegebene Wert "Search & content". Die CampaignType-Spalte ist über die Wertesätze AdGroupPerformanceReportColumn, AdPerformanceReportColumn, CampaignPerformanceReportColumn und SearchQueryPerformanceReportColumn verfügbar.
Datenformat für Produktgruppen
Das Format der in der Spalte ProductGroup zurückgegebenen Daten wird aktualisiert.
Version | Beschreibung | Beispiel |
---|---|---|
12 | Verwendet "\" (umgekehrter Schrägstrich), um Ebenen zu trennen. Die Attributwerte sind nicht von "" (doppelte Anführungszeichen) umgeben. Die Kategorieebene wird ggf. an die Attributwerte angefügt, z. B. "(1st Level)", "(2nd Level)" uswetera. |
* \ Category=Animals & Pet Supplies (1st Level) \ Category=Pet Supplies (2nd Level) \ Category=Bird Supplies (3rd Level) |
13 | Verwendet "/" (Schrägstrich), um Ebenen zu trennen. Die Attributwerte sind von "" (doppelte Anführungszeichen) umgeben. Gibt nicht an, dass die Kategorieebene entfernt wurde, z. B. "(1. Ebene)". |
* / Category="Animals & Pet Supplies" / Category="Pet Supplies" / Category="Bird Supplies" |
Diese Änderung gilt für die ProductGroup-Spalte über die folgenden Wertesätze.
- ProductMatchCountReportColumn
- ProductPartitionPerformanceReportColumn
- ProductPartitionUnitPerformanceReportColumn
- ProductSearchQueryPerformanceReportColumn
Strich für nicht verfügbare Qualitätsbewertung
Wenn die Qualitätsbewertung in Version 13 nicht berechnet wurde, werden die zurückgegebenen Daten in den Spalten AdRelevance, ExpectedCtr, HistoricalAdRelevance, HistoricalExpectedCtr, HistoricalLandingPageExperience, HistoricalQualityScore, LandingPageExperience und QualityScore zurückgegeben. In Version 12 wurde der Wert von "0" (null) zurückgegeben. Diese Spalten sind in den Wertsätzen AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn, KeywordPerformanceReportColumn und ShareOfVoiceReportColumn verfügbar.
Einige Impression Share-Spalten ersetzt
Die Spalten ImpressionLostToAdRelevancePercent, ImpressionLostToBidPercent, ImpressionLostToExpectedCtrPercent, ImpressionLostToRelevancePercent und ImpressionLostToRankPercent werden aus den Wertsätzen AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn und ShareOfVoiceReportColumn entfernt.
In Version 13 werden die Daten, die auf diese Spalten der Version 12 aufgeteilt wurden, aggregiert und über die ImpressionLostToRankAggPercent-Spalte verfügbar, die alle diese Faktoren bei der Berechnung des verlorenen Eindrucks in Prozent berücksichtigt.
AverageCpp-, ClickCalls- und ManualCalls-Spalten entfernt
Die Spalten AverageCpp, ClickCalls und ManualCalls werden aus den Wertsätzen AccountPerformanceReportColumn, AdGroupPerformanceReportColumn und CampaignPerformanceReportColumn entfernt.
Die Spalten CallStatus und CallTypeName wurden entfernt.
Die Spalten CallStatus und CallTypeName werden aus dem CallDetailReportColumn-Wertsatz entfernt. Microsoft Advertising hat am 12. März 2014 die Gebühren für manuelle Anrufe an eine nachverfolgte Nummer eingestellt.
Erforderlicher Konto-, Kampagnen- oder Anzeigengruppenbereich
In Version 13 müssen Sie die Anforderung auf bestimmte Konten, Kampagnen oder Anzeigengruppen festlegen. Sie können beispielsweise bis zu 1.000 Konten, 300 Kampagnen oder 300 Anzeigengruppen über AccountThroughAdGroupReportScope einschließen. Bisher konnten Sie in Version 12 den Berichtsbereich für einige Berichtstypen NULL belassen, und Daten wurden für alle Konten zurückgegeben, auf die Sie zugreifen konnten.