Method: resources.calendars.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يسترجع قائمة بموارد التقويم لحساب معيّن.
طلب HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
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.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
واجهة برمجة التطبيقات العامة: Resources.calendars
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (CalendarResource)
}
],
"nextPageToken": string
} |
| الحقول |
kind |
string
يحدِّد هذا العنصر كمجموعة من CalendarResources. يكون هذا الخيار دائمًا 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 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة 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)."]]
