Migrating to Bing Ads API Version 11
All Bing Ads API SOAP web services will be available with Version 11.
With the availability of Bing Ads API version 11, the previous versions of the API (v10 for Ad Insight, Bulk, and Campaign Management services and v9 for Customer Billing, Customer Management, and Reporting services) are now deprecated. We will sunset (i.e., shut down these services) on October 31st. To avoid any disruption to your tools after the older services sunset, migrate to the v11 services as soon as possible. |
The sections below describe changes from version 10 to version 11 of the Ad Insight, Bulk, and Campaign Management services, and changes from version 9 to version 11 of the Customer Billing, Customer Management, and Reporting services.
Breaking Changes
Proxy Client
Update your proxy client to use the new endpoint address and namespace.
The namespace is https://bingads.microsoft.com/AdInsight/v11.
The production endpoint is https://adinsight.api.bingads.microsoft.com/Api/Advertiser/AdInsight/v11/AdInsightService.svc.
The sandbox endpoint is https://adinsight.api.sandbox.bingads.microsoft.com/Api/Advertiser/AdInsight/v11/AdInsightService.svc.
Campaign Monthly Budget
The MonthlyBudgetSpendUntilDepleted value is removed from the the BudgetLimitType value set. Previously the GetBudgetOpportunities operation would return monthly budget opportunities for campaigns using monthly budgets. Monthly budgets are no longer supported in Bing Ads.
Breaking Changes
Proxy Client
Update your proxy client to use the new endpoint address and namespace.
The namespace is https://bingads.microsoft.com/CampaignManagement/v11.
The production endpoint is https://bulk.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v11/BulkService.svc.
The sandbox endpoint is https://bulk.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v11/BulkService.svc.
Download Entities
The DownloadEntities request element replaces the Entities request element for the DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations. The DownloadEntities element accepts a list of DownloadEntity values instead of a flag set used in Bing Ads API version 10. The BulkDownloadEntity value set is removed.
Format Version 5.0
Support for Bulk file format version 4.0 is removed. Bing Ads API Version 11 only supports format version 5.0. When calling the DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations you must specify 5.0 in the FormatVersion request element. When uploading a bulk file, you must specify 5.0 in the Name field of the Format Version record. Changes to records between format version 4.0 and 5.0 are described in more detail in the following sections.
Upgrade from Targets to Criterions
Instead of using targets to show your ads based on age, day and time, device, gender, and location, starting with Bing Ads API version 11 you must use criterions. Partial update of target criterions is supported in Bing Ads API version 11. The following changes are required to upgrade from targets to criterions. For more details please see the Upgrade Targets to Criterions guide.
- Replaced all target records with criterion records. For example the Ad Group Age Target record is replaced with the Ad Group Age Criterion record. You can download the new criterion records using the AdGroupTargetCriterions and CampaignTargetCriterions values of the DownloadEntity value set.
- The Ad Group Age Criterion and Campaign Age Criterion records support new values in the Target field: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFortyNine, FiftyToSixtyFour, and SixtyFiveAndAbove. The upper bound of each range previously supported in format version 4.0 were not inclusive, for example EighteenToTwentyFive would only target ages eighteen through twenty-four. The values in format version 5.0 match the effective target range that remains unchanged.
- If an ad group or campaign has any device criterion, then it must have bids for all three device types. Please note this change when adding and updating Ad Group DeviceOS Criterion and Campaign DeviceOS Criterion records. For example you cannot have a campaign that only has one Campaign DeviceOS Criterion record. If the campaign has any device criterion then it must have three Campaign DeviceOS Criterion records, each with corresponding supported bids for Computers, Smartphones, and Tablets. Previously in format version 4.0 the missing records were added automatically with bids set to '0' (zero).
- The Ad Group Location Criterion and Campaign Location Criterion records support location identifiers in the Target field, instead of the location codes that were accepted by the corresponding format version 4.0 target records. The location identifier corresponds to the ID field of the geographical locations file. For more information, see Geographical Location Codes and GetGeoLocationsFileUrl.
- The Sub Type field for Ad Group Location Criterion and Campaign Location Criterion records can include these values: City, Country, MetroArea, PostalCode, and State. The Sub Type field in the Bulk file format version 4.0 target records included these values (with spaces between words): City, Country, Metro Area, Postal Code, and State.
- The Physical Intent field is not available in the Ad Group Location Criterion, Campaign Location Criterion, Ad Group Radius Criterion, and Campaign Radius Criterion records, as it had been in the corresponding format version 4.0 target records. To determine the intent option for all location and radius criterions of a given ad group or campaign, you can use the new Ad Group Location Intent Criterion and Campaign Location Intent Criterion records.
- You cannot delete all criterions by sending one bulk record having Status set to Deleted. Previously using version 10 targets, you could have sent one row to delete all city targets for example. With criterions, each record must be updated and deleted individually with its unique identifier.
Remarketing Lists
For the remarketing list name in the Remarketing List and Ad Group Remarketing List Association records, use the Audience field instead of the Remarketing List field. For the remarketing list identifier in the same records, use the Audience Id field instead of the Remarketing List Id field.
Bing Ads API version 11 also supports custom and in-market audiences, in addition to remarketing lists.
Invalid Criterion Status
An error will be returned if you attempt to set the Status of the Ad Group Negative Dynamic Search Ad Target or Campaign Negative Dynamic Search Ad Target to an invalid value e.g. Paused. In Bing Ads API version 10, the invalid status update would not succeed but would not result in an error.
Cpm Pricing Model
The CPM pricing model is not supported in Bing Ads, and the Pricing Model field of an Ad Group is now deprecated. The Pricing Model field is now optional, defaults to Cpc, and can only be set to Cpc.
New Features
Audience Associations and Exclusions
Bing Ads API version 11 now supports custom audiences and in-market audiences, in addition to remarketing lists. The following audience, association, and exclusion records are supported.
- Remarketing List
- Ad Group Remarketing List Association
- Ad Group Negative Remarketing List Association
- Custom Audience
- Ad Group Custom Audience Association
- Ad Group Negative Custom Audience Association
- In Market Audience
- Ad Group In Market Audience Association
- Ad Group Negative In Market Audience Association
To download these record types individually you can include the following values from the DownloadEntity value set: RemarketingLists, AdGroupRemarketingListAssociations, AdGroupNegativeRemarketingListAssociations, CustomAudiences, AdGroupCustomAudienceAssociations, AdGroupNegativeCustomAudienceAssociations, InMarketAudiences, AdGroupInMarketAudienceAssociations, AdGroupNegativeInMarketAudienceAssociations. You can get all three types of audiences, associations, or exclusions by including the Audiences, AdGroupAudienceAssociations, and AdGroupNegativeAudienceAssociations values.
Associate Ad Extensions with an Account
Support is added for associating ad extensions at the account level. In Bing Ads API version 10 you could only associate ad extensions with campaigns and ad groups.
Call ad extensions cannot be associated with an account. In addition the deprecated sitelink ad extensions cannot be associated with an account. You must first Upgrade from Multiple Sitelinks to One Sitelink Per Extension. |
To get and set account level associations, use the following account level association records.
- Account App Ad Extension
- Account Callout Ad Extension
- Account Image Ad Extension
- Account Location Ad Extension
- Account Price Ad Extension
- Account Review Ad Extension
- Account Sitelink2 Ad Extension
- Account Structured Snippet Ad Extension
To download these record types individually you can include the following values from the DownloadEntity value set: AccountAppAdExtensions, AccountCalloutAdExtensions, AccountImageAdExtensions, AccountLocationAdExtensions, AccountPriceAdExtensions, AccountReviewAdExtensions, AccountSitelink2AdExtensions, AccountStructuredSnippetAdExtensions.
Price Ad Extensions
Support for price ad extensions is added. You can upload and download these price ad extension records.
To download these record types individually you can include the following values from the DownloadEntity value set: PriceAdExtensions, AdGroupPriceAdExtensions, CampaignPriceAdExtensions, AccountPriceAdExtensions.
Breaking Changes
Proxy Client
Update your proxy client to use the new endpoint address and namespace.
The namespace is https://bingads.microsoft.com/CampaignManagement/v11.
The production endpoint is https://campaign.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v11/CampaignManagementService.svc.
The sandbox endpoint is https://campaign.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v11/CampaignManagementService.svc.
Upgrade from Targets to Criterions
Instead of using targets to show your ads based on age, day and time, device, gender, and location, starting with Bing Ads API version 11 you must use criterions. Partial update of target criterions is supported in Bing Ads API version 11. The following changes are required to upgrade from targets to criterions. For more details please see the Upgrade Targets to Criterions guide.
- Removed all Target objects and service operations. For example the AgeTarget and AgeTargetBid are replaced with the AgeCriterion object. To add an age criterion you embed the AgeCriterion in either the BiddableCampaignCriterion or BiddableAdGroupCriterion and then call the respective AddCampaignCriterions or AddAdGroupCriterions service operation.
- The AgeRange values are updated: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFortyNine, FiftyToSixtyFour, and SixtyFiveAndAbove. The upper bound of each range previously supported in Bing Ads API Version 10 were not inclusive, for example EighteenToTwentyFive would only target ages eighteen through twenty-four. The values in Bing Ads API Version 11 match the effective target range that remains unchanged.
- If an ad group or campaign has any device criterion, then it must have bids for all three device types. Please note this change when adding and updating DeviceCriterion. For example you cannot have a campaign that only has one DeviceCriterion. If the campaign has any device criterion then it must have three DeviceCriterion, each with corresponding supported bids for Computers, Smartphones, and Tablets. Previously in Bing Ads API Version 10 the missing bids were added automatically with bids set to '0' (zero).
- The LocationCriterion supports location identifiers in its LocationId element, instead of the location codes that were accepted for sub location targets e.g. CityTargetBid in Bing Ads API Version 10. The location identifier corresponds to the ID field of the geographical locations file. For more information, see Geographical Location Codes and GetGeoLocationsFileUrl.
- The LocationIntentCriterion is added in Bing Ads API Version 11. Previously in Bing Ads API Version 10 you would have set the intent option in the LocationTarget, which has been removed. One location intent criterion determines the intent option for all location and radius criterions of a given ad group or campaign.
- Use the BidMultiplier object to adjust the bid for the target criterion.
Biddable Campaign Criterion
The BiddableCampaignCriterion is added, and derives properties from the CampaignCriterion, which is now an abstract base class. You must use BiddableCampaignCriterion instead of CampaignCriterion in add, get, and update campaign criterion operations.
Fixed Bid
Within the FixedBid object, the Bid element of type Bid is replaced by the Amount element of type double.
Ad Group Criterion Type
The AccountId element is removed from the request message of the AddAdGroupCriterions, DeleteAdGroupCriterions, GetAdGroupCriterionsByIds, and UpdateAdGroupCriterions operations. You must set the CustomerAccountId header element instead.
Shared Target to Criterion Migration
The IsMigrated element is added to the response message of the AddAdGroupCriterions, DeleteAdGroupCriterions, UpdateAdGroupCriterions, AddCampaignCriterions, DeleteCampaignCriterions, and UpdateCampaignCriterions operations. The IsMigrated element indicates whether or not the campaign or ad group where you added, deleted, or updated target criterions previously shared target criterions with another campaign or ad group. If IsMigrated is set to true, it indicates that the service migrated the shared target associations and assigned new criterion IDs. If you already have criterion IDs for targets such as age, day and time, device, gender, and location, then you should replace those IDs with all of the new IDs returned by the GetAdGroupCriterionsByIds or GetCampaignCriterionsByIds operation (specify TargetCriterions as the CriterionType). You only need to sync target criterion IDs, as other criterion types such as webpage criterions are not migrated. For more details please see the Upgrade Targets to Criterions guide.
Account Id for Criterions
The CriterionType value set is renamed AdGroupCriterionType. You'll need to make code changes if you call the AddAdGroupCriterions, DeleteAdGroupCriterions, GetAdGroupCriterionsByIds, or UpdateAdGroupCriterions operations.
Remarketing Lists
The RemarketingList now derives from the Audience base class. The Description, ForwardCompatibilityMap, Id, MembershipDuration, Name, ParentId, and Scope elements are moved from RemarketingList to the Audience base class. The AddRemarketingLists, DeleteRemarketingLists, GetRemarketingLists, and UpdateRemarketingLists operations are replaced with the AddAudiences, DeleteAudiences, GetAudiencesByIds, and UpdateAudiences operations. Bing Ads API version 11 also supports custom and in-market audiences, in addition to remarketing lists.
The AdGroupRemarketingListAssociation object and AddAdGroupRemarketingListAssociations, DeleteAdGroupRemarketingListAssociations, GetAdGroupRemarketingListAssociations, and UpdateAdGroupRemarketingListAssociations operations are removed. To associate remarketing lists and other audience types with ad groups, use the new AudienceCriterion object with the AddAdGroupCriterions, DeleteAdGroupCriterions, GetAdGroupCriterionsByIds, and UpdateAdGroupCriterions operations.
Campaign Monthly Budget
Monthly budgets are no longer supported for Bing Ads campaigns. The MonthlyBudget element is removed from the Campaign object. The MonthlyBudgetSpendUntilDepleted value is removed from the BudgetLimitType value set.
Ad Extensions Partial Success
The AddAdExtensions, DeleteAdExtensions, DeleteAdExtensionsAssociations, GetAdExtensionsAssociations, GetAdExtensionsByIds, GetAdExtensionsEditorialReasons, and UpdateAdExtensions operations now support partial success. Either the PartialErrors or NestedPartialErrors element is added to each operation's response message. Note that the SetAdExtensionsAssociations operation already supported partial success.
Ad Extensions Device Preference
The DevicePreference element is added to the AdExtension base class, and DevicePreference is removed from the AppAdExtension, CallAdExtension, and Sitelink2AdExtension objects. Device preference is currently only supported for app, sitelink, and sitelink2 ad extensions.
Required Migration Type Filter
The MigrationType element of the GetAccountMigrationStatuses service operation is now required. In version 10 if you did not specify any migration type value, by default the SiteLinkAdExtension migration status would be returned.
Required Ad Types
When calling the GetAdsByAdGroupId, GetAdsByEditorialStatus, and GetAdsByIds operations the AdTypes element is now required. In version 10 these operations returned text and product ads if AdTypes was left nil.
Add Ads Duplicate Error
If you attempt to create an ad with duplicate ad copy, the AddAds operation will now consistently return a duplicate ad error. In Version 10, the operation would return an error if the duplicate ad copy exists in the same batch request. However, if duplicate ad copy was provided in a subsequent call the operation appeared to succed but returned the existing ad identifier.
IdCollection Ids Data Type
The Ids element of the IdCollection object is updated from ArrayOflong to ArrayOfNullableOflong. The response for AddNegativeKeywordsToEntities can now contain a list item that is nil if a negative keyword was not successfully added. In Version 10 if a negative keyword was not added the operation returned 0 as a list item within Ids instead of nil.
Site Placements Sunset
Site placements were sunset during calendar year 2016, and the following programming elements are removed from the Campaign Management API: SitePlacement, AddSitePlacements, DeleteSitePlacements, GetSitePlacementsByAdGroupId, GetSitePlacementsByIds, UpdateSitePlacements, and GetPlacementDetailsForUrls.
Ad Group Bidding Model
The BiddingModel value set is removed and the BiddingModel element is removed from the AdGroup object. The bidding model is effectively determined by the Campaign type e.g. you can bid on keywords in Search and Content campaigns, product groups in Shopping campaigns, or webpage criterion in Dynamic Search Ad campaigns.
Campaign Daylight Saving
The DaylightSaving element is removed from the Campaign object. Bing Ads will continue to adjust the delivery only on time zones where DST adjustment applies. This setting was only used to interpret the start and end date of your ad groups relative to your campaign's time zone. It has never been used for day and time scheduling.
Bidding Scheme Starting Bid
The StartingBid element is removed from the MaxConversionsBiddingScheme and TargetCpaBiddingScheme objects. The starting bid was never implemented, and is removed from the Campaign Management API contract.
Invalid Criterion Status
An error will be returned if you attempt to set the Status of the NegativeAdGroupCriterion or NegativeCampaignCriterion to an invalid value e.g. Paused. In Bing Ads API version 10, the invalid status update would not succeed but would not result in an error.
Ad Format Preference for Native Ads
The Ad Format Preference is used to indicate whether or not you prefer the ad copy to be shown to users as a search or native ad. Search ads tend to be written as a call to action, whereas native ads should be written in more of an informational style.
The NativePreference key is removed from the ad's ForwardCompatibilityMap. In its place, the AdFormatPreference element of type string is added to the Ad object. All ad types inherit this element, and currently it is only applicable for the ExpandedTextAd and TextAd objects.
Possible values are Native and All. If set to All, the ad will be eligible for both search and native ad formats. If set to Native, the ad will only be eligible for the native ad format.
Return Additional Fields
The ReturnAdditionalFields element is removed from the GetCampaignsByAccountId, GetCampaignsByIds, GetAdGroupsByCampaignId,GetAdGroupsByIds, GetKeywordsByAdGroupId, GetKeywordsByEditorialStatus, GetKeywordsByIds, GetAdExtensionsAssociations,GetAdExtensionsByIds, and GetRemarketingLists request messages, and the corresponding elements of each Campaign, AdGroup, Keyword, AdExtension, and RemarketingList are returned by default.
Cpm Pricing Model
The CPM pricing model is not supported in Bing Ads, and the PricingModel element of an AdGroup is now deprecated. The PricingModel element is now optional, defaults to Cpc, and can only be set to Cpc.
New Features
Audience Associations and Exclusions
Bing Ads API version 11 now supports custom audiences and in-market audiences, in addition to remarketing lists.
The CustomAudience, InMarketAudience, and RemarketingList derive from the Audience base class. You can manage audiences with the AddAudiences, DeleteAudiences, GetAudiencesByIds, and UpdateAudiences operations.
Associate Ad Extensions with an Account
Support is added for associating ad extensions at the account level. In Bing Ads API version 10 you could only associate ad extensions with campaigns and ad groups.
Call ad extensions cannot be associated with an account. In addition the deprecated sitelink ad extensions cannot be associated with an account. You must first Upgrade from Multiple Sitelinks to One Sitelink Per Extension. |
To get and set account level associations, use the Account value of the AssociationType value set.
Price Ad Extensions
Support for price ad extensions is added. You can manage the new PriceAdExtension object with the AddAdExtensions, DeleteAdExtensions, DeleteAdExtensionsAssociations, GetAdExtensionsAssociations, GetAdExtensionsByIds, GetAdExtensionsEditorialReasons, SetAdExtensionsAssociations, and UpdateAdExtensions operations.
Breaking Changes
Proxy Client
Update your proxy client to use the new endpoint address and namespace.
The namespace is https://bingads.microsoft.com/Billing/v11.
The production endpoint is https://clientcenter.api.bingads.microsoft.com/Api/Billing/v11/CustomerBillingService.svc.
Insertion Order Status
For parity with the insertion order status values that you'll already find in the Bing Ads web application, the Exhausted and Pending values are added to the InsertionOrderStatus value set.
If the insertion order start date is in the future, the Bing Ads API Version 9 status would be Active; However in the Bing Ads web application and Bing Ads API Version 11 the status is Pending. |
In addition the ChangePendingReview element is added to the InsertionOrder object. If this element is true, an update to the insertion order is pending user review.
Breaking Changes
Proxy Client
Update your proxy client to use the new endpoint address and namespace.
The namespace is https://bingads.microsoft.com/Customer/v11.
The production endpoint is https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v11/CustomerManagementService.svc.
The sandbox endpoint is https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v11/CustomerManagementService.svc.
Tax Details
The TaxId is moved as a key and value pair to the TaxInformation element of the AdvertiserAccount object. Additional keys include the TaxType and VatNumber.
The BusinessAddress element of an AdvertiserAccount is now required when adding accounts.
The IncludeTaxDetails element is removed from the GetAccount and SearchAccounts request messages, so the BusinessAddress element is now returned by default when retrieving accounts. With this update the TaxId and TaxIdStatus elements and corresponding value set is also removed.
The IncludeTaxInformation element is removed from the GetAccount and SearchAccounts request messages, so the TaxInformation element is now returned by default when retrieving accounts.
Standard User Role
To represent the Standard user role, the StandardUser value is added to the UserRole value set. With Customer Management API Version 9 you could not get or set the Standard user role. In version 9 the Advertiser Campaign Manager role value was returned instead.
Linked Agencies
The LinkedAgencies element is added to the AdvertiserAccount object. This array of CustomerInfo represents the list of agencies linked to the account. This element is reserved for future use.
The AgencyContactName and AgencyCustomerId elements are removed from the AdvertiserAccount object. Instead you will be able to get those values in the LinkedAgencies element.
Breaking Changes
Proxy Client
Update your proxy client to use the new endpoint address and namespace.
The namespace is https://bingads.microsoft.com/Reporting/v11.
The production endpoint is https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/v11/ReportingService.svc.
The sandbox endpoint is https://reporting.api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/v11/ReportingService.svc.
Consistency Between WSDL Contract and Downloaded Report Columns
Previously there were some discrepancies between the report column value set names and the names of the columns in the downloaded reports. In Reporting API Version 11 most of the downloaded column names match the requested value. For example now when you submit a KeywordPerformanceReportRequest with the BidMatchType value from the KeywordPerformanceReportColumn value set, the column name in the downloaded report is also BidMatchType in Reporting API Version 11. Previously in version 9, the column name in the downloaded report was BiddedMatchType.
Some download column names in version 11 do not match the version 11 contract. These will be updated in version 12. For more details see each column description in Report Attributes and Performance Statistics. |
The following column names have changed in the downloaded reports from version 9 to 11.
| Version 9 | Version 11 |
|---|---|
| Ad group item Id | AdGroupCriterionId |
| BiddedMatchType | BidMatchType |
| MatchType | DeliveredMatchType |
| Device type | DeviceType |
| Path 1 | Path1 |
| Path 2 | Path2 |
| Title Part 1 | TitlePart1 |
| Title Part 2 | TitlePart2 |
| Search query | SearchQuery |
Percent Appended to Downloaded Data
A percent symbol (%) is appended to the downloaded report data for the following columns.
ClickSharePercent
Ctr
EstimatedClickPercent
EstimatedConversionRate
EstimatedCtr
EstimatedImpressionPercent
ImpressionLostToAdRelevancePercent
ImpressionLostToBidPercent
ImpressionLostToBudgetPercent
ImpressionLostToRankPercent
ImpressionLostToExpectedCtrPercent
ImpressionSharePercent
LowQualityClicksPercent
LowQualityImpressionsPercent
ReturnOnAdSpend
The data is still a percentage and has not changed from version 9 to version 11. The only change is the percent symbol. For example in version 9 the download data for Ctr might have been 2.13, and in version 11 it would be 2.13%.
TimePeriod Data Format
The date in the TimePeriod column download data is now formatted as YYYY-MM-DD. For example May 1, 2017 would be formatted as 2017-05-01. Previously the date was localized e.g. for English report downloads the date was formatted as m/d/yyyy.
Rename Quality Score and Share of Voice Subscore
Previously some of the Reporting API quality score and share of voice report column value set names did not match the Bing Ads web application. In Reporting API Version 11 the AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn, KeywordPerformanceReportColumn, and ShareOfVoicePerformanceReportColumn value sets are each updated with one or more of the new values, and the new names are also reflected in the downloaded report data i.e. new column header names.
The following report column values have changed from version 9 to 11.
| Version 9 | Version 11 |
|---|---|
| HistoricKeywordRelevance | HistoricExpectedCtr |
| HistoricLandingPageRelevance | HistoricAdRelevance |
| HistoricLandingPageUserExperience | HistoricLandingPageExperience |
| ImpressionLostToKeywordRelevancePercent | ImpressionLostToExpectedCtrPercent |
| ImpressionLostToLandingPageRelevancePercent | ImpressionLostToAdRelevancePercent |
| KeywordRelevance | ExpectedCtr |
| LandingPageRelevance | AdRelevance |
| LandingPageUserExperience | LandingPageExperience |
Rename Geographic and User Location Reports
The following geographic and user location reports have been renamed to clarify their usage and match the Bing Ads web application.
In version 11, the GeographicPerformanceReportRequest with corresponding columns and filter replaces the GeoLocationPerformanceReportRequest.The geographic performance report shows impressions, clicks, spend, and average cost-per-click for each ad group, organized into columns that show the location used to serve ads. You can see where your traffic is coming from: the physical location of the people searching for your ad or the locations people are searching for. You can then validate whether your location targeting strategy is successful and identify opportunities to improve.
In version 11, the UserLocationPerformanceReportRequest with corresponding columns and filter replaces the GeographicalLocationReportRequest. The user location performance report shows impressions, clicks, spend, and average cost-per-click for each ad group, organized by city, country, metro area, radius, state, and account. You can see where your traffic is coming from broken out by the physical location and the location people are searching for. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve.
Report Download URL and Empty Reports
Even when the Status of the ReportRequestStatus object is set to Success, the ReportDownloadUrl element will be nil if no performance data is available for the submitted report parameters (whether or not header and footer metadata were requested). Previously in version 9 a file that only included header and footer metadata would be returned.
Sunset Product Offer and Product Target Reports
The ProductOfferPerformanceReportRequest and ProductTargetPerformanceReportRequest with corresponding columns and filters are removed. For Bing Shopping campaigns you should use the ProductDimensionPerformanceReportRequest, ProductPartitionPerformanceReportRequest, and ProductPartitionUnitPerformanceReportRequest.
Additionally, the ProductTarget column is removed from the SearchQueryPerformanceReportColumn value set.
Sunset Ad Extension Dimension Report
The AdExtensionDimensionReportRequest with corresponding columns and filters is removed. Previously in Reporting API Version 9 attempting to submit this report request would throw an exception.
Sunset Campaign Analytics Reports
The TacticChannelReportRequest and TrafficSourcesReportRequest with corresponding columns and filters are removed. Campaign Analytics was deprecated in October 2016, and data processing ended February 2017. If you are using Universal Event Tracking you can get conversion data with several other reports, for example the AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn, and KeywordPerformanceReportColumn.
Additionally the ExtendedCost, FunnelConversionRate, Step1, Step2, Step3, Step4, and Step5 columns are removed from all related value sets.
Sunset Visits and Spend Columns
Based on customer feedback about reporting priorities, the AverageDurationPerVisit, AveragePagesPerVisit, BounceRate, and TotalVisits columns are removed from the AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CampaignPerformanceReportColumn, and KeywordPerformanceReportColumn value sets.
Additionally the ReturnOnAdSpend and Spend columns are removed from the GoalAndFunnelsReportColumn value set.
Sunset Phone Spend Columns
There is no charge for call forwarding numbers using Skype, so the PhoneSpend and TotalCostPhoneAndClicks columns are removed from the AccountPerformanceReportColumn, AdGroupPerformanceReportColumn, CallDetailReportColumn, and CampaignPerformanceReportColumn value sets.
Sunset Draft Status Filter
The Draft status for ad groups was previously sunset in Bing Ads Campaign Management API (draft status removed from ad group status). In turn, the Draft value is removed removed from the AdGroupStatusReportFilter value set.
Sunset Submitted Filter
The Submitted status has the same meaning as Active, so the Submitted value is removed removed from the AdStatusReportFilter, AdGroupStatusReportFilter, CampaignStatusReportFilter value sets.
Sunset Rich Ads Report
The rich ads in search feature was already sunset in Bing Ads, and now the RichAdComponentPerformanceReportRequest with corresponding columns and filters is removed from the Reporting API.
Additionally the Image, Mobile, RichAd, RichMedia, and ThirdPartyCreative values are removed from the AdTypeReportFilter value set.
Sunset Site Performance Report
Site placements are already sunset in Bing Ads, and now the SitePerformanceReportRequest with corresponding columns and filters is removed from the Reporting API.
Cpm Pricing Model
The CPM pricing model is not supported in Bing Ads, so the AverageCpm column is removed from the report column value sets.
The PricingModelReportFilter value set is removed from the Reporting API and the PricingModel element is removed from the the PublisherUsagePerformanceReportFilter.
Sunset KeywordMatchTypeId Column
The keyword by match type migration was completed October 2013. Since Bing Ads does not return data prior to this date, the KeywordMatchTypeId is removed from the KeywordPerformanceReportColumn value set.
New Features
Exclude Report Columns and Metadata
Bing Ads API version 11 now lets you choose whether or not the downloaded report should contain header, column, and footer metadata. You can optionally set any of the ExcludeColumnHeaders, ExcludeReportFooter, or ExcludeReportHeader properties of the ReportRequest to true if you want the corresponding metadata excluded from the downloaded report.