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.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

Public API: Resources.calendars

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (CalendarResource)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

מזהה את האוסף הזה כאוסף של CalendarResource. הערך הוא תמיד 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

מידע נוסף זמין במדריך להרשאות.