Method: resources.calendars.list

لاسترداد قائمة بموارد التقويم لأحد الحسابات.

طلب HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المَعلمات
customer

string

المعرّف الفريد لحساب العميل على Google Workspace. بصفتك مشرفًا في الحساب، يمكنك أيضًا استخدام العنوان البديل للبريد الإلكتروني my_customer لتمثيل الرقم التعريفي لعميل حسابك.

معامِلات طلب البحث

المَعلمات
maxResults

integer

الحد الأقصى لعدد النتائج المطلوب عرضها.
orderBy

string

حقول للترتيب حسب النتائج تصاعديًا أو تنازليًا. تشمل الحقول المتوافقة resourceId وresourceName وcapacity وbuildingId وfloorName. إذا لم يتم تحديد أي ترتيب، سيتم ضبط الإعداد التلقائي على ترتيب تصاعدي. يجب أن يكون الحقل على الشكل التالي: "الحقل [asc|dis]، الحقل [asc|dis]، ..." على سبيل المثال، يمكن أن يعرض buildingId, capacity desc النتائج مرتّبةً أولاً حسب buildingId بترتيب تصاعدي ثم capacity بترتيب تنازلي.
pageToken

string

رمز مميز لتحديد الصفحة التالية في القائمة.
query

string

سلسلة طلب بحث مستخدَمة لفلترة النتائج يجب أن تكون الصيغة "قيمة عامل التشغيل للحقل" حيث يمكن أن يكون الحقل أيًا من الحقول المتوافقة ويمكن أن تكون عوامل التشغيل أيًا من العمليات المتوافقة. وتشمل عوامل التشغيل "=' للمطابقة التامة و'!=' للعدم مطابقة و':'') لمطابقة البادئة أو تختار المطابقة حيثما ينطبق ذلك. بالنسبة إلى مطابقة البادئة، يجب أن تكون القيمة دائمًا يتبعها *. ولا يتم استخدام عوامل التشغيل المنطقية AND و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

يحدّد هذا التصنيف كمجموعة من "موارد التقويم". وتكون هذه القيمة هي "admin#directory#resources#calendars#calendarResourcesList" دائمًا.
etag

string

ETag للمورد.
items[]

object (CalendarResource)

موارد "تقويم Google" في هذه الصفحة من النتائج.
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

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