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. إذا لم يتم تحديد أي ترتيب، سيتم ضبط الإعدادات التلقائية على "تصاعدي". يجب أن يكون بالتنسيق "الحقل [asc|desc]، الحقل [asc|desc]، ...". على سبيل المثال، ستعرض 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)

موارد التقويم في هذه الصفحة من النتائج.

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

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