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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.