Events: instances

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

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パスパラメータ
calendarId string カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary」キーワードを使用します。
eventId string 定期的な予定の ID です。
省略可能なクエリ パラメータ
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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。