このページは Cloud Translation API によって翻訳されました。

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` に関係なく常に含まれます。省略可。デフォルトでは、最終更新日時でフィルタしません。

承認

このリクエストでは、少なくとも次のうち 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`」 - ユーザーがカレンダーに対する管理者権限を持っている。このロールには、ライターロールのすべての権限に加えて、他のユーザーのアクセスレベルを表示して変更する権限が付与されています。重要: `owner` ロールは、カレンダーのデータ所有者とは異なります。カレンダーには 1 人のデータ所有者がいますが、`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 を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。