Required request parameters

  • All Maps Datasets API requests require a Google Cloud project number or ID for billing and usage quota, specified in the X-Goog-User-Project header or using a service account.

  • An OAuth token is necessary for authentication and should be included in the Authorization header of each request.

  • The request URL must contain the Google Cloud project number or ID and the dataset ID to specify the location of the dataset.

  • Additional parameters may be required for certain requests, as detailed in the specific request documentation.

  • You can obtain your Google Cloud project number or ID from the project's Overview page in the Cloud Console and generate an OAuth token using the gcloud command.

To make any request to Maps Datasets API, you must include:

  • The number or ID of your Google Cloud project in the X-Goog-User-Project header of the request. This value determines the project used for billing and usage quota calculations.

  • An OAuth token in the Authorization header of the request. For more information about using OAuth with Maps Datasets API, see Use OAuth.

  • A Google Cloud project number or ID in the request URL. This value specifies the project containing the dataset. While this project is usually the same as the project specified in the X-Goog-User-Project header, it is not required to be the same.

  • The dataset ID in the request URL. Whenever you perform an action on a specific dataset, you pass the ID of the dataset as part of the request URL.

For example, to delete a dataset:

curl -X DELETE \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID

Get the project number

To get the PROJECT_NUMBER_OR_ID of your Google Cloud project:

  1. Go to the project's Overview page in the Cloud console.

  2. If prompted, select your project.

  3. The Project number and Project ID appear in the Project info area of the overview screen.

Get an OAuth token

For authentication, your API request must contain an OAuth token in the Authorization header. For more, see Use OAuth.

For example, use the following gcloud command to generate the token:

gcloud auth application-default print-access-token

You can include the gcloud command directly in the Authorization header in a cURL command to generate a new token on each request, as shown in the example above.

Alternatively, you can set an environment variable containing the token and then pass the environment variable as part of the request:

export TOKEN=$(gcloud auth application-default print-access-token)
curl -X DELETE \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID