Export (0) Print
Expand All

Understanding Bing Maps Transactions

Bing

When you use any Bing Maps API with a Bing Maps Key (you must have a Bing Maps Account), transactions are recorded. Transactions track API usage and can be billable or non-billable. For example, using the Bing Maps AJAX Control, Version 7.0 to show a map on a web page or geocoding an address using the Bing Maps REST Services are both billable transactions, while deleting a data source (a spatial database that you create using the Bing Spatial Data Services) is not.

You can find descriptions of the transactions for each Bing Maps API in the tables below, and you can view transaction totals over time on the Bing Maps Account Center. For more information, see Viewing Usage Reports. Note that it may take up to 24 hours for new transactions to appear.

Billable versus non-billable transactions

Only billable transactions count towards the free-use limits for Basic and Trial keys, and Enterprise keys are only charged for billable transactions. Non-billable transactions do not incur charges and do not count towards free-use limits. To determine if your application will qualify for free use and for more about licensing and transaction limits, use the Help Me Decide licensing Tool and read the Bing Maps Terms of Use.

Using Session IDs to make billable transactions non-billable

In the following description, Bing Maps services refer to Bing Maps REST Services, Bing Spatial Data Services1, and Bing Maps SOAP Services. Bing Maps controls refer to Bing Maps AJAX Control 7.0, Bing Maps Silverlight Control, Bing Maps WPF Control, and Bing Maps for Windows Store apps.

Bing Maps service requests are not billable when you make the request from a Bing Maps control and you use a session ID in place of a Bing Maps Key to authenticate your request. For example, if you make a Bing Maps REST Services request to geocode an address from the Bing Maps AJAX Control 7.0 control and use the Map.GetGredentials method to get the session ID for authentication, the resulting transaction is recorded as non-billable even though it is listed as a billable transaction in the table below.

You must use the Bing Maps Key that you used to load the map control to request a session ID. This session ID is only valid for the map control session. For the web-based Bing Maps AJAX v7 and Silverlight controls, a session begins with the load of the map into a user’s browser and ends when the browser is closed or the user moves to a different page. Similarly for the WPF and Windows Store app map controls, a session begins when the map control is loaded by the application and ends when the application is closed. For more information about how to get a session ID from the Bing Maps Key, see Using the REST Services with .NET and AJAX v7 Map Class. Note that if you make service requests with a Bing Maps Key instead of a session ID within the session, you will be charged for all billable requests.

Ff859477.note(en-us,MSDN.10).gifNote:
1 Bing Spatial Data Services transactions have two exceptions to free-use within sessions:

  • All Bing Spatial Data Services transactions become billable when you reach ten (10) million transactions within a year, even when you use a session ID.

  • Bing Spatial Data Services batch geocode transactions (Dataflow:BatchGeocode) become billable when you reach one (1) million batch geocode transactions within a year, even when you use a session ID.

Bing Maps Transactions by API

The following tables define transactions for all the APIs.

Map Control APIs (AJAX v7, Bing Maps for Windows Store apps, WPF Control, Silverlight)

Category Bing Maps API Billable Category Description

AjaxSession

AJAX Control

Yes

Any time a session that uses Bing Maps AJAX Control 6.3 or Version 7.0, is started with a valid Bing Maps Key, one transaction is counted. A session begins with the load of the Bing Maps AJAX Control into a user’s browser and ends when the browser is closed or the user moves to a different page.

All SOAP, REST or Spatial Data2 service requests that use a session ID are not billable when they are made from within a session. Map tile usage within a session is tracked separately. See Map Tile Usage.

WinStoreAppSession_JavaScript_V1


WinStoreAppSession_JavaScript (for Windows 8 Beta and Preview versions)

Windows Store apps

Yes

Any time a session that uses Bing Maps SDK for Windows Store apps using JavaScript is started with a valid Bing Maps Key, one transaction is counted. A session begins with the load of the Bing Maps for JavaScript control into a user’s browser and ends when the browser is closed or the user moves to a different page.

All SOAP, REST or Spatial Data2 service requests that use a session ID are not billable when they are made from within a session. Map tile usage within a session is tracked separately. See Map Tile Usage.

WinStoreAppSession_CSharp_VB_CPP_V1


WinStoreAppSession_CSharp_VB_CPP (Windows 8 Beta and Preview versions)

Windows Store apps

Yes

Any time an application session that uses Bing Maps SDK for Windows Store apps for C#, C++, or Visual Basic is started with a valid Bing Maps Key, one transaction is counted. An application session begins with the load of Bing Maps for Windows Store apps for C#, C++, or Visual Basic control in an application and ends when the application is closed.

All SOAP, REST or Spatial Data2 service requests that use a session ID are not billable when they are made from within an application session. Map tile usage within an application session is tracked separately. See Map Tile Usage.

SilverlightSession


SilverlightSessionBeta (for beta release of the control)

Silverlight Control

Yes - SilverlightSession


No – SilverlightSessionBeta

Any time a session that uses the Bing Maps Silverlight Control is started with a valid Bing Maps Key, one transaction is counted. A session begins with the load of the Bing Maps Silverlight Control into a user’s browser and ends when the browser is closed or the user moves to a different page.

All SOAP, REST or Spatial Data2 service requests that use a session ID and all map tile downloads are not billable when they are made from within a session.

WPFSession

WPF Control

Yes

Any time an application session is started and uses the Bing Maps WPF Control with a valid Bing Maps Key, one transaction is counted. An application session begins with the load of the Bing Maps WPF Control by the application and ends when the application is closed.

All SOAP, REST or Spatial Data2 service requests that use a session ID and all map tile downloads are not billable when they are made from within a session.

WindowsPhoneSession_PublicApp

Silverlight Control for Windows Phone

No

Any time a session begins with the launch of an application that uses the Bing Maps Silverlight Control for Windows Phone, one transaction is counted. This includes all map control interactions and map tile downloads that occur within the application and that use the same session ID until the application is closed.

iOSSession

iOS Control

Yes

Any time an application session is started and uses the Bing Maps iOS Control with a valid Bing Maps Key, one transaction is counted. An application session begins with the load of the Bing Maps iOS Control by the application and includes all Bing Maps iOS Control interactions until the application is closed.

All SOAP, REST or Spatial Data2 service requests that use a session ID and all map tile downloads are not billable when they are made from within an application session.

2All Spatial Data Services requests over one (1) million per year are billable even when a session ID is used.

Map Tile Usage

Category Bing Maps API Billable Category Description

AJAXTileUsage

AJAX Control

No

Anytime a session that uses Bing Maps AJAX Control 6.3 or Version 7.0 with a valid Bing Maps Key, a value that represents map tile usage is logged. This value is the maximum of all map tile downloads during the session divided by eight (8). A session begins with the load of Bing Maps AJAX Control and ends when the browser is closed or the user moves to a different page. For an example map tile usage calculation, see Map Tile Usage Example.

WinStoreApp_JS_TileUsage

Windows Store apps

No

Anytime an application session that uses the Bing Maps SDK for Windows Store apps using JavaScript downloads map tiles with a valid Bing Maps Key, a value that represents map tile usage is logged. This value is the maximum of all map tile downloads during the application session divided by eight (8). An application session begins with the load of the Bing Maps for Windows Store apps using JavaScript control and ends when the browser is closed or the user moves to a different page. For an example map tile usage calculation, see Map Tile Usage Example.

WinStoreApp_CSharp_VB_CPP_TileUsage

Windows Store apps

No

Anytime an application session that uses the Bing Maps SDK for Windows Store apps using C#, C++, or Visual Basic downloads map tiles with a valid Bing Maps Key, a value that represents map tile usage is logged. This value is the maximum of all map tile downloads during the application session divided by eight (8). An application session begins with the load of Bing Maps for Windows Store apps for C#, C++, or Visual Basic and ends when the application is closed. For an example map tile usage calculation, see Map Tile Usage Example.

LoadStandardMap

Yes

Anytime a map tile URL is used to download a map tile using a Bing Maps Key, the download is logged. For every eight (8) map tiles that are downloaded, one transaction is counted.

This transaction does not apply when you download tiles from within a Windows Store or AJAX application.

LoadTrafficMap

Yes

Anytime a traffic tile URL is used to download a traffic tile using a Bing Maps Key, the download is logged. For every eight (8) traffic tiles that are downloaded, one transaction is counted.

This transaction does not apply when you download tiles from within a Windows Store or AJAX application.

Map Tile Usage Example

The following example shows how map tile usage is calculated for AJAX and Windows Store apps.

Consider a browser session that uses Bing Maps AJAX version 7.0 to download map imagery with the following map tile downloads.

  1. Display a map: Download x map tiles.

  2. Zoom the map: Download y map tiles.

  3. Display a second map at another location: Download z map tiles.

  4. Close the browser window: End the browser session.

At the end of the session, the number of map tile usage transactions is equal to the maximum of the map tile downloads divided by 8. Note that this can be a fractional value.

Map tile usage transactions = Maximum(x, y, z)/8.0.

If x=40, y=60, and z=50, then the map tile usage would be Maximum(40,60,50)/8.0 = 60/8.0= 7.5 transactions.

REST Services

Category Bing Maps API Billable Category Description

RESTLocations

REST Services

Yes3

Any time a Locations API URL request is made to geocode or reverse-geocode location data, one transaction is counted.

Anytime a Query API URL request is made with an address string that must be geocoded, one transaction is counted.

RESTElevations

REST Services

Yes3

Any time an Elevations API URL request is made to get elevation data, one transaction is counted.

RESTImagery

REST Services

Yes3

Any time an Imagery API URL request is made to get a static map, to get static map metadata or to get imagery metadata that contains a map tile URI, one transaction is counted.

RESTImagery-BasicMetadata

REST Services

No

Any time an Imagery API URL request is made to get basic imagery metadata that does not contain a map tile URI, one transaction is counted.

RESTRoutes

REST Services

Yes3

Any time a Routes API URL request is made to find a route, one transaction is counted.

RESTTraffic

REST Services

Yes3

Any time a Traffic API URL request is made to get traffic incident information, one transaction is counted.

3This transaction is not billable if the service request is made using a session ID from an AJAX Control, Silverlight Control, WPF Control, Windows Store app for JavaScript, or Windows Store app for C#, C++, or Visual Basic session.

Spatial Data Services and Data Source Management using the Bing Maps Account Center

Category Bing Maps API Billable Category Description

Dataflow:BatchGeocode

Spatial Data Services

No4,6

Any time a request is made to Upload Spatial Data and Create a Geocode Job, a set of transactions equal to the number of total entities in the geocode request are counted.

Any time a data source is geocoded using the Bing Maps Account Center, a set of transactions equal to the number of total entities in the geocode request are counted.

Dataflow:Create

Spatial Data Services

No6

Any time a URL request is made to create a dataflow job to batch geocode entity data by using the Upload Spatial Data and Create a Geocode Job API, one transaction is counted.

Any time a URL request is made to stage, publish or rollback a data source by using the Create a Load Data Source Job and Input Entity Data API, one transaction is counted.

Any time a data source is geocoded or published by using the Bing Maps Account Center, one transaction is counted.

Dataflow:Get

Spatial Data Services

No6

Any time a URL request is made to Get Status of a Geocode Job, one transaction is counted.

Any time a URL request is made to Get Status of a Load Data Source Job, one transaction is counted.

Any time a URL request is made to Get Download Status, one transaction is counted.

Any time a data source is geocoded or published by using the Bing Maps Account Center, one transaction is counted.

Dataflow:Download

Spatial Data Services

No6

Any time a URL request is made to Download Geocode Job Results, one transaction is counted.

Any time the geocoded results of non-published data source entity data are downloaded using the Bing Maps Account Center, one transaction is counted.

Note that if you download successful and failed results, these are two separate Dataflow:Download transactions.

RESTSpatialDataService:GetAllMetadata

Spatial Data Services

No6

Any time a URL request is made to Get Data Source Information that returns metadata for all data sources that are associated with a Bing Maps Account, one transaction is counted.

RESTSpatialDataService:GetDataSource

Spatial Data Services

No6

Any time a URL request is made to Get Data Source Information that returns general information about one or more versions of a single data source, one transaction is counted.

RESTSpatialDataService:GetDataSourceMetadata

Spatial Data Services

No6

Any time a URL request is made to Get Data Source Information that returns metadata for one or more versions of a single data source, one transaction is counted.

RESTSpatialDataService:

ListDataSources

Spatial Data Services

No6

Any time a URL request is made to Get Data Source Information that returns general information about all data sources associated with a Bing Maps Account, one transaction is counted.

RESTSpatialDataService:DownloadDatasource

Spatial Data Services

No6

Any time a URL request is made to Create a Download Job, one transaction is counted.

Any time a URL request is made to Get Downloaded Data, one transaction is counted.

Any time a published, staged or previous version of a data source is downloaded using the Bing Maps Account Center, one transaction is counted.

RESTSpatialDataService:DeleteDataSource

Spatial Data Services

No6

Any time a URL request is made to Delete a Data Source, one transaction is counted.

Any time a data source is deleted using the Bing Maps Account Center, one transaction is counted.

RESTSpatialDataService:Query

Spatial Data Services

Yes5,6

Any time a Query API URL request is made to query a data source, one transaction is counted.

When a Query by Area URL request is made with an address string that must be geocoded, one RESTLocations transaction is also counted.

RESTSpatialDataService:Geodata

Spatial Data Services

No6

Any time a Geodata URL request is made to get boundary data, one transaction is counted.

When a Geodata URL request is made with an address string that must be geocoded, one RESTLocations transaction is also counted.

4Spatial Data Services batch geocode transactions are free up to 1 million transactions per year for a Bing Maps Account. After you reach 1 million transactions in a year, these transactions become billable.

5This transaction is not billable if the service request is made using a session ID from an AJAX Control, Silverlight Control, WPF Control, Windows Store app for JavaScript, or Windows Store app for C#, C++, or Visual Basic session, and the total number of Spatial Data Services transactions is less that 10 million per year for a Bing Maps Account.

6Spatial Data Services requests become billable when you reach 10 million transactions within a year for a Bing Maps Account even when a session ID is used.

SOAP Services

Category Bing Maps API Billable Category Description

WS: Geocode

SOAP Services

Yes7

Any time a request is made using the GeocodeServiceClient.Geocode Method method, one transaction is counted.

WS: ReverseGeocode

SOAP Services

Yes7

Any time a request is made using the GeocodeServiceClient.ReverseGeocode Method, one transaction is counted.

WS: Get ImageryMetadata

SOAP Services

No

Any time a request is made using the ImageryServiceClient.GetImageryMetadata Method, one transaction is counted.

WS: GetMapUri

SOAP Services

Yes7

Any time a request is made using the ImageryServiceClient.GetMapUri Method, one transaction is counted.

WS: CalculateRoute

SOAP Services

Yes7

Any time a request is made using the RouteServiceClient.CalculateRoute Method , one transaction is counted.

WS: CalculateRoutesFromMajorRoads

SOAP Services

Yes7

Any time a request is made using the RouteServiceClient.CalculateRoutesFromMajorRoads Method and the MajorRoutesOptions.ReturnRoutes Property is set to false, one transacation is counted.

Anytime a request is made using the RouteServiceClient.CalculateRoutesFromMajorRoads Method and the MajorRoutesOptions.ReturnRoutes Property is set to true, one transaction for the request and additional transactions for each returned route are counted.

WS: Search

SOAP Services

Yes7

Any time a request is made using the SearchServiceClient.Search Method, one transaction is counted.

WS: PhotoSynthView

SOAP Services

Yes7

Any time a Synth associated with a Windows Live ID that corresponds to an enterprise Photosynth account is viewed, one transaction is counted. Every Synth is associated with a Windows Live ID.

7This transaction is not billable if the service request is made using a session ID from an AJAX Control, Silverlight Control, WPF Control, Windows Store app for JavaScript, or Windows Store app for C#, C++, or Visual Basic session.

Viewing Usage Reports

Follow these steps to view a transaction history for a Bing Maps Key and its associated applications.

  1. Log in to http://www.bingmapsportal.com using the Windows Live ID you used to create your Bing Maps Account.

  2. Click the View my Bing Maps API usage menu in the navigation bar on the left.

  3. Click Usage Report to view a timeline that summarizes billable and non-billable Bing Maps Key usage.

    Click Usage Report by Category to get Bing Maps Key usage details by category.

    Click Usage Report by Bing Maps Key to get Bing Maps API usage for a specified Bing Maps Key.

    Usage reports open in a separate window.

Additional Notes

To change the range of dates for the report, set the Start Date and End Date fields, and then click View Report.

To export the data in the report, select a format in the drop-down list, and then click Export.

Show:
© 2014 Microsoft