Frequently Asked Questions

This article contains answers to some frequently asked questions about the Bing Ads API.

Get Help

Q. Where can I get help?

The developer forum provides a way for the developer community to ask and answer questions about developing solutions with Bing Ads APIs, to showcase innovations, and to generate and maintain content through community participation. Microsoft monitors the forums and replies to questions that the community has not yet answered.

If you are not finding the information you need to solve your problem in the developer forum, please contact Microsoft Advertising Support. To resolve the issue efficiently, please provide support with the details requested in Engaging Support.

Q. How can I find out about changes?

The Release Notes and Migration Guide are great resources to start with.

You can sign up for the monthly newsletter via the News tab of the Developer Portal, and that's also where the latest blog announcements are aggregated.

Get Started

Q. What are the requirements to use the Bing Ads API?

To get started, you need to sign up for a Microsoft Advertising account, and then get your developer token at via the Account tab of the Developer Portal.

Q. Which programming languages and SDKs are supported?

You can develop Bing Ads API applications with any programming language that supports web services. The Bing Ads API Software Development Kits (SDK) enhance the experience of developing Bing Ads API applications with .NET, Java, PHP, and Python languages. Each SDK includes a proxy to all Bing Ads API web services and abstracts low level details of authentication with OAuth. You can use the high level BulkServiceManager and ReportingServiceManager interfaces to abstract and execute operations in the low level Bulk and Reporting services.

We have heard requests for additional SDKs e.g. Perl and Ruby, although there is no plan to add support in the near term.

Q. How can I view code samples in different programming languages?

In addition to the Code Examples and services Reference sections, you'll find code snippets in many of the technical guides e.g., the Get Started guide. You can use the language selector at the top or right of those pages to view examples in CSharp, Java, Php, or Python. When you choose a language, the setting is retained as you navigate other pages. The language selector will only include languages that have samples for that specific page, and will default to C# if the language you had previously set is not available for the page that you navigated to.

Q. Which API version should I use?

You should always use the latest version as soon as we announce support via the blog or release notes.

Q. How can I view documentation and code examples for different versions of the API?

To navigate between versions, use the version selector near the table of contents at the top and left side of the page.

API Docs Version Selector

The view query string parameter will be updated and appended to the URL e.g., ?view=bingads-13. By default when you navigate to a page without any view query string parameter, the content for the latest generally available version will be shown even when a higher API version is available for preview.

Feature Availability

Q. Should I use the Bulk or Campaign Management API?

The Bulk service is recommended, especially if you need to add or update ads and keywords across multiple ad groups or campaigns in an account. Some features are not available in Bulk e.g. AddUetTags, GetBMCStoresByCustomerId, GetGeoLocationsFileUrl, and GetMediaMetaDataByAccountId. For these features of course you must use the Campaign Management service.

Q. Which API performance reports are available and when will my data be available?

The Reporting service supports most of the same report types that you can find in the Microsoft Advertising web application. Be sure to check out the Report Attributes and Performance Statistics and Reporting Data Retention Time Periods guides for availability details.

When a user clicks an ad, it can take up to two hours for the system to process the click (3 hours for conversions) and make it available for reporting. When all data for the previous day have been processed and made available for reporting, this state is referred to as Books Closed. For more information about when the books are closed for reporting, see Time Zones in Reporting.

OAuth

Q. I want to run my application without user interaction. How can I authenticate without getting prompted for permission to use Microsoft Advertising credentials?

To programatically manage a Microsoft Advertising account, you must provide consent at least once through the web application consent flow. For repeat or long term authentication, you should follow the authorization code grant flow for obtaining an access token and refresh token. Thereafter you can use the latest refresh token to request new access and refresh tokens without any further user interaction. You may need to request user consent again for example, if the Microsoft Account owner went through account recovery, changed their password, or otherwise removed permissions for your application to authenticate on their behalf.

Q. When do the access and refresh tokens expire?

The access token typically expires after one hour, although you should always check the expiration time each time you request a new token.

Refresh tokens are, and always will be, completely opaque to your application. They are long-lived e.g., 90 days for public clients, but the app should not be written to expect that a refresh token will last for any period of time. Refresh tokens can be invalidated at any moment, and the only way for an app to know if a refresh token is valid is to attempt to redeem it by making a token request. Even if you continuously refresh the token on the same device with the most recent refresh token, you should expect to start again and request user consent if, for example you signed the user out, the Microsoft Account user changed their password, removed a device from their list of trusted devices, or removed permissions for your application to authenticate on their behalf. At any time without prior warning Microsoft may determine that user consent should again be granted. As a best practice you should always securely store the latest refresh token each time you request new access and refresh tokens.

Q. Why do I need an access token and developer token?

The access token represents the user credentials who has access to one or more Microsoft Advertising accounts. The application ID (a.k.a. client_id) identifies your application for each Microsoft Advertising user who grants consent. The developer token gives your application permission to use the Bing Ads API.

Brand

Q. Will Bing Ads API be rebranded along with the Microsoft Advertising platform?

Bing Ads is now Microsoft Advertising. Our new name reflects how we're growing our advertising solutions to help you reach more customers. To avoid any friction for clients onboarding to Bing Ads API version 13 during calendar year 2019, there are no plans to rebrand any of the current API versions. The table below lists names that either have or haven't changed. For more information please see the brand announcement.

Previous Name Current Name
Ad Preview and Diagnostic Tool Ad Preview and Diagnostic Tool
Bing Ads Microsoft Advertising
Bing Ads Accredited Professionals Bing Ads Accredited Professionals
Bing Ads API Bing Ads API
Bing Ads App Microsoft Advertising App
Bing Ads Content API Bing Ads Content API
Bing Ads Editor Microsoft Advertising Editor
Bing Ads Fans Microsoft Advertising Fans
Bing Ads Intelligence Microsoft Advertising Intelligence
Bing Ads Partner Microsoft Advertising Partner
Bing Ads Scripts Microsoft Advertising Scripts
Bing Ads SDK Bing Ads SDK
Bing Hotel Center Microsoft Hotel Center
Bing Merchant Center Microsoft Merchant Center
Bing Network Microsoft Advertising Network
Bing Network syndication Microsoft Advertising Partner sites
Bing Partner Awards Microsoft Advertising Partner Awards
Bing Partner Program Microsoft Advertising Partner Program
Bing Shopping Campaigns Microsoft Shopping Campaigns
Keyword Planner Keyword Planner
Hotel Ads Hotel Ads
Hotel API Hotel API