指定したカレンダーの予定を返します。 今すぐ試すまたは例を見る。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
calendarId |
string |
カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary 」キーワードを使用します。
|
省略可能なクエリ パラメータ | ||
alwaysIncludeEmail |
boolean |
非推奨であり、無視されました。 |
eventTypes |
string |
返されるイベントタイプ。省略可。このパラメータを複数回繰り返して、さまざまなタイプのイベントを返すことができます。設定しない場合、すべてのイベントタイプが返されます。
有効な値は次のとおりです。
|
iCalUID |
string |
レスポンスに含める iCalendar 形式の予定 ID を指定します。省略可。iCalendar ID で予定を検索する場合に使用します。 |
maxAttendees |
integer |
回答に含める参加者の最大数。指定した数よりも多くの参加者がいる場合は、参加者のみが返されます。省略可能。 |
maxResults |
integer |
1 つの結果ページで返されるイベントの最大数。表示されるページのイベント数は、クエリに一致するイベントが他にもあっても、この値より少なくなるか、まったく発生しない可能性があります。不完全なページは、レスポンスの空でない nextPageToken フィールドによって検出されます。デフォルトでは、値は 250 イベントです。ページサイズは 2,500 イベントを超えることはできません。省略可能。
|
orderBy |
string |
結果で返されるイベントの順序。省略可。デフォルトは、未指定で安定した順序です。 有効な値は次のとおりです。
|
pageToken |
string |
どの結果ページを返すかを指定するトークン。省略可能。 |
privateExtendedProperty |
string |
propertyName=value として指定された拡張プロパティの制約。私有地のみに一致します。指定したすべての制約に一致するイベントを返すために、このパラメータを複数回繰り返すことができます。 |
q |
string |
自由形式のテキスト検索条件。次のフィールドで、指定した語句に一致するイベントを検索します。
また、これらの検索キーワードは、事前定義されたキーワードと、勤務場所、不在、サイレント モードの予定など、翻訳されたすべてのタイトルの翻訳と照合されます。たとえば、「オフィス」や「オフィス」を検索するとタイプ |
sharedExtendedProperty |
string |
propertyName=value として指定された拡張プロパティの制約。共有プロパティのみに一致します。指定したすべての制約に一致するイベントを返すために、このパラメータを複数回繰り返すことができます。 |
showDeleted |
boolean |
削除されたイベント(status が「cancelled 」と等しい)を結果に含めるかどうかを指定します。showDeleted と singleEvents の両方が False の場合は、キャンセルされた定期的な予定(元の定期的な予定ではありません)が引き続き含まれます。showDeleted と singleEvents の両方が True の場合、削除された予定の単一インスタンスのみが返されます(基になる定期的な予定は返されません)。省略可。デフォルトは False です。 |
showHiddenInvitations |
boolean |
非表示の招待を結果に含めるかどうかを指定します。省略可。デフォルトは False です。 |
singleEvents |
boolean |
定期的な予定をインスタンスに拡張し、1 回限りの予定と定期的な予定のみを返すかどうかを指定します。基となる定期的な予定自体は返しません。省略可。デフォルトは False です。 |
syncToken |
string |
前のリスト リクエストの結果の最後のページで返された nextSyncToken フィールドから取得したトークン。このリスト リクエストの結果には、それ以降に変更されたエントリのみが含まれます。前回のリスト リクエスト以降に削除されたイベントはすべて結果セットに含まれ、showDeleted を False に設定することはできません。クライアントの状態の整合性を確保するために、 nextSyncToken と一緒に指定できないクエリ パラメータがいくつかあります。これらは次のとおりです。
syncToken が期限切れになると、サーバーは 410 GONE レスポンス コードで応答します。クライアントはストレージを消去し、syncToken を使用せずに完全同期を実行する必要があります。増分同期についての詳細をご確認ください。 : 省略可。デフォルトでは、すべてのエントリが返されます。 |
timeMax |
datetime |
フィルタするイベントの開始時間の上限(この値を含まない)。省略可。デフォルトでは、開始時間でフィルタされません。必須のタイムゾーン オフセットを含む RFC3339 タイムスタンプを入力してください(例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定できますが、無視されます。timeMin が設定されている場合、timeMax は timeMin より大きくする必要があります。
|
timeMin |
datetime |
フィルタするイベントの終了時間の下限(この値を含まない)。省略可。デフォルトでは、終了時間でフィルタされません。必須のタイムゾーン オフセットを含む RFC3339 タイムスタンプを入力してください(例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定できますが、無視されます。timeMax を設定する場合は、timeMin を timeMax より小さくする必要があります。
|
timeZone |
string |
レスポンスで使用されるタイムゾーン。省略可。デフォルトはカレンダーのタイムゾーンです。 |
updatedMin |
datetime |
フィルタに使用する、イベントの最終変更時刻の下限(RFC3339 タイムスタンプ)。指定すると、showDeleted に関係なく、この時間以降に削除されたエントリは常に含まれます。省略可。デフォルトでは、最終更新日時でフィルタされません。 |
認可
このリクエストでは、次のスコープのうち少なくとも 1 つを使用して認可を行うことができます。
範囲 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
詳細については、認証と認可のページをご覧ください。
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "kind": "calendar#events", "etag": etag, "summary": string, "description": string, "updated": datetime, "timeZone": string, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "nextPageToken": string, "nextSyncToken": string, "items": [ events Resource ] }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
kind |
string |
コレクションのタイプ(「calendar#events 」)。 |
|
etag |
etag |
コレクションの ETag。 | |
summary |
string |
カレンダーのタイトル。読み取り専用です。 | |
description |
string |
カレンダーの説明。読み取り専用です。 | |
updated |
datetime |
カレンダーの最終更新日時(RFC3339 タイムスタンプ)。読み取り専用です。 | |
timeZone |
string |
カレンダーのタイムゾーン。読み取り専用です。 | |
accessRole |
string |
このカレンダーに対するユーザーのアクセス権限。読み取り専用。有効な値は次のとおりです。
|
|
defaultReminders[] |
list |
認証済みユーザーのカレンダーのデフォルト通知。これらのリマインダーは、明示的にオーバーライドされていない(つまり、reminders.useDefault が True に設定されていない)このカレンダーのすべての予定に適用されます。 |
|
defaultReminders[].method |
string |
このリマインダーで使用するメソッド。有効な値は次のとおりです。
リマインダーを追加する場合は必須です。 |
書き込み可能 |
defaultReminders[].minutes |
integer |
リマインダーがトリガーされる、イベント開始前の分数。有効な値は 0 ~ 40320(4 週間(分))です。 リマインダーを追加する場合は必須です。 |
書き込み可能 |
nextPageToken |
string |
この結果の次のページにアクセスするために使用されるトークン。それ以上の結果が得られない場合は省略されます。その場合、nextSyncToken が提供されます。 |
|
items[] |
list |
カレンダーの予定のリスト。 | |
nextSyncToken |
string |
この結果が返された後に変更されたエントリのみを取得するために、後で使用されるトークン。それ以上の結果が利用できる場合は省略されます。その場合、nextPageToken が提供されます。 |
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
Java クライアント ライブラリを使用します。
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; import com.google.api.services.calendar.model.Events; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over the events in the specified calendar String pageToken = null; do { Events events = service.events().list('primary').setPageToken(pageToken).execute(); List<Event> items = events.getItems(); for (Event event : items) { System.out.println(event.getSummary()); } pageToken = events.getNextPageToken(); } while (pageToken != null);
Python
Python クライアント ライブラリを使用します。
page_token = None while True: events = service.events().list(calendarId='primary', pageToken=page_token).execute() for event in events['items']: print event['summary'] page_token = events.get('nextPageToken') if not page_token: break
PHP
PHP クライアント ライブラリを使用します。
$events = $service->events->listEvents('primary'); while(true) { foreach ($events->getItems() as $event) { echo $event->getSummary(); } $pageToken = $events->getNextPageToken(); if ($pageToken) { $optParams = array('pageToken' => $pageToken); $events = $service->events->listEvents('primary', $optParams); } else { break; } }
Ruby
Ruby クライアント ライブラリを使用します。
page_token = nil begin result = client.list_events('primary', 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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。