Events: instances

指定した定期的な予定のインスタンスを返します。 今すぐ試すまたは例を見る。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 値 説明
パスパラメータ
calendarId string カレンダーの ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary」を使用します。できます。
eventId string 定期的な予定の識別子。
省略可能なクエリ パラメータ
alwaysIncludeEmail boolean 非推奨となり、無視されます。実際のメールアドレスが利用できない場合でも、主催者、作成者、参加者の email フィールドに値が常に返されます（生成された有効な値を提供しないなど）。
maxAttendees integer 回答に含める参加者の最大数。参加者の数が指定した数を超える場合は、参加者のみが返されます。省略可能。
maxResults integer 1 つの結果ページで返されるイベントの最大数。デフォルトの値は 250 イベントです。ページサイズは 2,500 イベント以下にする必要があります。省略可能。
originalStart string 結果に含まれるインスタンスの元の開始時間。省略可能。
pageToken string 返される結果ページを指定するトークン。省略可能。
showDeleted boolean 削除されたイベント（status は「cancelled」）を結果に含めるかどうか。singleEvents が False の場合、キャンセルされた定期的な予定のインスタンスは、引き続き含まれます。省略可。デフォルトは False です。
timeMax datetime フィルタに使用するイベントの開始時間の上限（この値を含まない）。省略可。デフォルトでは、開始時間によるフィルタリングは行われません。必須のタイムゾーン オフセットを含む RFC3339 タイムスタンプを指定する必要があります。
timeMin datetime フィルタリングするイベントの終了時間の下限（両端を含む）。省略可。デフォルトでは、終了時間でフィルタされません。必須のタイムゾーン オフセットを含む RFC3339 タイムスタンプを指定する必要があります。
timeZone string レスポンスで使用されるタイムゾーン。省略可。デフォルトはカレンダーのタイムゾーンです。

承認

このリクエストは、次のスコープのうち少なくとも 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 instances of a specific recurring event
String pageToken = null;
do {
  Events events =
      service.events().instances('primary', 'eventId').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().instances(calendarId='primary', eventId='eventId',
                                      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->instances('primary', "eventId");

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->instances('primary', "eventId",
        $optParams);
  } else {
    break;
  }
}

Ruby

Ruby クライアント ライブラリを使用します。

page_token = nil
begin
  result = client.list_event_instances('primary', 'eventId')
  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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。