Method: resources.calendars.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

זהו מאפיין שמזהה את האובייקט כקבוצה של 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

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