This page is only for customers with the new version of the Google Maps APIs Premium Plan, which became available in January 2016.
Have the Premium Plan or a previous license?
To determine which license you have (for Maps APIs for Work or Maps API for Business):
> In the Google Cloud Support Portal, click Maps: Usage Report on the left.
> Does the ID at the top of the report have the following format?
gme-[company] & proj-[number] ([type])
If yes, you have the Premium Plan. If no, you have a previous license.
The Google Maps Usage Reports tool helps you track your application's usage of Google Maps Platform and its consumption of Maps APIs Credits. With the tool, you can view detailed daily and monthly reports on all APIs included with your Google Maps APIs Premium Plan. Report data is available for API requests that include either a client ID or a project ID.
Note: The Usage Reports tool provides the same information as Google uses to determine your application's usage for billing purposes.
Types of reports
Successful Requests report
This report shows your application's total requests per day or per month for each API. Use this report to compare usage across different time periods to identify trends and peak usage times. In addition, you can use the Successful Requests report to view the following data:
- Request errors: For each API, the daily report also shows the number of successful and unsuccessful requests (errors); for web service APIs that your application accesses using a client ID, the report also shows error codes, which are useful for troubleshooting.
- Channel data: If you include the channel parameter in your requests, you can generate a Successful Requests report that shows a breakdown of your application's API requests across different applications that use the same client ID (such as externally facing access vs. internally facing access). By using channels, you can generate reports with more detailed data on how your application is used.
Maps APIs Credits report
This report shows your application's total credits consumption per day or per month for all APIs combined. Use this report to determine how many credits to purchase. For information about how your application consumes credits see Usage Rates and Limits.
- Easy-to-read graphs: Daily reports provide graphs to help you visualize
usage trends over time. You can see report details by hovering your pointer over the graph.
- Historical data: View reports for any time period within the past year.
- Downloadable data: Download monthly requests and credits totals to a comma-separated values (CSV) file for further analysis using a spreadsheet or business intelligence tools, or to share the data with others.
- Data drill-down: Access daily reports directly from monthly reports, by
clicking the monthly totals or column headings in the report. For example:
Accessing the Usage Reports
To access the Google Maps Usage Reports:
- Log in to the Google Cloud Support Portal.
- In the left panel, click Maps: Usage Report.
The default report is the monthly Successful Requests report for the past 12 months. To generate different reports, use the report filters:
||Available only if you have multiple client IDs. Select the client ID for which you want to view reports.|
||Available only for Successful Requests reports. Select a channel for which you want to see usage data. Or select Show all to see usage data for all channels.|
|From / To||Select a date range of up to 1 year for the report. Click Update to generate a new report.|
|Type of report
||Select the Successful Requests or Maps APIs Credits report.|
|Select time granularity||Choose the Monthly or Daily report. Monthly reports also contains links to daily reports. Daily reports show both successful and unsuccessful requests and error codes.|
|API type||Available only for daily reports. Select the API for which you want to see a report.|
Frequently Asked Questions
Successful Request report
- How long will it take for usage data to show up on the reports?
Reports data is not available in real-time. Usage data for requests that use a client ID is processed on a daily basis. Because report dates are based on Pacific Standard Time, you might see a delay of up to a couple of days. Data for requests that use an API key requires additional processing, and can take up to four days to appear in the reports.
- Why don't the number of map loads match access statistics on our web servers?
Here are some reasons why the number of map loads on a page differs from the number of hits to that URL in your web server's logs:
- Maps usage can vary on a page: A map load is generated whenever
google.maps.Mapobject is created on a page. When comparing map load reports with your web server's access statistics, carefully analyze the usage of maps on each of your web pages to look for causes for discrepancies, such as:
- A page has more than one map, so multiple Map objects were created.
- A page doesn't display a map, but the Map object was still created. This can occur, for
example, if the Map object is attached to a hidden HTML
- A page requires a user to take an action (such as click a button) to display a map. If a user didn't take that action, a Map object wasn't created.
- A page doesn't have any maps, so the Map object wasn't created.
- Time zones are different: Reports are derived from logs set to
the Pacific Time Zone.
You can analyze your server logs based on the Pacific Time Zone to reduce any offset caused by
logging in your local time zone.
- HTML is cached: Map loads are not cached. If a user reloads your page, the reload will generate another map load to obtain a session token. However, in this case, the browser might load the HTML from the cache, causing the number of map loads to be higher than the number of hits in your server logs.
- Maps usage can vary on a page: A map load is generated whenever the
- Why are requests higher than expected for the Distance Matrix API?
The Distance Matrix API report shows the number of elements (origin-destination pairs) instead of requests. For details about elements, see the developer's guide.
- How do I view my application's request errors?
Generate a Successful Requests daily report, then choose an API from the API type list. You'll see a graph and table that show the number of successful and unsuccessful requests your application made; for web service APIs your application accesses using a client ID, you'll also see the status codes returned by those requests:
- What do the status codes mean?
The usage reports tool shows status codes for web service APIs that your application accesses using a client ID. You can find descriptions of the codes in the developer's guide for each API:
The Geolocation API, Places API, and Roads API always require an API key. For these and other APIs that your application accesses using a key, check your Developers Console for status codes.
- Do errors consume Maps APIs Credits?
No, requests that receive an error code don't consume credits. However, the requests that receive the
ZERO_RESULTScodes do consume credits.
- What are channels?
To track usage across different applications using the same client ID, you can use the
channelparameter with your API requests. By specifying different
channelvalues for different aspects of your application, you can determine precisely how your application is used.
For example, your external website might access an API using a
customer, while your internal marketing department might use a
mkting. Your reports will break down usage of the API by those channel values.
- Which APIs support channels?
- How many channels can I use?
You can use up to 2,000 distinct channels per client ID.
- How do I set up channels for my application's requests?
Make sure the
channelvalue in your requests meets the following requirements:
- Must be an ASCII alphanumeric string.
- Can include an underscore (_) and hyphen (-) character.
- Is case-insensitive: Upper-case and mixed-case
channelparameters are merged into their lower-case equivalent. For example, usage on the
CUSTOMERchannel will be combined with the usage of the
- Must be a static and assigned per application instance (it can't be generated dynamically). For example, you can't use channel values to track individual users.
Add the channel parameter to your requests, as follows:
Append the channel parameter to the src value of your script tag:
<script src="https://maps.googleapis.com/maps/api/js?v=3 &client=gme-yourclientid &channel=your_channel"></script>
Maps Static and Street View Static APIs
Include this channel parameter in the request URL:
https://maps.googleapis.com/maps/api/staticmap ?center=15.800513,-47.91378 &zoom=11 &size=300x300 &client=gme-yourclientid &channel=your_channel &signature=your_signature
Include this channel parameter in the request URL:
https://maps.googleapis.com/maps/api/geocode/json ?address=101+Main+St &client=gme-yourclientid &channel=your_channel &signature=your_signature
Maps APIs Credits report
- What are Maps APIs Credits?
Your application's requests to APIs consume Maps APIs Credits from a pool of credits you purchase with your Google Maps APIs Premium Plan. For more information about credits and how your application consumes them, see see Usage Rates and Limits.
- How long will it take for credits data to show up on the reports?
Credits consumption data for Google Maps Usage Reports requires processing and can take up to 3 days to appear in the reports.