Use API Keys

Google Maps Platform products are secured from unauthorized use by restricting API calls to those that provide proper authentication credentials. These credentials are in the form of an API key - a unique alphanumeric string that associates your Google billing account with your project, and with the specific API or SDK.

This guide shows how to create, restrict, and use your API Key for Google Maps Platform.

Before you begin

Before you start using the Maps Embed API, you need a project with a billing account and the Maps Embed API enabled. To learn more, see Set up in Cloud console.

Create API keys

The API key is a unique identifier that authenticates requests associated with your project for usage and billing purposes. You must have at least one API key associated with your project.

To create an API key:

Console

  1. Go to the Google Maps Platform > Credentials page.

    Go to the Credentials page

  2. On the Credentials page, click Create credentials > API key.
    The API key created dialog displays your newly created API key.
  3. Click Close.
    The new API key is listed on the Credentials page under API keys.
    (Remember to restrict the API key before using it in production.)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Read more about the Google Cloud SDK , Cloud SDK installation , and the following commands:

Restrict API keys

Google strongly recommends that you restrict your API keys by limiting their usage to those only APIs needed for your application. Restricting API keys adds security to your application by protecting it from unwarranted requests. For more information, see API security best practices.

To restrict an API key:

Console

  1. Go to the Google Maps Platform > Credentials page.

    Go to the Credentials page

  2. Select the API key that you want to set a restriction on. The API key property page appears.
  3. Under Key restrictions, set the following restrictions:
    • Application restrictions:
      1. To accept requests from the list of websites that you supply, select HTTP referers (web sites) from the list of Application restrictions.
      2. Specify one or more referrer websites. You can use wildcard characters to authorize all subdomains (for example, https://*.google.com accepts all sites ending in .google.com when accessed over HTTPS). Note that if you specify www.domain.com, it acts as a wildcard www.domain.com/*, and authorizes any subpath on that hostname. Only the https:// and http:// referrer schemes are supported.
    • API restrictions:
      1. Click Restrict key.
      2. Select Maps Embed API from Select APIs dropdown. If the Maps Embed API is not listed, you need to enable it.
      3. If your project uses Places Library, also select Places API. Similarly, if your project uses other services in the JavaScript API (Directions Service, Distance Matrix Service, Elevation Service, and/or Geocoding Service), you must also enable and select the corresponding API in this list.
  4. To finalize your changes, click Save.

Cloud SDK

List existing keys. 

gcloud services api-keys list --project="PROJECT"

Clear existing restrictions on existing key. 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Set new restrictions on existing key. 

gcloud alpha services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=maps-embed-backend.googleapis.com
    --allowed-referrers="referer"

Read more about the Google Cloud SDK , Cloud SDK installation , and the following commands:

Add the API key to your request

You must include an API key with every Maps Embed API request. In the following example, replace YOUR_API_KEY with your API key. 

  https://www.google.com/maps/embed/v1/MAP_MODE?key=YOUR_API_KEY&parameters