CalendarList: list

הערה: נדרשת הרשאה.

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

בקשה

בקשת HTTP

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

פרמטרים

שם הפרמטר	ערך	תיאור
פרמטרים אופציונליים של שאילתות
maxResults	integer	המספר המקסימלי של רשומות שמוחזרות בדף תוצאות אחד. ערך ברירת המחדל הוא 100 רשומות. גודל הדף לא יכול להכיל יותר מ-250 רשומות. זה שינוי אופציונלי.
minAccessRole	string	תפקיד הגישה המינימלי של המשתמש ברשאות שהוחזרו. זה שינוי אופציונלי. ברירת המחדל היא ללא הגבלה. הערכים הקבילים הם: freeBusyReader: המשתמש יכול לקרוא את המידע על סטטוס הזמינות. 'owner': המשתמש יכול לקרוא ולשנות אירועים ורשימות של בקרת גישה. 'reader': המשתמש יכול לקרוא אירועים שאינם פרטיים. 'writer': המשתמש יכול לקרוא ולשנות אירועים.
pageToken	string	אסימון שמציין איזה דף תוצאות להציג. זה שינוי אופציונלי.
showDeleted	boolean	אם לכלול בתוצאה רשומות שנמחקו מרשימת היומנים. זה שינוי אופציונלי. ברירת המחדל היא False.
showHidden	boolean	האפשרות להציג רשומות מוסתרות. זה שינוי אופציונלי. ברירת המחדל היא False.
syncToken	string	אסימון שהתקבל מהשדה nextSyncToken שהוחזר בדף התוצאות האחרון של הבקשה הקודמת לרשימת הפריטים. כך התוצאה של בקשת הרשימה הזו תכלול רק רשומות שהשתנו מאז. אם השתנו רק שדות לקריאה בלבד, כמו מאפייני יומן או רשימות ACL, הרשומה לא תוחזר. כל הרשומות שנמחקו והוסתרו מאז בקשת הרשימה הקודמת תמיד יהיו בקבוצת התוצאות, ואי אפשר להגדיר את showDeleted או את showHidden כ-False. כדי להבטיח עקביות במצב הלקוח, לא ניתן לציין את פרמטר השאילתה minAccessRole יחד עם nextSyncToken. אם התוקף של syncToken יפוג, השרת יגיב עם קוד התגובה 410 GONE והלקוח צריך לנקות את האחסון שלו ולבצע סנכרון מלא ללא syncToken. מידע נוסף על סנכרון מצטבר אופציונלי. ברירת המחדל היא החזרת כל הרשומות.

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:

היקף
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

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

גוף הבקשה

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

תשובה

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

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}

שם הנכס	ערך	תיאור	הערות
kind	string	סוג האוסף ('calendar#calendarList').
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.CalendarList;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

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

// Iterate through entries in calendar list
String pageToken = null;
do {
  CalendarList calendarList = service.calendarList().list().setPageToken(pageToken).execute();
  List<CalendarListEntry> items = calendarList.getItems();

  for (CalendarListEntry calendarListEntry : items) {
    System.out.println(calendarListEntry.getSummary());
  }
  pageToken = calendarList.getNextPageToken();
} while (pageToken != null);

Python

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

page_token = None
while True:
  calendar_list = service.calendarList().list(pageToken=page_token).execute()
  for calendar_list_entry in calendar_list['items']:
    print calendar_list_entry['summary']
  page_token = calendar_list.get('nextPageToken')
  if not page_token:
    break

PHP

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

$calendarList = $service->calendarList->listCalendarList();

while(true) {
  foreach ($calendarList->getItems() as $calendarListEntry) {
    echo $calendarListEntry->getSummary();
  }
  $pageToken = $calendarList->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $calendarList = $service->calendarList->listCalendarList($optParams);
  } else {
    break;
  }
}

Ruby

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

page_token = nil
begin
  result = client.list_calendar_lists(page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

נסה בעצמך!

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