Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
Method: projects.assets.listAssets
Stay organized with collections
Save and categorize content based on your preferences.
Lists any container asset, such as a folder or collection.
HTTP request
GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*/assets/**}:listAssets
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. The name of the container asset to list. parent is of the format "projects/*" or "projects/*/assets/**" (e.g., "projects/[PROJECT]" or "projects/earthengine-legacy/assets/users/[USER]/[ASSET]"). All user-owned assets are currently 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"). If "projects/earthengine-legacy" is specified, the response will consist of a list of all top-level folders owned by the requesting user.
Authorization requires one or more of the following IAM permissions on the specified resource parent :
earthengine.assets.get
earthengine.assets.list
|
Query parameters
Parameters |
pageSize |
integer
The maximum number of results per page. The server may return fewer assets than requested. If unspecified, the page size default depends on the EarthEngineAssetView, with higher limits for more restrictive views.
|
pageToken |
string
A token identifying a page of results the server should return. Typically this is the value of ListAssetsResponse.next_page_token returned from the previous call to the assets.listAssets method.
|
filter |
string
If present, specifies a filter. Filters are only applied to ImageCollection assets and are ignored for Folder assets. The fields startTime , endTime , and members of properties are recognized. The custom function intersects(str) is available, which allows filtering by geometry. An example date filter:
"startTime>\"2020-01-01T00:00:00+00:00\" AND
endTime<\"2020-02-01T00:00:00+00:00\""
An example property filter:
"properties.CLOUDY_PIXEL_PERCENTAGE<30"
An example geometry filter:
"intersects(\"{'type':'Point','coordinates':[1,2]}\")"
"intersects(\"{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[1,2]}\")"
See https://google.aip.dev/160 for more details on the filter language.
|
view |
enum (EarthEngineAssetView )
Specifies which parts of the EarthEngineAsset resource should be returned in the response. Only applies to ImageCollection assets. All elements of Folder assets will be encoded in the BASIC view regardless of the value of this field.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListAssetsResponse
.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eLists container assets, such as folders or collections, within a specified parent resource.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by properties like startTime, endTime, and custom properties for ImageCollections.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large result sets using pageSize and pageToken.\u003c/p\u003e\n"],["\u003cp\u003eRequires appropriate IAM permissions or OAuth scopes for authorization.\u003c/p\u003e\n"],["\u003cp\u003eOffers different views to control the amount of data returned for ImageCollections.\u003c/p\u003e\n"]]],["This outlines how to list container assets (folders/collections) using a `GET` request to `listAssets`. Key actions include specifying the `parent` asset path, which determines the scope of the list. Optional query parameters allow for: `pageSize` to limit results, `pageToken` for pagination, `filter` to refine `ImageCollection` asset results by date, properties, or geometry, and `view` to select returned parts of `ImageCollection`. A successful response contains `ListAssetsResponse`. Authorization requires specific IAM permissions and OAuth scopes.\n"],null,["# Method: projects.assets.listAssets\n\nLists any container asset, such as a folder or collection.\n\n### HTTP request\n\n`GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*/assets/**}:listAssets`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the container asset to list. `parent` is of the format \"projects/\\*\" or \"projects/\\*/assets/\\*\\*\" (e.g., \"projects/\\[PROJECT\\]\" or \"projects/earthengine-legacy/assets/users/\\[USER\\]/\\[ASSET\\]\"). All user-owned assets are currently 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\"). If \"projects/earthengine-legacy\" is specified, the response will consist of a list of all top-level folders owned by the requesting user. Authorization requires one or more of the following [IAM](https://cloud.google.com/iam/docs/) permissions on the specified resource `parent`: - `earthengine.assets.get` - `earthengine.assets.list` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results per page. The server may return fewer assets than requested. If unspecified, the page size default depends on the EarthEngineAssetView, with higher limits for more restrictive views. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically this is the value of [ListAssetsResponse.next_page_token](/earth-engine/reference/rest/v1alpha/ListAssetsResponse#FIELDS.next_page_token) returned from the previous call to the `assets.listAssets` method. |\n| `filter` | `string` If present, specifies a filter. Filters are only applied to `ImageCollection` assets and are ignored for `Folder` assets. The fields `startTime`, `endTime`, and members of `properties` are recognized. The custom function `intersects(str)` is available, which allows filtering by geometry. An example date filter: \"startTime\u003e\\\"2020-01-01T00:00:00+00:00\\\" AND endTime\u003c\\\"2020-02-01T00:00:00+00:00\\\"\" An example property filter: \"properties.CLOUDY_PIXEL_PERCENTAGE\u003c30\" An example geometry filter: \"intersects(\\\"{'type':'Point','coordinates':[1,2]}\\\")\" \"intersects(\\\"{\\\\\\\"type\\\\\\\":\\\\\\\"Point\\\\\\\",\\\\\\\"coordinates\\\\\\\":[1,2]}\\\")\" See \u003chttps://google.aip.dev/160\u003e for more details on the filter language. |\n| `view` | `enum (`[EarthEngineAssetView](/earth-engine/reference/rest/v1alpha/EarthEngineAssetView)`)` Specifies which parts of the `EarthEngineAsset` resource should be returned in the response. Only applies to `ImageCollection` assets. All elements of `Folder` assets will be encoded in the `BASIC` view regardless of the value of this field. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListAssetsResponse](/earth-engine/reference/rest/v1alpha/ListAssetsResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/earthengine.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]