Announcement: On November 13, 2024, all users will need to use a Cloud project in order to access Earth Engine. After this date, continued individual access without a Cloud project will require an exception.

Method: projects.video.export

Initiates a batch process that computes a video and writes the result to one of several destinations.

HTTP request

POST https://earthengine.googleapis.com/v1beta/{project=projects/*}/video:export

The URL uses gRPC Transcoding syntax.

Path parameters

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`

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

JSON representation
{ "expression": { object (`Expression`) }, "description": string, "videoOptions": { object (`VideoOptions`) }, "fileExportOptions": { object (`VideoFileExportOptions`) }, "requestId": string, "workloadTag": string, "priority": integer }

{
  "expression": {
    object (Expression)
  },
  "description": string,
  "videoOptions": {
    object (VideoOptions)
  },
  "fileExportOptions": {
    object (VideoFileExportOptions)
  },
  "requestId": string,
  "workloadTag": string,
  "priority": integer
}

Fields
`expression`	`object (Expression)` An expression that evaluates to the video to compute and export, represented as an image collection.
`description`	`string` A human-readable name of the task.
`videoOptions`	`object (VideoOptions)` Basic options describing the video to generate.
`fileExportOptions`	`object (VideoFileExportOptions)` Options for where and in what form to export the video.
`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.
`workloadTag`	`string` User supplied label to track this computation.
`priority`	`integer` Optional. The priority of the export task within the project. Higher priority tasks are scheduled sooner. Must be an integer between 0 and 9999. Defaults to 100 if not set.

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.

VideoFileExportOptions

Options for exporting videos as files outside Earth Engine.

JSON representation

JSON representation
{ "fileFormat": enum (`VideoFileFormat`), // Union field `destination` can be only one of the following: "driveDestination": { object (`DriveDestination`) }, "cloudStorageDestination": { object (`CloudStorageDestination`) } // End of list of possible types for union field `destination`. }

{
  "fileFormat": enum (VideoFileFormat),

  // Union field destination can be only one of the following:
  "driveDestination": {
    object (DriveDestination)
  },
  "cloudStorageDestination": {
    object (CloudStorageDestination)
  }
  // End of list of possible types for union field destination.
}

Fields
`fileFormat`	`enum (VideoFileFormat)` The file format in which to export the video(s). Currently only MP4 is supported.
Union field `destination`. Where to write the results. `destination` can be only one of the following:
`driveDestination`	`object (DriveDestination)` If specified, configures export to Google Drive.
`cloudStorageDestination`	`object (CloudStorageDestination)` If specified, configures export to Google Cloud Storage.