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