דף זה תורגם על ידי Cloud Translation API.

Acl: list

מחזירה את הכללים ברשימה של בקרת הגישה של היומן. אפשר לנסות עכשיו או לראות דוגמה.

בקשה

בקשת 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`

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

גוף הבקשה

אל תספקו גוף בקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
  "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`.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

Java

משתמש בספריית הלקוח של Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Acl;
import com.google.api.services.calendar.model.AclRule;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over a list of access rules
Acl acl = service.acl().list('primary').execute();

for (AclRule rule : acl.getItems()) {
  System.out.println(rule.getId() + ": " + rule.getRole());
}

Python

משתמש בספריית הלקוח של Python.

acl = service.acl().list(calendarId='primary').execute()

for rule in acl['items']:
  print '%s: %s' % (rule['id'], rule['role'])

PHP

משתמש בספריית הלקוח של PHP.

$acl = $service->acl->listAcl('primary');

foreach ($acl->getItems() as $rule) {
  echo $rule->getId() . ': ' . $rule->getRole();
}

Ruby

משתמש בספריית הלקוח של Ruby.

result = client.list_acls('primary')
result.items.each do |e|
  print e.id + ": " + e.role + "\n"
end

נסה בעצמך!

אפשר להשתמש ב-APIs Explorer שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.