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

למידע נוסף, עיינו בדף אימות והרשאה.

גוף הבקשה

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

תשובה

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

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

שם הנכס	ערך	תיאור	הערות
kind	string	סוג האוסף ("calendar#calendarList").
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

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

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 בהמשך.