Method: projects.thumbnails.create Stay organized with collections Save and categorize content based on your preferences.
Page Summary
The
thumbnails.createmethod generates an ID for a thumbnail image based on an expression and output options, used withthumbnails.getPixelsto retrieve image data.This two-part process is more versatile than
ComputePixels, allowing the resulting image to be displayed directly by a browser and enabling broader access tothumbnails.getPixelswith an API key.Images must meet specific format requirements, such as having one or three output bands for JPEG or PNG, with values clipped to the 0-255 range.
While named "thumbnail", there are no size restrictions beyond limits on uncompressed data (48MB), dimensions (32K pixels in either direction), and bands (1024).
Requests are made via a POST request to the specified endpoint, requiring appropriate IAM permissions and OAuth scopes for authorization.
Creates an ID that can be used to render a "thumbnail" image.
This is used in conjunction withthumbnails.getPixels. A call tothumbnails.create provides an expression and some output options. The result ofthumbnails.create is an ID that represents an image that is the result of evaluating that expression and applying those options. Subsequently, calls tothumbnails.getPixels can be made to get the image data for the entire resulting image. The ID will be valid for a moderate period (a few hours).
The most common use case for this pair of endpoints is to provide a complex expression via a POST tothumbnails.create, and then fetch the computed image via a GET tothumbnails.getPixels. This two-part process allows for use in more situations thanComputePixels. In particular: - the result ofComputePixels needs to be unwrapped to get the encoded image bytes. The result ofthumbnails.getPixels can be displayed directly by a browser. -ComputePixels can only be called by an authorised user, using a properly-scoped OAuth token.thumbnails.create has the same restriction, butthumbnails.getPixels can be invoked with a URL containing an API key, so URLs invoking it can be used more broadly.
The result of evaluating the expression 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.
The description "thumbnail" does not imply a restriction on the size of the computed image: the same restrictions asComputePixels apply tothumbnails.create/thumbnails.getPixels. Requests are limited to 48MB in uncompressed data per request, computed as the product of the request dimensions in pixels, the number of image bands requested, and the number of bytes per pixel for each band. Requests are also limited to at most 32K pixels in either dimension and at most 1024 bands. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).
HTTP request
POST https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/thumbnails
The URL usesgRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent |
Required. The parent of the thumbnail collection (e.g., "projects/*"). Authorization requires the followingIAM permission on the specified resource
|
Query parameters
| Parameters | |
|---|---|
workloadTag |
User supplied tag to track this computation. |
Request body
The request body contains an instance ofThumbnail.
Response body
If successful, the response body contains a newly created instance ofThumbnail.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/earthenginehttps://www.googleapis.com/auth/earthengine.readonlyhttps://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-platform.read-only
For more information, see theOAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.