Set up the Maps SDK for iOS

Page Summary

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

• You can create an API key through the Google Cloud Console or by using the Cloud SDK.

• Google strongly recommends restricting your API keys to enhance security by limiting their usage to only the necessary APIs for your application.

• You can restrict API keys by application and API, with application restrictions taking precedence.

• Once you have obtained your API key, you can proceed to create and configure your Xcode project for Maps SDK for iOS.

This document describes the steps needed to start using the Maps SDK for iOS.

Prerequisites

This procedure guides you through setting up a Google Cloud Account and Google Cloud project with billing enabled. You should also be familiar with how you are charged for using the Maps SDK for iOS.

1. Review billing and cost for usage at Maps SDK for iOS Usage and Billing.

2. Verify that you have a Google Cloud Account.

   Sign in to the Google Cloud console
   Note: If you are a new user and don't have a Google Cloud Account, meaning you cannot sign in to the console, see Getting started with Google Maps Platform.

3. Verify that you have a Google Cloud project with billing enabled.

   Go to the Billing page
   Note: If you are a new user and don't have a Google Cloud project, see Getting started with Google Maps Platform.
1. Select your project to open the Billing page.

2. On the Billing page:

   • If billing is already enabled for the selected project, and you only have a single billing account, then the Billing page opens.
   • If you have multiple billing accounts, select Go to linked billing account to see the details about the billing account associated with the project.
   • If a billing account exists but is not associated with the project, you are prompted to link a billing account with the project.
   • If no billing account exists, or you want to create a new billing a account, select Manage Billing Accounts to create a new billing account. For more information, see Create a new self-serve Cloud Billing account.

Enable the SDK

Before you can use Maps SDK for iOS, you must use the Google Cloud console or the gcloud command to enable it in your Google Cloud project.

Note: After you enable an SDK, you might have to wait a few minutes before you can make a request to it.

To enable the SDK:

Console

1. Open the product page in the Google Cloud console:

   Enable the Maps SDK for iOS

2. Click the Enable button.

   Note: If Maps SDK for iOS is already enabled, you see the Manage button instead of Enable.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "maps-ios-backend.googleapis.com"

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

• gcloud services enable
• gcloud services disable

Configure API key

Google Maps Platform products are secured from unauthorized use by requiring API calls to include an API key.

Get an API key for use with Maps SDK for iOS

An API key is a unique alphanumeric string that associates your Cloud Billing account and Google Cloud project with the request your application makes to a Google Maps Platform API or SDK. To create a new key or add an API or SDK to an existing key, follow these instructions.

Console

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

   Go to the Keys & Credentials page

2. If prompted, select your project.

3. Do one of the following:

   • Create a new key:

     1. Click Create credentials > API key.
     2. In the Create API key panel, open the Select API restrictions list.
     3. Clear any APIs that this key doesn't need, and make sure Maps SDK for iOS stays selected.
     4. Click Create. The panel displays your new API key.

   • Use an existing key:

     1. Click the name of the key.
     2. In the Select API restrictions list, select Maps SDK for iOS.
     3. Click Save.

   Selecting an API here doesn't enable it. Make sure Maps SDK for iOS is enabled on its API Library page.

4. To see the key string later, go to the Keys & Credentials page and click Show key for the key.

If the console looks different from these steps, see Create an API key and Add API restrictions in the Google Cloud documentation.

gcloud

Replace PROJECT_ID with your project ID in the following commands.

• Create a new key: Run the following command, and replace DISPLAY_NAME with a name for the key.

  gcloud services api-keys create \
      --project="PROJECT_ID" \
      --display-name="DISPLAY_NAME" \
      --api-target=service=maps-ios-backend.googleapis.com

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

  • gcloud services api-keys create

• Use an existing key: Run the following command, and replace KEY_ID with the ID of the key. The --append flag keeps the APIs that the key already allows. Without it, the command replaces them.

  gcloud services api-keys update KEY_ID \
      --project="PROJECT_ID" \
      --append \
      --api-target=service=maps-ios-backend.googleapis.com

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

  • gcloud services api-keys update
  • gcloud services api-keys list

  The key ID isn't the key string or display name. To find it, run gcloud services api-keys list --project="PROJECT_ID". The ID is the last part of the name field: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

To see the key string, run gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Apply API key restrictions

Caution: An unrestricted API key can be used to make a request to any Google Maps Platform service, including the Maps SDK for iOS. You are financially responsible for charges caused by abuse of unrestricted API keys.

Google strongly recommends that you restrict your API keys by limiting their usage to only the APIs and apps that need them. Restricting API keys adds security to your application by protecting it from unwarranted requests. API keys support two types of restrictions:

• API restrictions specify which SDKs and APIs can be called using the API key. The console and the gcloud CLI require at least one API restriction when you create a key.
• Application restrictions specify which websites, IP addresses, or apps can use an API key.

For more information about applying restrictions, see Restrict your API keys.

What's next

Now that you have enabled Maps SDK for iOS and configured an API key, see Set up an Xcode project to learn more how to configure Xcode and how to pass the API key to your app.