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 を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。