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
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.

דוגמאות

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

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

נסה בעצמך!

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