Method: projects.assets.listImages

Lists the images in an image collection asset. This method allows the caller to apply spatiotemporal and metadata filters to an image collection.

HTTP request

GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*/assets/**}:listImages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The name of the image collection asset to list. parent is of the format "projects/*/assets/**" (e.g., "projects/earthengine-legacy/assets/users/[USER]/[ASSET]"). All user-owned assets are under the project "earthengine-legacy" (e.g., "projects/earthengine-legacy/assets/users/foo/bar"). All other assets are under the project "earthengine-public" (e.g., "projects/earthengine-public/assets/LANDSAT").

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • earthengine.assets.get
  • earthengine.computations.create

Query parameters

Parameters
pageSize

integer

An optional maximum number of results per page. The server may return fewer assets than requested. If unspecified, the page size default is 1000 reesults per page.

pageToken

string

An optional token identifying a page of results the server should return. Typically, this is the value of

ListImagesResponse.next_page_token returned from the previous call to the assets.listImages method.

startTime

string (Timestamp format)

If present, filters results to those whose timestamp is at least this value (inclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

If present, filters results to those whose timestamp is less than this value (exclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

region

string

If present, a geometry defining a query region, specified as a GeoJSON geometry string (see RFC 7946). Spatial intersection is accurate to one meter.

filter

string

If present, specifies additional simple property filters.

view

enum (EarthEngineAssetView)

Specifies which parts of the Image resource should be returned in the response. If unset the default is to return all properties.

Request body

The request body must be empty.

Response body

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

Response message for EarthEngineService.ListImages.

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

object (Image)

The list of images matching the query.

nextPageToken

string

A token to retrieve the next page of results. Pass this value in the

ListImagesRequest.page_token field in the subsequent call to the assets.listImages 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 Authentication Overview.

Image

Information about an Earth Engine image.

JSON representation
{
  "name": string,
  "id": string,
  "updateTime": string,
  "title": string,
  "description": string,
  "properties": {
    object
  },
  "startTime": string,
  "endTime": string,
  "geometry": {
    object
  },
  "bands": [
    {
      object (ImageBand)
    }
  ],
  "sizeBytes": string
}
Fields
name

string

The name of the image, if present. name is of the format "projects/*/assets/**" (e.g. "projects/earthengine-legacy/assets/users//"). This should typically be present for stored images, but will be the empty string for computed ones.

id

string

The ID of the image, if present. Equivalent to name without the "projects/*/assets/" prefix (e.g. "users//"). This should typically be present for stored images, but will be the empty string for computed ones.

updateTime

string (Timestamp format)

The last-modified time of the image.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

title

string

The title of the asset.

description

string

The description of the asset.

properties

object (Struct format)

Key/value properties associated with the image.

startTime

string (Timestamp format)

The timestamp associated with the image, if any, e.g. the time at which a satellite image was taken. For assets that correspond to an interval of time, such as average values over a month or year, this timestamp corresponds to the start of that interval.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

For assets that correspond to an interval of time, such as average values over a month or year, this timestamp corresponds to the end of that interval (exclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

geometry

object (Struct format)

The spatial footprint associated with the image, if any, as a GeoJSON geometry object (see RFC 7946).

bands[]

object (ImageBand)

Information about the data bands of the image.

sizeBytes

string (int64 format)

The size of a leaf asset (e.g. an image) in bytes. This should typically be non-zero for stored images, and zero for computed ones.