Method: projects.imageCollection.computeImages

  • The imageCollection:computeImages method computes features from one or more tables and returns the results as a list of images.

  • This method is accessed via a POST request to the specified URL, using gRPC Transcoding syntax.

  • The request requires a project path parameter for authorization, which needs the earthengine.computations.create IAM permission.

  • The request body includes parameters like expression for the computation, pageSize for pagination, and pageToken for retrieving subsequent pages.

  • The response body contains a list of images and a nextPageToken for fetching additional results.

  • Authorization requires specific OAuth scopes related to Earth Engine or Cloud Platform access.

Computes a set of features by applying an arbitrary computation to features in one or more tables. Results are returned as a list of images.

HTTP request

POST https://earthengine.googleapis.com/v1/{project=projects/*}/imageCollection:computeImages

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.computations.create

Request body

The request body contains data with the following structure:

JSON representation 
{
  "expression": {
    object (Expression)
  },
  "pageSize": integer,
  "pageToken": string,
  "workloadTag": string
}
Fields
expression

object (Expression)

The expression to compute.
pageSize

integer

The maximum number of results per page. The server may return fewer images than requested. If unspecified, the page size default is 1000 results per page.
pageToken

string

A token identifying a page of results the server should return. Typically, this is the value of ComputeImagesResponse.next_page_token returned from the previous call to the imageCollection.computeImages method.
workloadTag

string

User supplied tag to track this computation.

Response body

Response message for EarthEngineService.ComputeImages.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "images": [
    {
      object (EarthEngineAsset)
    }
  ],
  "nextPageToken": string
}
Fields
images[]

object (EarthEngineAsset)

The list of images matching the query.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the ComputeImagesRequest.page_token field in the subsequent call to the imageCollection.computeImages method to retrieve the next page of results.

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.