הפונקציה מחזירה את הכללים ברשימת בקרת הגישה של היומן. רוצים לנסות?
בקשה
בקשת HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
פרמטרים
| שם הפרמטר | ערך | תיאור |
|---|---|---|
| פרמטרים של נתיב | ||
calendarId |
string |
מזהה ביומן. כדי לאחזר את מזהי היומנים, קוראים לשיטה calendarList.list. כדי לגשת ליומן הראשי של המשתמש שמחובר כרגע, משתמשים במילות המפתח primary.
|
| פרמטרים אופציונליים של שאילתות | ||
maxResults |
integer |
המספר המקסימלי של רשומות שמוחזרות בדף תוצאות אחד. ערך ברירת המחדל הוא 100 רשומות. גודל הדף לא יכול להכיל יותר מ-250 רשומות. אופציונלי. |
pageToken |
string |
אסימון שמציין איזה דף תוצאות להציג. אופציונלי. |
showDeleted |
boolean |
אם רשימות ACL שנמחקו ייכללו בתוצאה. רשימות ACL שנמחקו מיוצגות על ידי role שווה ל-"none". רשימות ACL שנמחקו תמיד ייכללו אם syncToken מסופק. אופציונלי. ברירת המחדל היא False.
|
syncToken |
string |
אסימון שהתקבל מהשדה nextSyncToken שהוחזר בדף התוצאות האחרון של הבקשה הקודמת לרשימת הפריטים. כך התוצאה של בקשת הרשימה הזו תכלול רק רשומות שהשתנו מאז. כל הרשומות שנמחקו מאז בקשת הרשימה הקודמת תמיד יהיו בקבוצת התוצאות, ואי אפשר להגדיר את showDeleted כ-False. אם התוקף של syncToken יפוג, השרת יגיב עם קוד התגובה 410 GONE והלקוח צריך לנקות את האחסון שלו ולבצע סנכרון מלא ללא syncToken. מידע נוסף על סנכרון מצטבר אופציונלי. ברירת המחדל היא להחזיר את כל הרשומות. |
אישור
הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:
| היקף |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.acls |
https://www.googleapis.com/auth/calendar.acls.readonly |
מידע נוסף זמין בדף אימות והרשאה.
גוף הבקשה
אין לספק גוף בקשה בשיטה הזו.
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר גוף תגובה עם המבנה הבא:
{
"kind": "calendar#acl",
"etag": etag,
"nextPageToken": string,
"nextSyncToken": string,
"items": [
acl Resource
]
}| שם הנכס | ערך | תיאור | הערות |
|---|---|---|---|
kind |
string |
סוג האוסף ('calendar#acl'). |
|
etag |
etag |
ה-ETag של האוסף. | |
nextPageToken |
string |
אסימון המשמש לגישה לדף הבא של התוצאה הזו. השדה הזה לא מופיע אם אין תוצאות נוספות, ובמקרה כזה מוצג הערך nextSyncToken. |
|
items[] |
list |
רשימת הכללים ברשימת בקרת הגישה. | |
nextSyncToken |
string |
אסימון שמשמש בשלב מאוחר יותר כדי לאחזר רק את הרשומות שהשתנו מאז שהתוצאה הזו הוחזרה. השדה הזה לא מוצג אם יש תוצאות נוספות, ובמקרה כזה מוצג הערך nextPageToken. |
נסה בעצמך!
אפשר להשתמש בכלי הבדיקה של ממשקי ה-API שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.