Method: projects.videoMap.export

Initiates a batch process that computes a tiled video map and writes the result to Google Cloud Storage.

HTTP request

POST https://earthengine.googleapis.com/v1alpha/{project=projects/*}/videoMap:export

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is projects/{project-id}.

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

  • earthengine.exports.create

Request body

The request body contains data with the following structure:

JSON representation
{
  "expression": {
    object (Expression)
  },
  "description": string,
  "videoOptions": {
    object (VideoOptions)
  },
  "tileOptions": {
    object (TileOptions)
  },
  "tileExportOptions": {
    object (VideoFileExportOptions)
  },
  "requestId": string,
  "version": enum (Version)
}
Fields
expression

object (Expression)

An expression that evaluates to the image collection to compute and export as a video. The bounds of the first image will be used to determine the set of video map tiles to render. To control the exported region, clip the images prior to exporting.

description

string

An optional human-readable name of the task.

videoOptions

object (VideoOptions)

Basic options describing the videos to generate.

tileOptions

object (TileOptions)

Options describing the video map tiles to generate.

tileExportOptions

object (VideoFileExportOptions)

Options for where and in what form to export the video tiles. Cloud Storage is currently the only supported destination for video map exports.

requestId

string

A unique string used to detect duplicated requests. If more than one request is made by the same user with the same non-empty requestId, only one of those requests may successfully start a long-running operation. requestId may contain the characters a..z, A..Z, 0-9, or '-'. requestId may be at most 60 characters long.

version

enum (Version)

The version of videoMap.export to use.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/earthengine
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/devstorage.full_control

For more information, see the Authentication Overview.

Version

Identifies the intended viewer client (Earth Engine Timelapse or Google Earth). If unspecified, defaults to V2.

Enums
VERSION_UNSPECIFIED Unspecified.
V1 Generate video tiles compatible with Google Earth on Web.
V2 Generate video tiles compatible with Earth Engine Timelapse viewer client.