Method: projects.videoThumbnails.create

  • The videoThumbnails.create method generates an ID for an animated image composed of multiple images from an ImageCollection.

  • This ID is used with videoThumbnails.getPixels to retrieve the animated image, which shows the ImageCollection elements animating from first to last.

  • The generated ID is valid for a few hours and the request is limited to 512*512*100 pixels across all images.

  • Exceeding the pixel limit will result in a 400 (BAD_REQUEST) error.

  • The HTTP request is a POST to https://earthengine.googleapis.com/v1beta/{parent=projects/*}/videoThumbnails, requiring specific IAM permissions on the parent resource.

Creates an ID that can be used to render an image containing an animation of multiple images from a collection.

This is used in conjunction with videoThumbnails.getPixels. A call to videoThumbnails.create provides an expression and some output options. The result of videoThumbnails.create is an ID that represents an image that is the result of evaluating that expression and applying those options. Subsequently, calls to videoThumbnails.getPixels can be made to get an image showing all of the elements of an ImageCollection, animated from first to last. The ID will be valid for a moderate period (a few hours).

The request is limited to 512*512*100 pixels in total, across all Images in the ImageCollection. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).

HTTP request

POST https://earthengine.googleapis.com/v1beta/{parent=projects/*}/videoThumbnails

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of the location where the video thumbnail will be created (e.g., "projects/*").

Authorization requires the following IAM permission on the specified resource parent:

  • earthengine.videothumbnails.create

Query parameters

Parameters
workloadTag

string

User supplied tag to track this computation.

Request body

The request body contains an instance of VideoThumbnail.

Response body

If successful, the response body contains a newly created instance of VideoThumbnail.

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.