Events: instances

指定された定期的な予定のインスタンスを返します。実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 値 説明
パスパラメータ
calendarId string カレンダーの識別子。カレンダー 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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

詳細については、認証と認可のページをご覧ください。

リクエストの本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "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」 - ユーザーがカレンダーに対する管理者権限を持っている。このロールには、ライター ロールのすべての権限に加えて、他のユーザーのアクセスレベルを表示して変更する権限が付与されています。
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 が提供されます。

試してみよう:

以下の API Explorer を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。