CalendarList: list

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

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר Value התיאור
פרמטרים אופציונליים של שאילתה
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

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

גוף הבקשה

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

תשובה

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

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
שם הנכס Value התיאור הערות
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?

רוצה לנסות?

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