מאחזרת רשימה של משאבי יומן לחשבון.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customer |
המזהה הייחודי של חשבון Google Workspace של הלקוח. כמנהלי חשבון, אתם יכולים גם להשתמש בכינוי |
פרמטרים של שאילתה
פרמטרים | |
---|---|
maxResults |
המספר המקסימלי של תוצאות להחזרה. |
orderBy |
שדות למיון תוצאות לפי סדר עולה או יורד. השדות הנתמכים כוללים |
pageToken |
אסימון לציון הדף הבא ברשימה. |
query |
שאילתת מחרוזת המשמשת לסינון התוצאות. צריך להיות בפורמט של 'ערך אופרטור של שדה', שבו השדה יכול להיות כל אחד מהשדות הנתמכים והאופרטורים יכולים להיות כל אחת מהפעולות הנתמכות. האופרטורים כוללים את הסימן '=' להתאמה מדויקת, '!=' במקרה של אי-התאמה ו-':' להתאמה לקידומת או להתאמה HAS בהתאמה במקרים הרלוונטיים. במקרה של התאמת קידומת, הערך תמיד צריך להופיע אחרי התו *. האופרטורים הלוגיים NOT ו-AND נתמכים (לפי סדר הקדימות הזה). השדות הנתמכים כוללים: |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
API ציבורי: Resources.calendars
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
שדות | |
---|---|
kind |
מזהה את זה כאוסף של CalendarResources. הערך הוא תמיד |
etag |
ה-ETag של המשאב. |
items[] |
CalendarResources בדף התוצאות הזה. |
nextPageToken |
אסימון ההמשך, שמשמש לדפדוף בקבוצות גדולות של תוצאות. יש לספק את הערך הזה בבקשה הבאה שתחזיר את דף התוצאות הבא. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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
למידע נוסף, עיינו במדריך ההרשאות.