Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Release Notes

Release Notes

System_CLiX_note Note

Version 10 is not feature complete or functional. This is preview documentation of the AdInsight, Bulk, and Campaign Management services that are expected to be released from July through September 2015. The services and documentation are subject to change prior to general availability. To start planning, see Migrating from Bing Ads API Version 9 to Version 10.

System_CLiX_note Note

Version 10 of the Customer Billing, Customer Management, and Reporting services are not yet available. You can use Bing Ads API Version 9 for those services.

For information about the changes to the Bing Ads services for each release, see the following sections.

July 2015

For information about the changes to the Bing Ads services included in this release, see the following sections.

Bulk

Format Version 4.0

Support for Bulk file format version 3.0 is removed. Bing Ads API Version 10 now only supports format version 4.0. The following records have changed between format version 3.0 and 4.0.

  • The Mobile Ad record is removed. Bing Ads no longer supports WAP mobile ads.

  • The Product Ad Extension, Campaign Product Ad Extension, and Ad Group Product Target records are removed. Product ad extensions are not supported in Bing Ads Version 10. For product ads you should use Bing Shopping Campaigns instead.

  • The COUNTRY_CODE column is renamed to Country Code. This impacts the following existing record types: Call Ad Extension, Campaign, and Location Ad Extension.

  • In the Ad Group record, the Search Broad Bid column is renamed Search Bid and corresponds to the new SearchBid element of the AdGroup object in the Campaign Management service.

  • The Campaign Type field is now required when adding a new campaign using the Campaign record. In previous format versions SearchAndContent was used as the default value if Campaign Type was not specified.

  • For the Image Ad Extension record, the Media Id column is renamed Media Ids and accepts multiple media identifiers which must be semicolon delimited.

Location Target Version

The LocationTargetVersion element is removed from the DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations. The service will always return locations according to Nielsen DMA® codes. For more information, see Geographical Location Codes.

Campaign Management

Ad Group Search Bid

The SearchBid element is added to the AdGroup object, and replaces the BroadMatchBid, ExactMatchBid, and PhraseMatchBid elements. You can set a default bid for all search match types (broad, exact, and phrase) using this new element. You can no longer set different ad group level bids for broad, exact, and phrase match types. You can still override the bids for each distinct Keyword match type.

Mobile Ads

Bing Ads no longer supports WAP mobile ads. The MobileAd Data Object is not available in Bing Ads Version 10.

Product Ads

Product ad extensions are not supported in Bing Ads Version 10. For product ads you should use Bing Shopping Campaigns instead. The following programming elements are not available in Bing Ads Version 10.

  • Product Data Object

  • ProductAdExtension Data Object

System_CLiX_note Note

The AddAdGroupCriterions, DeleteAdGroupCriterions, and UpdateAdGroupCriterions operations remain in the interface and are reserved for future use. Currently there are no ad group criterions that can be used with those operations.

Location Target Version

The LocationTargetVersion element is removed from the GetTargetsByIds operation. The service will always return locations according to Nielsen DMA® codes. For more information, see Geographical Location Codes.

Native Ads

To avoid breaking changes in Bing Ads version 9, some optional request elements were added to the following service operations. The elements have been removed in Bing Ads version 10.

Campaign Level Conversion Tracking

The ConversionTrackingEnabled element is removed from the Campaign object. Campaign-level conversion tracking has already sunset, and this element is no longer used even in Bing Ads version 9.

June 2015

For information about the changes to the Bing Ads services included in this release, see the following sections.

Ad Insight

Merged Ad Intelligence and Optimizer

Version 10 of the Ad Insight service is available for preview in sandbox.

System_CLiX_note Note

Version 10 of the Ad Insight service is in preview. The service and documentation are subject to change prior to general availability.

The Ad Intelligence and Optimizer services that were available in Bing Ads API Version 9 are merged together and named Ad Insight.

The namespace is https://bingads.microsoft.com/AdInsight/v10.

The sandbox endpoint is https://adinsight.api.sandbox.bingads.microsoft.com/Api/Advertiser/AdInsight/V10/AdInsightService.svc.

Moved to Ad Insight from the Optimizer Service

These service operations have been moved from the version 9 Optimizer service to the new Ad Insight service.

These data objects have been moved to the new Ad Insight service.

These value sets have been moved to the new Ad Insight service.

Optimizer Features Sunset

These service operations will sunset with version 9 of the Optimizer service.

  • ApplyOpportunities

    System_CLiX_note Note

    To apply the suggested bid, budget, and keyword opportunities, you can use the update operations provided with the Bulk or Campaign Management services.

  • GetBudgetLandscape

    System_CLiX_note Note

    Budget landscape data is available in the new Ad Insight service. The response for GetBudgetOpportunities now includes a list of BudgetPoint objects.

These data objects will sunset with version 9 of the Optimizer service.

  • BidOpportunityModifier

  • BroadMatchOpportunityModifier

  • BudgetLandscapePoint

  • BudgetOpportunityModifier

  • CampaignBudgetLandscape

  • KeywordOpportunityModifier

  • OpportunityModifier

Budget Landscape

The GetBudgetLandscape operation is not carried forward with Ad Insight version 10, and will be sunset with version 9 of the Optimizer service.

With Ad Insight version 10, you can get budget landscape data using the GetBudgetOpportunities operation. Each returned BudgetOpportunity now includes BudgetPoints, which is a list of BudgetPoint objects representing the budget landscape.

In version 10, each BudgetPoint includes weekly impressions, clicks, and cost estimates instead of the daily estimates provided in version 9.

Opportunity Expiration Date

The ExpirationDate element is removed from the Opportunity object. Expired opportunities will not be returned by the Ad Insight service.

Bid Opportunity Type

The IncreaseTraffic value is removed from the BidOpportunityType value set.

Opportunities by Account

The AccountId request element is removed from the GetBidOpportunities, GetBudgetOpportunities, and GetKeywordOpportunities operations.

In Ad Insight version 10, the CustomerAccountId request header element determines the account used for the provided opportunities.

Keyword Data by Device

The Device element is added to the following objects.

Given the above update, the Device element is removed from the following objects.

The Device and HistoricalSearchCounts elements are removed from the KeywordSearchCount object. They are replaced by the SearchCountsByAttributes element, which is a list of SearchCountsByAttributes. Each SearchCountsByAttributes object contains a list of keyword historical search counts for the corresponding device.

Ad Group Estimated Bid

The data type of the AdGroupEstimatedBid response element of the GetEstimatedBidByKeywords operation is changed from AdGroupEstimatedBid to EstimatedBidAndTraffic.

The name and data type of the request property used by GetEstimatedBidByKeywords to determine the bid level is changed from GetBidsAtLevel (int) to EntityLevelBid (string). You can now specify either Keyword, AdGroup, or AllEntities.

Broad Match Keyword Opportunity

The following elements are moved from the KeywordOpportunity to BroadMatchKeywordOpportunity data object.

  • AverageCPC

  • AverageCTR

  • ClickShare

Previously the BroadMatchKeywordOpportunity object inherited those elements from KeywordOpportunity.

Budget Landscape

The response for GetBudgetOpportunities now includes a list of BudgetPoint objects.

Time Interval

The TimeInterval Value Set is updated to reflect the true intervals.

  • Last30Days is updated to LastMonth.

  • Last7Days is updated to LastWeek.

Bulk

Updated the Version Number

Version 10 of the Bulk service is available for preview in sandbox.

System_CLiX_note Note

Version 10 of the Bulk service is in preview. The service and documentation are subject to change prior to general availability.

The namespace has been changed to reflect the new version number of this release; The namespace is https://bingads.microsoft.com/CampaignManagement/v10.

The sandbox endpoint is https://bulk.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/V10/BulkService.svc.

Bulk Status Operations Renamed

The GetDetailedBulkUploadStatus operation is renamed GetBulkUploadStatus, which replaces the version 9 GetBulkUploadStatus operation.

The GetDetailedBulkDownloadStatus operation is renamed GetBulkDownloadStatus, which replaces the version 9 GetDownloadStatus operation.

Download Compression Type

You can now specify either the GZip or ZIP CompressionType when calling the DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations.

Campaign Management

Updated the Version Number

Version 10 of the Campaign Management service is available for preview in sandbox.

System_CLiX_note Note

Version 10 of the Campaign Management service is in preview. The service and documentation are subject to change prior to general availability.

The namespace has been changed to reflect the new version number for this release. The new namespace name is https://bingads.microsoft.com/CampaignManagement/v10. For the production and sandbox endpoints, see Bing Ads Web Service Addresses.

The namespace has been changed to reflect the new version number for this release.; The namespace is https://bingads.microsoft.com/CampaignManagement/v10.

The sandbox endpoint is https://campaign.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/V10/CampaignManagementService.svc.

Target2 renamed as Target

In Bing Ads API version 9, the "Target2" object model was introduced to avoid breaking changes, instead of adding new elements to the version 9 Target. The following objects and operations are renamed in version 10.

Version 9

Version 10

Target2

Target

LocationTarget2

LocationTarget

RadiusTarget2

RadiusTarget

RadiusTargetBid2

RadiusTargetBid

AddTargetsToLibrary2

AddTargetsToLibrary

GetTargetsByAdGroupIds2

GetTargetsByAdGroupIds

GetTargetsByCampaignIds2

GetTargetsByCampaignIds

GetTargetsByIds2

GetTargetsByIds

UpdateTargetsInLibrary2

UpdateTargetsInLibrary

The following objects and value sets related to the legacy version 9 target model are also removed.

  • DayTarget Data Object

  • DayTargetBid Data Object

  • HourTarget Data Object

  • HourTargetBid Data Object

  • NetworkTarget Data Object

  • NetworkTargetBid Data Object

  • HourRange Value Set

  • NetworkType Value Set

Negative Keyword Legacy Operations Removed

The SetNegativeKeywordsToCampaigns and SetNegativeKeywordsToAdGroups operations are removed.AddNegativeKeywordsToEntities and DeleteNegativeKeywordsFromEntities should be used instead of the SetNegativeKeywordsToCampaigns and SetNegativeKeywordsToAdGroups operations.

The GetNegativeKeywordsByCampaignIds and GetNegativeKeywordsByAdGroupIds operations are removed. GetNegativeKeywordsByEntityIds should be used instead of the GetNegativeKeywordsByCampaignIds and GetNegativeKeywordsByAdGroupIds operations.

In turn the AdGroupNegativeKeywords Data ObjectCampaignNegativeKeywords Data Object are also removed.

Ad Group Status

The Expired value is added to the AdGroupStatus Value Set. Previously expired ad groups were returned with a Deleted status, although the true status has always been expired. The Deleted value is retained in version 10, but is now reserved for internal use.

The Draft value is removed from the AdGroupStatus Value Set. In turn, the SubmitAdGroupForApproval operation is also removed. To pause and resume ad groups, use the UpdateAdGroups operation.

Partial Success and Partial Errors

Partial success means that when adding, updating, or deleting entities in batches of one or more, the operation may succeed for some and fail for part of the batch. For each list index where an entity was not added, the corresponding element will be null. The PartialErrors element represents an array of BatchError objects that contain details for any entities that were not successfully added, updated, or deleted. The list only includes a BatchError for unsuccessful attempts, and does not include null elements at the index of each successfully added entity. Similarly some operations return NestedPartialErrors as a list of BatchErrorCollection, or a two dimensional BatchError.

The following operations now include PartialErrors in the response.

The following operations now include NestedPartialErrors in the response.

For more information and a complete list of operations that support partial success, see Partial Success using the Campaign Management Service.

Editorial Operations Require Ad Group Identifiers

The AppealEditorialRejections and GetEditorialReasonsByIds operations now require the ad group identifier in addition to ad or keyword ID. The EntityIds element is removed from both operations and replaced by EntityIdToParentIdAssociations, which is a list of EntityIdToParentIdAssociation. Each EntityIdToParentIdAssociation contains the unique system identifier of an entity such as ad or keyword, and the identifier of its parent. An ad group is the parent of an ad or keyword.

Additionally, an AdGroupId element is added to the EditorialReasonCollection Data Object.

Get Criterions

The GetAdGroupCriterionsByAdGroupId operation is removed. To get all ad group criterions for an ad group, you can leave AdGroupCriterionIds null in the request to GetAdGroupCriterionsByIds.

The GetCampaignCriterionsByCampaignId operation is removed. To get all campaign criterions for a campaign, you can leave CampaignCriterionIds null in the request to GetCampaignCriterionsByIds.

Upgrade to Final URLs

Final URLs will eventually replace Destination URLs that are specified today for your ads and keywords. Version 9 will not support Final URLs, so you'll need to use Version 10.

System_CLiX_note Note

Details on the migration plan from Destination URLs to Final URLs are coming soon.

The FinalAppUrls, FinalMobileUrls, and FinalUrls elements are added to the following objects.

Tracking Templates and Custom Parameters

Tracking templates and custom parameters are added to provide more flexibility and simplify management of Dynamic Text Substitution for URL tracking.

System_CLiX_note Note

Details on support for Tracking Templates and Custom Parameters are coming soon.

The TrackingUrlTemplate and UrlCustomParameters elements are added to the following objects.

Community Additions

ADD
Show:
© 2015 Microsoft