Events: list

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

指定されたカレンダーの予定を表示します。 今すぐ試すまたは例を見る

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

パラメータ

パラメータ名 説明
パスパラメータ
calendarId string カレンダー識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary」キーワードを使用します。
省略可能なクエリ パラメータ
alwaysIncludeEmail boolean 非推奨であり無視しました。主催者、作成者、参加者の email フィールドには、実際のメールアドレスがない場合でも、値が返されます(生成された有効な値が提供されなかった場合)。
iCalUID string レスポンスで提供する iCalendar 形式のイベント ID を指定します。(省略可)iCalendar ID でイベントを検索する場合に使用します。
maxAttendees integer レスポンスに含める参加者の最大数。指定した人数を超える参加者が存在する場合は、その参加者のみが返されます。省略可。
maxResults integer 1 つの結果ページで返されるイベントの最大数。クエリに一致するイベントの数が増えても、結果ページのイベントの数はこの値より少なくなるか、まったくなくなる可能性があります。不完全なページは、レスポンスの空でない nextPageToken フィールドによって検出できます。デフォルト値は 250 イベントです。ページサイズは 2,500 イベント以下にする必要があります。省略可。
orderBy string 結果で返されるイベントの順序。(省略可)デフォルトは、不特定の安定した順序です。

有効な値は次のとおりです。
  • startTime: 開始日時による昇順(昇順)。これは、単一のイベントをクエリする場合にのみ使用できます(つまり、パラメータ singleEvents が True の場合)。
  • updated: 最終更新日時(昇順)で並べ替えます。
pageToken string 返す結果ページを指定するトークン。省略可。
privateExtendedProperty string プロパティ名=値として指定される拡張プロパティの制約。プライベート プロパティにのみ一致します。このパラメータを複数回繰り返すと、指定したすべての制約に一致するイベントが返されます。
q string summarydescriptionlocation、参加者の displayName、参加者の email のフィールドで、これらのキーワードに一致するイベントを見つけるための自由形式のテキスト検索キーワード。省略可。
sharedExtendedProperty string プロパティ名=値として指定される拡張プロパティの制約。共有プロパティにのみ一致します。このパラメータを複数回繰り返すと、指定したすべての制約に一致するイベントが返されます。
showDeleted boolean 削除されたイベント(status が「cancelled」と等しい)を結果に含めるかどうか。showDeletedsingleEvents の両方が False の場合、キャンセルされた予定の定期的な予定の各インスタンスは含まれます(ただし、元の定期的な予定は含まれません)。showDeletedsingleEvents が両方とも True の場合、削除されたイベントの 1 つのインスタンスのみが返されます(基礎となる定期的なイベントは含まれません)。(省略可)デフォルトは False です。
showHiddenInvitations boolean 非表示にした招待状を結果に含めるかどうか。(省略可)デフォルトは False です。
singleEvents boolean 定期的な予定をインスタンスに展開し、1 回限りの予定と定期的な予定のみを返すか、定期的な予定自体は返さないか。(省略可)デフォルトは False です。
syncToken string 前のリスト リクエストの結果の最後のページで返された nextSyncToken フィールドから取得したトークン。このリスト リクエストの結果には、それ以降に変更されたエントリのみが含まれます。前のリスト リクエスト以降に削除されたイベントはすべて、結果セットに常に含まれます。また、showDeleted を False に設定することはできません。
クライアント状態の整合性を確保するために、nextSyncToken と一緒に指定できないクエリ パラメータがいくつかあります。

次のカテゴリがあります。
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
syncToken が期限切れになった場合、サーバーは 410 GONE レスポンス コードで応答します。クライアントはストレージを消去し、syncToken を使用せずに完全な同期を行う必要があります。
増分同期の詳細
省略可。デフォルトでは、すべてのエントリが返されます。
timeMax datetime イベントの開始時間でフィルタする上限です(境界値を除く)。(省略可)デフォルトでは、開始時間でフィルタされません。タイムゾーン オフセットが必須の RFC3339 タイムスタンプである必要があります(例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定することもできますが、無視されます。timeMin が設定されている場合、timeMaxtimeMin より大きい値にする必要があります。
timeMin datetime フィルタするイベントの終了日の下限(この値を含まない)。(省略可)デフォルトでは、終了時間でフィルタされません。タイムゾーン オフセットが必須の RFC3339 タイムスタンプである必要があります(例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定することもできますが、無視されます。timeMax が設定されている場合、timeMintimeMax より小さい値にする必要があります。
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 このカレンダーのユーザーのロール。読み取り専用。有効な値は次のとおりです。
  • none」- ユーザーにはアクセス権がありません。
  • freeBusyReader」 - ユーザーは、予定の有無情報の読み取りアクセス権があります。
  • reader」 - カレンダーに対する読み取りアクセス権がユーザーに付与されています。限定公開の予定は読み取りアクセス権を持つユーザーに表示されますが、予定の詳細は非表示になります。
  • writer」 - カレンダーに対する読み取りおよび書き込みアクセス権がユーザーに付与されています。非公開のイベントはライター権限を持つユーザーに表示され、イベントの詳細も表示されます。
  • owner」 - ユーザーはカレンダーの所有権を持っています。このロールにはライターロールのすべての権限に加え、ACL を表示および操作する権限もあります。
defaultReminders[] list カレンダー上の認証済みユーザーのデフォルトのリマインダー。これらのリマインダーは、このカレンダー上で明示的にオーバーライドされていない(つまり、reminders.useDefault が True に設定されていない)すべての予定に適用されます。
defaultReminders[].method string このリマインダーで使用されるメソッド。有効な値は次のとおりです。
  • email」 - リマインダーはメールで送信されます。
  • popup」 - リマインダーは UI のポップアップから送信されます。

リマインダーを追加する際に必要です。

書き込み可能
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 を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。