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

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

واجهة برمجة التطبيقات العامة: Resource.calendars

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (CalendarResource)
    }
  ],
  "nextPageToken": string
}
الحقول
kind

string

لتحديد ذلك كمجموعة من موارد التقويم. دائمًا ما يكون 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

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