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. אם לא מציינים סדר, ברירת המחדל היא סדר עולה. היא צריכה להיות בפורמט "field [asc|description], שדה [asc|שנועד], ...". לדוגמה, הפונקציה 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)

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

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