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 |
The name of the image collection asset to list. Authorization requires one or more of the following IAM permissions on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
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 |
An optional token identifying a page of results the server should return. Typically, this is the value of
|
startTime |
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: |
endTime |
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: |
region |
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 |
If present, specifies additional simple property filters. |
view |
Specifies which parts of the |
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 ( |
Fields | |
---|---|
images[] |
The list of images matching the query. |
nextPageToken |
A token to retrieve the next page of results. Pass this value in the
|
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 ( |
Fields | |
---|---|
name |
The name of the image, if present. |
id |
The ID of the image, if present. Equivalent to |
updateTime |
The last-modified time of the image. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
title |
The title of the asset. |
description |
The description of the asset. |
properties |
Key/value properties associated with the image. |
startTime |
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: |
endTime |
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: |
geometry |
The spatial footprint associated with the image, if any, as a GeoJSON geometry object (see RFC 7946). |
bands[] |
Information about the data bands of the image. |
sizeBytes |
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. |