CalendarList: list

ユーザーのカレンダー リストにあるカレンダーを返します。実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

パラメータ

パラメータ名 値 説明
省略可能なクエリ パラメータ
maxResults integer 1 つの結果ページで返されるエントリの最大数。デフォルトでは、値は 100 エントリです。ページサイズは 250 エントリを超えることはありません。省略可能。
minAccessRole string 返されたエントリ内のユーザーの最小アクセスロール。省略可。デフォルトでは制限はありません。

有効な値は次のとおりです。
  • 「freeBusyReader」: ユーザーは空き時間情報を読み取ることができます。
  • 「owner」: ユーザーはイベントとアクセス制御リストを読み取り、変更できます。
  • 「reader」: ユーザーは非公開のイベントを読み取ることができます。
  • 「writer」: ユーザーはイベントを読み取って変更できます。
  • 「writerWithoutPrivateAccess」: 限定公開でない予定を読み取り、変更できます。ユーザーは、非公開の予定の空き時間情報を確認できます。ユーザーは非公開の予定を変更できません。
pageToken string 返す結果ページを指定するトークン。省略可能。
showDeleted boolean 削除されたカレンダー リスト エントリを結果に含めるかどうか。省略可。デフォルトは False です。
showHidden boolean 非表示のエントリを表示するかどうか。省略可。デフォルトは False です。
showOwnOrganizationOnly boolean 組織のカレンダーのエントリのみを表示するかどうか。このパラメータは Google Workspace ユーザーにのみ適用されます。省略可。デフォルトは False です。
syncToken string 前のリスト リクエストの結果の最後のページで返された nextSyncToken フィールドから取得したトークン。これにより、このリスト リクエストの結果には、それ以降に変更されたエントリのみが含まれるようになります。カレンダーのプロパティや ACL などの読み取り専用フィールドのみが変更された場合、エントリは返されません。前回のリスト リクエスト以降に削除されて非表示になったすべてのエントリは、常に結果セットに含まれます。また、showDeleted と showHidden の両方を False に設定することはできません。
クライアントの状態の整合性を確保するため、minAccessRole クエリ パラメータと showOwnOrganizationOnly クエリ パラメータを nextSyncToken と同時に指定することはできません。
syncToken が期限切れになると、サーバーは 410 GONE レスポンス コードで応答します。クライアントはストレージをクリアし、syncToken なしで完全な同期を実行する必要があります。
増分同期について詳しくは、こちらをご覧ください。
省略可。デフォルトでは、すべてのエントリが返されます。

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。

スコープ
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

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

リクエストの本文

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

レスポンス

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

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
プロパティ名 値 説明 メモ
kind string コレクションのタイプ（「calendar#calendarList」）。
etag etag コレクションの ETag。
nextPageToken string この結果の次のページにアクセスするために使用されるトークン。これ以上の結果がない場合は省略されます。この場合、nextSyncToken が提供されます。
items[] list ユーザーのカレンダー リストに表示されているカレンダー。
nextSyncToken string この結果が返されてから変更されたエントリのみを取得するために、後で使用されるトークン。追加の結果がある場合は省略されます。その場合、nextPageToken が提供されます。

試してみよう:

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