Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
Method: projects.locations.maps.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates an ID that can be used to render map tiles showing the results of a computation. The resulting ID should be used as part of GetTile requests.
This is used in conjunction with GetTile. A call to maps.create provides an expression and some output options. The result of maps.create is a map ID that represents an image that is the result of evaluating that expression and applying those options. Subsequently, calls to GetTile can be made to get image data for a tile of the resulting image, at any desired location and zoom. The map ID will be valid for a moderate period (a few hours).
The most common use case for this pair of endpoints is to populate a map viewport with a visualization of the output of some computation. In order for that to be possible, the computation output has to meet some reasonable requirements for the requested image format. In particular, JPEG or PNG format requires that there be one or three output bands, and clips values that are outside the 0-255 range.
HTTP request
POST https://earthengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/maps
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent of the map collection (e.g., "projects/*").
Authorization requires the following IAM permission on the specified resource parent:
|
Query parameters
| Parameters |
workloadTag |
string
User supplied tag to track this computation.
|
Request body
The request body contains an instance of EarthEngineMap.
Response body
If successful, the response body contains a newly created instance of EarthEngineMap.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/earthengine
https://www.googleapis.com/auth/earthengine.readonly
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eGenerates a unique map ID for rendering map tiles based on computed results.\u003c/p\u003e\n"],["\u003cp\u003eThis ID is used with \u003ccode\u003eGetTile\u003c/code\u003e requests to retrieve image data for specific map locations and zoom levels.\u003c/p\u003e\n"],["\u003cp\u003eMap IDs are temporary and remain valid for a few hours.\u003c/p\u003e\n"],["\u003cp\u003ePrimarily used to visualize computation outputs on a map, requiring the output to be compatible with the image format (e.g., JPEG or PNG).\u003c/p\u003e\n"],["\u003cp\u003eRequires specific IAM permissions and authorization scopes for access and usage.\u003c/p\u003e\n"]]],["`maps.create` generates a map ID by evaluating an expression and applying output options. This ID, valid for a few hours, is used in `GetTile` requests to retrieve image data for specific tiles at any location and zoom. The computation output must have one or three bands for JPEG/PNG format, with values clipped to 0-255. The request requires a parent project, and an optional workload tag. The response provides a new map ID. It uses POST method and requires an authentication scope.\n"],null,["# Method: projects.locations.maps.create\n\nCreates an ID that can be used to render map tiles showing the results of a computation. The resulting ID should be used as part of `GetTile` requests.\n\nThis is used in conjunction with `GetTile`. A call to `maps.create` provides an expression and some output options. The result of `maps.create` is a map ID that represents an image that is the result of evaluating that expression and applying those options. Subsequently, calls to `GetTile` can be made to get image data for a tile of the resulting image, at any desired location and zoom. The map ID will be valid for a moderate period (a few hours).\n\nThe most common use case for this pair of endpoints is to populate a map viewport with a visualization of the output of some computation. In order for that to be possible, the computation output has to meet some reasonable requirements for the requested image format. In particular, JPEG or PNG format requires that there be one or three output bands, and clips values that are outside the 0-255 range.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/maps`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent of the map collection (e.g., \"projects/\\*\"). Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `earthengine.maps.create` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------|\n| `workloadTag` | `string` User supplied tag to track this computation. |\n\n### Request body\n\nThe request body contains an instance of [EarthEngineMap](/earth-engine/reference/rest/v1alpha/projects.locations.maps#EarthEngineMap).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [EarthEngineMap](/earth-engine/reference/rest/v1alpha/projects.locations.maps#EarthEngineMap).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/earthengine.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]