Method: projects.datasets.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
تمام مجموعه داده ها را برای پروژه مشخص شده فهرست می کند.
درخواست HTTP
GET https://mapsplatformdatasets.googleapis.com/v1/{parent=projects/*}/datasets
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
parent | string مورد نیاز. نام پروژه برای فهرست کردن همه مجموعه داده ها. قالب: پروژه ها/{پروژه} |
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer حداکثر تعداد مجموعه داده برای بازگشت در هر صفحه. اگر نامشخص (یا صفر) باشد، تمام مجموعه داده ها برگردانده می شوند. |
pageToken | string نشانه صفحه، از یک فراخوان قبلی databases.list دریافت شده است. این را برای بازیابی صفحه بعدی ارائه کنید. |
tag | string برچسبی که نسخه مورد نظر را برای هر مجموعه داده مشخص می کند. توجه داشته باشید که وقتی صفحهبندی نیز مشخص میشود، ممکن است برخی فیلترها پس از صفحهبندی اتفاق بیفتد، که ممکن است باعث شود پاسخ حاوی مجموعه دادههای کمتری نسبت به اندازه صفحه باشد، حتی اگر آخرین صفحه نباشد. برچسب "فعال": هر مجموعه داده در پاسخ شامل اطلاعات آخرین نسخه تکمیل شده خود می شود و اگر مجموعه داده ای نداشته باشد از آن صرفنظر می شود. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
شی پاسخ مجموعه داده ها.list.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"datasets": [
{
object (Dataset )
}
],
"nextPageToken": string
} |
فیلدها |
---|
datasets[] | object ( Dataset ) تمام مجموعه داده های پروژه |
nextPageToken | string نشانه ای که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM
به مجوز IAM زیر در منبع parent
نیاز دارد:
-
mapsplatformdatasets.datasets.list
برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eLists all datasets within a specified Google Cloud project, returning details like dataset information and pagination tokens for accessing further results.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size, page token, and version tag to customize the dataset retrieval process.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003emapsplatformdatasets.datasets.list\u003c/code\u003e IAM permission on the target project.\u003c/p\u003e\n"],["\u003cp\u003eUses a simple HTTP GET request with path and query parameters to specify the project and filtering criteria.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing an array of datasets and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"]]],["This document outlines the process of listing datasets within a specified project. It uses a `GET` request to the provided URL, including the project name as a required path parameter. Optional query parameters like `pageSize`, `pageToken`, and `tag` can filter and paginate results. The request body must be empty. The response includes an array of dataset objects and a `nextPageToken` for further pagination. The request requires the `mapsplatformdatasets.datasets.list` IAM permission and `https://www.googleapis.com/auth/cloud-platform` OAuth scope.\n"],null,["# Method: projects.datasets.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDatasetsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n\nLists all the datasets for the specified project.\n\n### HTTP request\n\n`GET https://mapsplatformdatasets.googleapis.com/v1/{parent=projects/*}/datasets`\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 project to list all the datasets for. Format: projects/{project} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of datasets to return per page. If unspecified (or zero), all datasets will be returned. |\n| `pageToken` | `string` The page token, received from a previous datasets.list call. Provide this to retrieve the subsequent page. |\n| `tag` | `string` The tag that specifies the desired version for each dataset. Note that when pagination is also specified, some filtering can happen after pagination, which may cause the response to contain fewer datasets than the page size, even if it's not the last page. Tag \"active\": Each dataset in the response will include the info of its latest completed version, and the dataset will be skipped if it does not have one. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse object of datasets.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"datasets\": [ { object (/maps/documentation/datasets/reference/rest/v1/projects.datasets#Dataset) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `datasets[]` | `object (`[Dataset](/maps/documentation/datasets/reference/rest/v1/projects.datasets#Dataset)`)` All the datasets for the project. |\n| `nextPageToken` | `string` A token that can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `mapsplatformdatasets.datasets.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]