CalendarList: list
Requires authorization 承認が必要
Returns the calendars on the user's calendar list. Try it now or see an example. ユーザーのカレンダーリストにあるカレンダーを返します。今すぐ試すか、例を見てください。
Request要求
HTTP requestHTTPリクエスト
GET https://www.googleapis.com/calendar/v3/users/me/calendarList
Parametersパラメーター
Parameter nameパラメータ名 | Value値 | Description説明 |
---|---|---|
Optional query parametersオプションのクエリパラメータ | ||
maxResults |
integer |
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. 1つの結果ページに返される最大エントリ数。デフォルトでは、値は100エントリです。ページサイズは250エントリを超えることはできません。オプションです。 |
minAccessRole |
string |
The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Acceptable values are:
|
pageToken |
string |
Token specifying which result page to return. Optional. どの結果ページを返すかを指定するトークン。オプションです。 |
showDeleted |
boolean |
Whether to include deleted calendar list entries in the result. Optional. The default is False. 削除したカレンダーリストのエントリを結果に含めるかどうか。オプションです。デフォルトはFalseです。 |
showHidden |
boolean |
Whether to show hidden entries. Optional. The default is False. 隠しエントリを表示するかどうか。オプションです。デフォルトはFalseです。 |
syncToken |
string |
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken . If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken . Learn more about incremental synchronization. Optional. The default is to return all entries. nextSyncToken 前回のリスト要求の結果の最後のページに返され
たフィールドから取得したトークン。このリスト要求の結果に、それ以降に変更されたエントリだけが含まれるようにします。カレンダーのプロパティやACLなどの読み取り専用フィールドのみが変更されている場合、エントリは返されません。前回のリスト要求以降に削除および非表示にされたすべてのエントリは常に結果セットに含まれshowDeleted 、showHidden Falseにも設定することもできません。クライアントの状態の一貫性を保証するために、 minAccessRole queryパラメータをとともに指定することはできませんnextSyncToken 。場合は syncToken 有効期限が切れると、サーバは410 GONE応答コードで応答すると、クライアントは、そのストレージをクリアし、任意のせずに完全な同期を実行する必要がありますsyncToken 。もっと詳しく知る増分同期について。 オプションです。デフォルトではすべてのエントリが返されます。 |
Authorization承認
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).この要求には、以下の範囲のうちの少なくとも1つを使用した許可が必要です(認証および許可について詳しく読む)。
Scope範囲 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
Request bodyリクエストボディ
Do not supply a request body with this method.このメソッドでリクエストボディを指定しないでください。
Response応答
If successful, this method returns a response body with the following structure:成功した場合、このメソッドは以下の構造を持つレスポンスボディを返します。
{ "kind": "calendar#calendarList", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ calendarList Resource ] }
Property nameプロパティ名 | Value値 | Description説明 | Notesノート |
---|---|---|---|
kind |
string |
Type of the collection ("calendar#calendarList ").コレクションの種類( " calendar#calendarList ")。 |
|
etag |
etag |
ETag of the collection.コレクションのETag。 | |
nextPageToken |
string |
Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.この結果の次のページにアクセスするためのトークン。それ以上の結果が得られない場合は省略され、その場合nextSyncToken は提供されます。 |
|
items[] |
list |
Calendars that are present on the user's calendar list.ユーザーのカレンダーリストに表示されているカレンダー。 | |
nextSyncToken |
string |
Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.この結果が返された後に変更されたエントリのみを取得するために後で使用されるトークン。さらなる結果が利用可能である場合nextPageToken は省略され、その場合は提供される。 |
Examples例
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).注:このメソッドで使用可能なコード例は、サポートされているすべてのプログラミング言語を表しているわけではありません(サポートされている言語のリストについては、クライアントライブラリのページを参照してください)。
Java
Uses the Java client library.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
Uses the Python client library.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
Uses the PHP client library.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ルビー
Uses the Ruby client library.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?
Try it!それを試してみてください!
Use the APIs Explorer below to call this method on live data and see the response. 以下のAPI Explorerを使用して、ライブデータに対してこのメ??ソッドを呼び出して応答を確認してください。
関連記事
- CalendarList: watch
- CalendarList: update
- CalendarList: patch
- CalendarList: insert
- CalendarList: get
- CalendarList: delete
スポンサーリンク