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

שאילתת מחרוזת המשמשת לסינון התוצאות. השדה הזה צריך להיות בפורמט "ערך אופרטור שדה", שבו אחד מהשדות יכול להיות אחד מהשדות הנתמכים, והאופרטורים יכולים להיות כל אחת מהפעולות הנתמכות. האופרטורים כוללים '=' להתאמה מדויקת, '!=' לחוסר התאמה ו-':' להתאמה לקידומת או 'תואם' במקרים הרלוונטיים. להתאמה לקידומת, הערך חייב להיות תמיד ואחריו *. אופרטורים לוגיים 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

מזהה זאת כאוסף של משאבי יומן. המחיר הוא תמיד 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

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