Events: list

指定したカレンダーの予定を返します。 実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 値 説明
パスパラメータ
calendarId string カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスする場合は、「primary」キーワードを使用します。
省略可能なクエリ パラメータ
alwaysIncludeEmail boolean 非推奨となり、無視されます。
eventTypes string 返されるイベントの種類。省略可。このパラメータを複数回繰り返して、さまざまな種類のイベントを返すことができます。設定しない場合、すべてのイベントタイプが返されます。

有効な値は次のとおりです。
  • "birthday": 年に一度繰り返される特別な終日イベント。
  • "default": 通常のイベント。
  • "focusTime": サイレント モードの予定。
  • "fromGmail": Gmail からの予定。
  • "outOfOffice": 不在の予定。
  • "workingLocation": 勤務場所の予定。
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 propertyName=value として指定された拡張プロパティの制約。非公開プロパティのみが一致します。このパラメータを複数回繰り返して、指定されたすべての制約に一致するイベントを返すことができます。
q string 次のフィールドでこれらの用語に一致するイベントを検索するためのフリーテキスト検索語句。
  • summary
  • description
  • location
  • 出席者の displayName
  • 出席者の email
  • 主催者の displayName
  • 主催者の email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

これらの検索語句は、勤務場所、不在、サイレント モードの予定のすべての表示タイトルの翻訳に対して、事前定義されたキーワードとも一致します。たとえば、「Office」または「Bureau」を検索すると、タイプ officeLocation の勤務場所の予定が返されますが、「Out of office」または「Abwesend」を検索すると、不在の予定が返されます。省略可。
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 と一緒に指定できないクエリ パラメータがいくつかあります。

次のとおりです。
  • 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 が設定されている場合、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 に関係なく常に含まれます。省略可。デフォルトでは、最終更新時刻でフィルタされません。

承認

このリクエストでは、次のいずれかのスコープによる承認が可能です。

スコープ
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" - ユーザーはカレンダーへの読み取りアクセス権を持っています。リーダー アクセス権を持つユーザーには限定公開の予定が表示されますが、予定の詳細は表示されません。
  • "writerWithoutPrivateAccess" - ユーザーはカレンダーへの読み取り / 書き込みアクセス権を持っています。writerWithoutPrivateAccess アクセス権を持つユーザーには限定公開の予定が表示されますが、予定の詳細は表示されません。
  • "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 を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。