Method: resources.calendars.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
فهرستی از منابع تقویم را برای یک حساب بازیابی می کند.
درخواست HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
customer | string شناسه منحصر به فرد برای حساب Google Workspace مشتری. به عنوان مدیر حساب، می توانید از نام مستعار my_customer نیز برای نشان دادن شناسه مشتری حساب خود استفاده کنید. |
پارامترهای پرس و جو
| پارامترها |
|---|
maxResults | integer حداکثر تعداد نتایج برای بازگشت. |
orderBy | string فیلد(ها) برای مرتب سازی نتایج به ترتیب صعودی یا نزولی. فیلدهای پشتیبانی شده عبارتند از resourceId ، resourceName ، capacity ، buildingId و floorName . اگر ترتیبی مشخص نشده باشد، پیش‌فرض صعودی است. باید به شکل "فیلد [صعود|نزولی]، فیلد [صعود|نزولی]، ..." باشد. به عنوان مثال buildingId, capacity desc نتایج را برمی‌گرداند که ابتدا بر اساس buildingId به ترتیب صعودی و سپس بر اساس capacity به ترتیب نزولی مرتب شده‌اند. |
pageToken | string رمزی برای مشخص کردن صفحه بعدی در لیست. |
query | string پرس و جو رشته ای برای فیلتر کردن نتایج استفاده می شود. باید به شکل "مقدار عملگر فیلد" باشد که در آن فیلد می تواند هر یک از فیلدهای پشتیبانی شده باشد و عملگرها می توانند هر یک از عملیات پشتیبانی شده باشند. اپراتورها عبارتند از '=' برای مطابقت دقیق، '!=' برای عدم تطابق و ':' برای تطابق پیشوند یا مطابقت HAS در صورت لزوم. برای تطبیق پیشوند، مقدار باید همیشه با یک * دنبال شود. عملگرهای منطقی NOT و AND پشتیبانی می شوند (با این ترتیب اولویت). فیلدهای پشتیبانی شده عبارتند از generatedResourceName , name , buildingId , floorName , capacity , featureInstances.feature.name , resourceEmail , resourceCategory . برای مثال buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone . |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
API عمومی: Resources.calendars
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"kind": string,
"etag": string,
"items": [
{
object (CalendarResource)
}
],
"nextPageToken": string
} |
| فیلدها |
|---|
kind | string این را به عنوان مجموعه ای از منابع تقویم شناسایی می کند. این همیشه admin#directory#resources#calendars#calendarResourcesList است. |
etag | string ETag منبع |
items[] | object ( CalendarResource ) CalendarResources در این صفحه از نتایج. |
nextPageToken | string نشانه ادامه، برای صفحه در مجموعه‌های نتایج بزرگ استفاده می‌شود. این مقدار را در یک درخواست بعدی برای بازگرداندن صفحه بعدی نتایج ارائه کنید. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://apps-apis.google.com/a/feeds/calendar/resource/ -
https://www.googleapis.com/auth/admin.directory.resource.calendar -
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
،
فهرستی از منابع تقویم را برای یک حساب بازیابی می کند.
درخواست HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
customer | string شناسه منحصر به فرد برای حساب Google Workspace مشتری. به عنوان مدیر حساب، می توانید از نام مستعار my_customer نیز برای نشان دادن شناسه مشتری حساب خود استفاده کنید. |
پارامترهای پرس و جو
| پارامترها |
|---|
maxResults | integer حداکثر تعداد نتایج برای بازگشت. |
orderBy | string فیلد(ها) برای مرتب سازی نتایج به ترتیب صعودی یا نزولی. فیلدهای پشتیبانی شده عبارتند از resourceId ، resourceName ، capacity ، buildingId و floorName . اگر ترتیبی مشخص نشده باشد، پیش‌فرض صعودی است. باید به شکل "فیلد [صعود|نزولی]، فیلد [صعود|نزولی]، ..." باشد. به عنوان مثال buildingId, capacity desc نتایج را برمی‌گرداند که ابتدا بر اساس buildingId به ترتیب صعودی و سپس بر اساس capacity به ترتیب نزولی مرتب شده‌اند. |
pageToken | string رمزی برای مشخص کردن صفحه بعدی در لیست. |
query | string پرس و جو رشته ای برای فیلتر کردن نتایج استفاده می شود. باید به شکل "مقدار عملگر فیلد" باشد که در آن فیلد می تواند هر یک از فیلدهای پشتیبانی شده باشد و عملگرها می توانند هر یک از عملیات پشتیبانی شده باشند. اپراتورها عبارتند از '=' برای مطابقت دقیق، '!=' برای عدم تطابق و ':' برای تطابق پیشوند یا مطابقت HAS در صورت لزوم. برای تطبیق پیشوند، مقدار باید همیشه با یک * دنبال شود. عملگرهای منطقی NOT و AND پشتیبانی می شوند (با این ترتیب اولویت). فیلدهای پشتیبانی شده عبارتند از generatedResourceName , name , buildingId , floorName , capacity , featureInstances.feature.name , resourceEmail , resourceCategory . برای مثال buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone . |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
API عمومی: Resources.calendars
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"kind": string,
"etag": string,
"items": [
{
object (CalendarResource)
}
],
"nextPageToken": string
} |
| فیلدها |
|---|
kind | string این را به عنوان مجموعه ای از منابع تقویم شناسایی می کند. این همیشه admin#directory#resources#calendars#calendarResourcesList است. |
etag | string ETag منبع |
items[] | object ( CalendarResource ) CalendarResources در این صفحه از نتایج. |
nextPageToken | string نشانه ادامه، برای صفحه در مجموعه‌های نتایج بزرگ استفاده می‌شود. این مقدار را در یک درخواست بعدی برای بازگرداندن صفحه بعدی نتایج ارائه کنید. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://apps-apis.google.com/a/feeds/calendar/resource/ -
https://www.googleapis.com/auth/admin.directory.resource.calendar -
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: resources.calendars.list\n\nRetrieves a list of calendar resources for an account.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. |\n| `orderBy` | `string` Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field \\[asc\\|desc\\], field \\[asc\\|desc\\], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order. |\n| `pageToken` | `string` Token to specify the next page in the list. |\n| `query` | `string` String query used to filter results. Should be of the form \"field operator value\" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a \\*. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floorName`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nPublic API: Resources.calendars\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"items\": [ { object (/workspace/admin/directory/reference/rest/v1/resources.calendars#CalendarResource) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[CalendarResource](/workspace/admin/directory/reference/rest/v1/resources.calendars#CalendarResource)`)` The CalendarResources in this page of results. |\n| `nextPageToken` | `string` The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/calendar/resource/`\n- `\n https://www.googleapis.com/auth/admin.directory.resource.calendar`\n- `\n https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
