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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.