Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Migrating from Bing Ads API Version 7 to Version 8

The Bing Ads API Version 7 is scheduled to sunset April 2013. You must migrate your application to version 8 before the sunset date. Failing to go through migration will cause your application to stop working when the services are removed. To test your migrated application, use the Bing Ads sandbox. For more information about using the sandbox, see Sandbox.

For information about what’s changed from version 7 to version 8, see the following sections.

Version 8 also includes the following services that you may consider including in your application to help optimize your campaigns.

  • Ad Intelligence service provides operations that you may use to get information about how keywords have performed historically, the suggested relevant keywords from the content of a specified URL or from other keywords, the suggested minimum keyword bid that may result in ads appearing in the specified position in the search results, and the possible position where ads might appear given the specified bid. For more information, see Researching and Pricing Keywords and Ad Intelligence Service Reference.

  • Bulk service lets you download campaign data in the background. If you keep a local cache of your campaign data, you should use this service instead of calling the Campaign Management service’s entity operations to get your campaign’s data. For more information, see Downloading Campaigns and Bulk Service Reference.

  • Notification service provides operations that you may use to get budget-related notifications, such as notification that a campaign’s budget balance is depleted or that an account’s credit card is about to expire. You may also get a notification when an ad or keyword is rejected for editorial reasons. For more information, see Notification Service Reference.

  • Optimizer service provides operations that you may use to discover opportunities for improving the performance of your campaigns, for example by updating your bid or budget. For more information, see Optimizing Campaigns and Optimizer Service Reference.

Campaign Management

Breaking Changes

Required Changes

Description

Proxy Client

Update your proxy client to use the new endpoint address and namespace.

The service address is https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementService.svc?wsdl.

The namespace is https://adcenter.microsoft.com/v8.

Campaign Budget Settings

Update the campaign budget values.

Replace the DailyBudgetWithMaximumMonthlySpend value with DailyBudgetAccelerated. With this option, the daily budget is spent until it is depleted. If you want the daily budget to be spread throughout the day, you should use the DailyBudgetStandard budget value, which replaces MonthlyBudgetDivideDailyAcrossMonth.

Conversion Tracking

Remove the ConversionTrackingScript element from the Campaign data object. Campaign level conversion tracking scripts were deprecated February 2012. Scripts which are already deployed can track conversions and are not retrievable via API after version 7 sunsets. Manage account level campaign analytics scripts instead with the following service operations.

Negative Keywords and Negative Site Urls

Remove the NegativeKeywords and NegativeSiteUrls elements from Campaign and AdGroup data objects.

To get or set the negative keywords and site URLs for a campaign or ad group, you now call the following operations respectively.

Language, Region, and Network Settings

Remove the LanguageAndRegion element of the AdGroup object.

The LanguageAndRegion element of the AdGroup object has been replaced by union of the Language element and location targeting. If you remove the LocationTarget, the campaign or ad group’s ads would serve worldwide. For more information about creating location targets, see Target Locations.

Remove the GetNetworksByAdGroupIds and SetNetworksToAdGroups operations. To specify the search network where ads are displayed in version 8, use the ad group’s Network element.

Language of GetNormalizedStrings

Update the Language element of the GetNormalizedStringsRequest Message Object from a Language value set type to a string type. Remove any references to the Language value set altogether. For a list of language strings that you may use, see Language Values.

AdGroupInfo and CampaignInfo

Remove the AdGroupInfo and CampaignInfo data objects, and the corresponding GetAdGroupsInfoByCampaignId and GetCampaignsInfoByAccountId service operations. These light-weight operations are no longer supported since the corresponding entities no longer contain negative keywords and site URLs, and the amount of data within AdGroup and Campaign objects is reduced.

Cashback

Remove all references to the CashBackStatus value set and CashBackInfo data object. This feature is no longer supported.

Behavioral and User Segment Targeting

The behavioral and user segment targeting features are no longer supported.

Remove the following operations related to behavioral targeting.

  • AddBehavioralBids

  • DeleteBehavioralBids

  • GetBehavioralBidsByAdGroupId

  • GetBehavioralBidsByIds

  • PauseBehavioralBids

  • ResumeBehavioralBids

  • UpdateBehavioralBids

Remove the following operations related to user segment targeting.

  • AddSegments

  • DeleteSegments

  • DeleteUsersFromSegment

  • GetCustomSegments

  • GetSegments

  • GetSegmentsByIds

  • SetUsersToSegments

Remove the behavior and segment elements from the Target Data Object.

Remove any references to the OverridePriority element of the Keyword Data Object. Because segment targeting was removed, the dynamic substitution values that expand the text, title, and display URL of an ad now come only from the Keyword object.

GetKeywordEstimatesByBids

Remove the GetKeywordEstimatesByBids service operation and instead use the new version 8 Ad Intelligence Web service, which you may use to determine the historical performance of keywords, get the estimated bid and position for a keyword, and to get suggested keywords from an existing keyword or from the content at a specified URL.

New in Version 8

New Features

Description

Ad Extensions

Campaign management service version 8 supports ad extensions. Ad extensions let you decorate text ads with additional information that helps customers find relevant information about your products and services. For example, you may include deep links into your website to quickly direct your customers to relevant promotional or technical information that may help increase conversions.

The following service operations are available to manage ad extensions.

The call and location ad extensions are used to include a business’ location and phone number in a text ad. Because AdExtension is being replaced in early 2013, you should use the call and location ad extensions.

For more information, see Ad Extensions.

System_CLiX_note Note

Site link ad extensions are generally available in the United States. To use call, location, and product ad extensions, you must be a member of the pilot program.

Ad Rotation

Campaign management service version 8 supports ad rotation. You may now specify how you want your ads rotated within an ad group. Previously, the best performing ads were rotated into the auction. Now you may continue favoring best performing ads or you may request that ads be rotated evenly into the auction.

Favoring best performing ads reduces the likelihood that new ads will be rotated into the auction in the near future. If you add seasonal ads or if you want to experiment with the ad copy of underperforming ads, you should request that ads be rotated evenly into the auction to get the ads in front of customers.

Use the following operations to get and set the type of ad rotation applied to an ad group.

Product Ads from Bing Shopping

Campaign management service version 8 supports a new ad type called a product ad. A product ad includes promotional text, details about a product from the advertiser’s Bing Shopping account, and an image.

System_CLiX_note Note

To create product ads, you must be a member of the pilot program.

Editorial Appeals

Campaign management service version 8 supports editorial appeals. If an ad or keyword fails editorial review, and the failure is appealable, you may call the AppealEditorialRejections operation to appeal the rejection.

To find ads or keywords that failed the editorial review process, call the GetAdsByEditorialStatus or GetKeywordsByEditorialStatus operation, respectively.

To determine the reason for the failure and whether it’s appealable, call the GetEditorialReasonsByIds operation. The operation returns an EditorialReasonCollection object which includes an AppealStatus element. The rejection is appealable if the status is set to Appealable. For possible status values, see AppealStatus.

Location Exclusions

Campaign management service version 8 supports location exclusions, and you may now exclude locations from a location target. For example, if you target the U.S., you may exclude one or more states from being targeted. To exclude a location from a target location, call the SetExclusionsToAssociatedEntities operation. For details, see Exclude Locations from a Location Target.

To get a list of locations that have been excluded from a location target, call the GetExclusionsByAssociatedEntityIds operation.

Physical Intent

Campaign management service version 8 supports physical intent settings. The HasPhysicalIntent element was added to the LocationTarget Data Object. This element determines whether the user must be physically located in the targeted location in order for the ad to display. If true, the user must be physically present in the targeted location. The default is false.

Tablet, Smartphone, and Operating System Targets

Campaign management service version 8 supports targeting for tablet and smartphone devices and operating systems. By default, ads will target tablet devices, in addition to your current list of devices e.g. computers and smartphones. Choose whether to target your ads to run on tablets. If you target tablets, you may optionally specify the operating system of the tablets to target. Also, if you target smartphones, you may now specify the operating system of the smartphones to target.

The following are the operations to use to manage the tablet and smartphone devices that you target. For more information about using these operations including backward compatibility, see the Remarks section of DeviceTarget.

Customer Billing

Breaking Changes

Required Changes

Description

Proxy Client

Update your proxy client to use the new endpoint address and namespace.

The service address is https://sharedservices.adcenterapi.microsoft.com/Api/Billing/v8/CustomerBillingService.svc?wsdl.

The namespace is https://adcenter.microsoft.com/api/customerbilling.

New in Version 8

New Features

Description

GetAccountMonthlySpend

Customer billing service version 8 supports a new service operation named GetAccountMonthlySpend.

Customer Management

Breaking Changes

Required Changes

Description

Proxy Client

Update your proxy client to use the new endpoint address and namespace.

The service address is https://sharedservices.adcenterapi.microsoft.com/Api/CustomerManagement/v8/CustomerManagementService.svc?wsdl.

The namespace is https://adcenter.microsoft.com/api/customermanagement.

Customer

Update the following Customer Data Object elements.

  • Replace FinancialStatus with CustomerFinancialStatus.

  • Replace Status with CustomerLifeCycleStatus.

  • Replace the Market element with MarketCountry and MarketLanguage elements. These elements determine the default country and language respectively for ad groups in the customer’s campaigns.

Account

Update the following Account Data Object elements.

  • Replace FinancialStatus with AccountFinancialStatus.

  • Replace Status with AccountLifeCycleStatus.

AccountInfo

Update the following AccountInfo Data Object element.

  • Replace Status with AccountLifeCycleStatus.

User

Update the following User Data Object elements.

  • Replace Status with UserLifeCycleStatus.

  • Replace the name of the UserStatus value set with UserLifeCycleStatus value set.

  • Replace all references of UserStatus with UserLifeCycleStatus. For example, the data type of the UserLifeCycleStatus element of the User object and the StatusFilter element of the GetUsersInfoRequest service operation should be updated.

New in Version 8

New Features

Description

Enhanced Account and Customer Search

Use the following new service operations to retrieve by customer or account filters.

LCID and Language Value Sets

New LCID and Language values are available.

The LCID Value Set documentation contains the full list of LCID values.

The LanguageType Value Set documentation contains the full list of language values.

New Value for AccountLifeCycleStatus

The value of Pending has been added to the AccountLifeCycleStatus Value Set. An account will be in pending status if for example there is no associated payment method.

New Value for Industry

The value of Pharmaceuticals has been added to the Industry Value Set.

Reporting

Breaking Changes

Required Changes

Description

Proxy Client

Update your proxy client to use the new endpoint address and namespace.

The service address is https://adcenterapi.microsoft.com/Api/Advertiser/v8/Reporting/ReportingService.svc?wsdl.

The namespace is https://adcenter.microsoft.com/v8.

Participation Rate

Remove the ParticipationRate value from the BudgetSummaryReportColumn Value Set. This performance indicator is no longer available.

New in Version 8

New Features

Description

Ad Extension Report

You may use the following new reports to get statistics about the effectiveness of the ad extensions you've included in your ads.

  • AdExtensionByAdsReportRequest aggregates performance data by ad for a specified time period. By including performance details, such as clicks, conversion, and spend, you may identify ad extensions that are performing well, and those that may need to be adjusted to optimize the monthly budget.

  • AdExtensionByKeywordReportRequest aggregates performance data by keyword for a specified time period. By including performance details, such as clicks, conversion, and spend, you may identify ad extensions that are performing well, and those that may need to be adjusted to optimize the monthly budget.

  • AdExtensionDimensionReportRequest lists all versions of an ad extension by account. You may use this information along with the performance data from the other two reports to determine which version performed better.

Change History Report

The change history report shows you the campaign entities that you have access to that have been added or deleted. In addition, the report includes the old and new value of the entities whose values have been updated. For more information, see SearchCampaignChangeHistoryReportRequest Data Object. For a list of entities and elements that the report can include, see the Remarks section in SearchCampaignChangeHistoryReportColumn Value Set.

Keyword Migration Report

The keyword migration report shows you the list of your keyword objects that were included in the keyword migration process. The migration process creates new keyword objects for keywords that contain more than one match-type bid. The result is that each keyword object will contain a unique keyword and match-type combination.

The report will include a row for the original keyword object that shows the match type that it retained, and a row for each new keyword and match-type combination created from the original keyword object. If the object was created from another keyword object, the report shows the identifier of the original keyword object.

For more information, see KeywordMigrationReportRequest Data Object.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.