Method: resources.calendars.list

מאחזר רשימה של משאבי יומן לחשבון.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
customer

string

המזהה הייחודי של חשבון Google Workspace של הלקוח. אדמינים בחשבון יכולים גם להשתמש בכינוי my_customer כדי לייצג את מספר הלקוח של החשבון.

פרמטרים של שאילתה

פרמטרים
maxResults

integer

המספר המקסימלי של תוצאות שיוחזרו.
orderBy

string

שדות למיון התוצאות בסדר עולה או יורד. השדות הנתמכים כוללים את resourceId,‏ resourceName,‏ capacity,‏ buildingId ו-floorName. אם לא מציינים סדר, ברירת המחדל היא סדר עולה. הפורמט צריך להיות field [asc|desc], field [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.

גוף הבקשה

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

גוף התשובה

‫API ציבורי: 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

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