Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
REST Resource: projects.thumbnails
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Thumbnail
Information about a thumbnail.
| Fields |
name |
string
The resource name representing the thumbnail, of the form "projects/*/thumbnails/**" (e.g. "projects/earthengine-legacy/thumbnails/").
|
expression |
object (Expression)
The expression to compute. Must evaluate to an Image.
|
fileFormat |
enum (ImageFileFormat)
The output encoding in which to generate the resulting image.
|
bandIds[] |
string
If present, specifies a specific set of bands that will be selected from the result of evaluating expression. If not present, all bands resulting from expression will be selected.
|
visualizationOptions |
object (VisualizationOptions)
If present, a set of visualization options to apply to produce an 8-bit RGB visualization of the data.
|
grid |
object (PixelGrid)
An optional pixel grid describing how the image computed by expression is reprojected and clipped.
|
filenamePrefix |
string
Only used when fileFormat is ZIPPED_GEO_TIFF or ZIPPED_GEO_TIFF_PER_BAND.
|
Methods |
|
|
Creates an ID that can be used to render a "thumbnail" image. |
|
|
Computes an image showing the result of a computation. |
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\u003eThumbnails are representations of images, generated by evaluating an expression that results in an image.\u003c/p\u003e\n"],["\u003cp\u003eThey can be customized with visualization options, band selections, and reprojection/clipping using a pixel grid.\u003c/p\u003e\n"],["\u003cp\u003eThumbnail creation involves providing parameters like expression, file format, and optionally visualization options, band IDs, grid, and filename prefix.\u003c/p\u003e\n"],["\u003cp\u003eUsers can initiate thumbnail creation and retrieve image data using designated API methods.\u003c/p\u003e\n"]]],["Thumbnails are created with a name, an expression that evaluates to an image, and a specified file format. Band IDs can be selected from the expression's result, and visualization options can be applied for 8-bit RGB output. A pixel grid can define image reprojection and clipping. A filename prefix is used for ZIPPED_GEO_TIFF output. The `create` method generates a thumbnail ID, and `getPixels` computes and renders the image.\n"],null,["# REST Resource: projects.thumbnails\n\nResource: Thumbnail\n-------------------\n\nInformation about a thumbnail.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"expression\": { object (/earth-engine/reference/rest/v1/Expression) }, \"fileFormat\": enum (/earth-engine/reference/rest/v1/ImageFileFormat), \"bandIds\": [ string ], \"visualizationOptions\": { object (/earth-engine/reference/rest/v1/VisualizationOptions) }, \"grid\": { object (/earth-engine/reference/rest/v1/PixelGrid) }, \"filenamePrefix\": string } ``` |\n\n| Fields ||\n|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource name representing the thumbnail, of the form \"projects/\\*/thumbnails/\\*\\*\" (e.g. \"projects/earthengine-legacy/thumbnails/\"). |\n| `expression` | `object (`[Expression](/earth-engine/reference/rest/v1/Expression)`)` The expression to compute. Must evaluate to an Image. |\n| `fileFormat` | `enum (`[ImageFileFormat](/earth-engine/reference/rest/v1/ImageFileFormat)`)` The output encoding in which to generate the resulting image. |\n| `bandIds[]` | `string` If present, specifies a specific set of bands that will be selected from the result of evaluating `expression`. If not present, all bands resulting from `expression` will be selected. |\n| `visualizationOptions` | `object (`[VisualizationOptions](/earth-engine/reference/rest/v1/VisualizationOptions)`)` If present, a set of visualization options to apply to produce an 8-bit RGB visualization of the data. |\n| `grid` | `object (`[PixelGrid](/earth-engine/reference/rest/v1/PixelGrid)`)` An optional pixel grid describing how the image computed by `expression` is reprojected and clipped. |\n| `filenamePrefix` | `string` Only used when fileFormat is ZIPPED_GEO_TIFF or ZIPPED_GEO_TIFF_PER_BAND. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------|---------------------------------------------------------------|\n| ### [create](/earth-engine/reference/rest/v1/projects.thumbnails/create) | Creates an ID that can be used to render a \"thumbnail\" image. |\n| ### [getPixels](/earth-engine/reference/rest/v1/projects.thumbnails/getPixels) | Computes an image showing the result of a computation. |"]]