CalendarList

ユーザーのカレンダー リストにあるカレンダーのコレクション。 カレンダーと CalendarList の違いもご覧ください.

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表現

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "autoAcceptInvitations": boolean
}
プロパティ名 値 説明 メモ
accessRole string 認証されたユーザーがカレンダーに対して持っている有効なアクセスロール。読み取り専用。表示される値は次のとおりです。
  • "freeBusyReader" - 空き時間情報への読み取りアクセス権を付与します。
  • "reader" - カレンダーへの読み取りアクセス権を付与します。リーダー アクセス権を持つユーザーには限定公開の予定が表示されますが、予定の詳細は表示されません。
  • "writerWithoutPrivateAccess" - カレンダーへの読み取り / 書き込みアクセス権を付与します。writerWithoutPrivateAccess アクセス権を持つユーザーには限定公開の予定が表示されますが、予定の詳細は表示されません。
  • "writer" \- カレンダーへの読み取り / 書き込みアクセス権を付与します。ライター アクセス権を持つユーザーには限定公開の予定が表示され、予定の詳細も表示されます。
  • "owner" - カレンダーへの管理者アクセス権を付与します。このロールには、書き込みロールのすべての権限に加えて、他のユーザーのアクセスレベルを表示して変更する権限が付与されます。
autoAcceptInvitations boolean このカレンダーで招待を自動的に受け入れるかどうか。リソース カレンダーでのみ有効です。読み取り専用。
backgroundColor string カレンダーのメインカラー（16 進数形式の「#0088aa」）。このプロパティは、インデックス ベースの colorId プロパティよりも優先されます。このプロパティを設定または変更するには、colorRgbFormat=true を insert、update、patch メソッドのパラメータで指定する必要があります。省略可。 書き込み可能
colorId string カレンダーの色。これは、色の定義の calendar セクションのエントリを参照する ID です（色のエンドポイントを参照）。このプロパティは backgroundColor プロパティと foregroundColor プロパティよりも優先されるため、これらのプロパティを使用する場合は無視できます。省略可。 書き込み可能
conferenceProperties nested object このカレンダーの会議プロパティ（許可される会議の種類など）。
conferenceProperties.allowedConferenceSolutionTypes[] list このカレンダーでサポートされている会議ソリューションの種類。

使用できる値は次のとおりです。

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
省略可。
dataOwner string カレンダーのオーナーのメールアドレス。予備カレンダーにのみ設定されます。読み取り専用。
defaultReminders[] list 認証されたユーザーがこのカレンダーに対して持っているデフォルトのリマインダー。 書き込み可能
defaultReminders[].method string このリマインダーで使用されるメソッド。表示される値は次のとおりです。
  • "email" - リマインダーはメールで送信されます。
  • "popup" - リマインダーは UI ポップアップで送信されます。

リマインダーを追加する場合は必須です。

 書き込み可能
defaultReminders[].minutes integer リマインダーをトリガーする予定の開始時刻までの分数。有効な値は 0 ～ 40320（4 週間）です。

リマインダーを追加する場合は必須です。

 書き込み可能
deleted boolean このカレンダー リスト エントリがカレンダー リストから削除されたかどうか。読み取り専用。省略可。デフォルトは False です。
description string カレンダーの説明。省略可。読み取り専用。
etag etag リソースの ETag。
foregroundColor string カレンダーの前景色（16 進数形式の「#ffffff」）。このプロパティは、インデックス ベースの colorId プロパティよりも優先されます。このプロパティを設定または変更するには、colorRgbFormat=true を insert、update、patch メソッドのパラメータで指定する必要があります。省略可。 書き込み可能
hidden boolean カレンダーがリストから非表示になっているかどうか。省略可。この属性は、カレンダーが非表示の場合にのみ返されます。その場合、値は true になります。 書き込み可能
id string カレンダーの識別子。
kind string リソースのタイプ（「calendar#calendarListEntry」）。
location string カレンダーの地理的位置（自由形式のテキスト）。省略可。読み取り専用。
notificationSettings object 認証されたユーザーがこのカレンダーに対して受け取っている通知。 書き込み可能
notificationSettings.notifications[] list このカレンダーに設定されている通知のリスト。
notificationSettings.notifications[].method string 通知の配信に使用されるメソッド。使用できる値は次のとおりです。
  • "email" - 通知はメールで送信されます。

通知を追加する場合は必須です。

 書き込み可能
notificationSettings.notifications[].type string 通知のタイプ。表示される値は次のとおりです。
  • "eventCreation" - 新しい予定がカレンダーに追加されたときに送信される通知。
  • "eventChange" - 予定が変更されたときに送信される通知。
  • "eventCancellation" - 予定がキャンセルされたときに送信される通知。
  • eventResponse - 参加者が予定の招待に返信したときに送信される通知。
  • "agenda" - その日の予定を含むアジェンダ（午前中に送信されます）。

通知を追加する場合は必須です。

 書き込み可能
primary boolean カレンダーが認証されたユーザーのメイン カレンダーかどうか。読み取り専用。省略可。デフォルトは False です。
selected boolean カレンダーのコンテンツがカレンダー UI に表示されるかどうか。省略可。デフォルトは False です。 書き込み可能
summary string カレンダーのタイトル。読み取り専用。
summaryOverride string 認証されたユーザーがこのカレンダーに設定した概要。省略可。 書き込み可能
timeZone string カレンダーのタイムゾーン。省略可。読み取り専用。

メソッド

delete
ユーザーのカレンダー リストからカレンダーを削除します。
get
ユーザーのカレンダー リストからカレンダーを返します。
insert
既存のカレンダーをユーザーのカレンダー リストに挿入します。
list
ユーザーのカレンダー リストにあるカレンダーを返します。
patch
ユーザーのカレンダー リストにある既存のカレンダーを更新します。このメソッドは、パッチ セマンティクスをサポートしています。パッチ リクエストごとに 3 つの割り当てユニットが消費されます。get の後に update を使用することをおすすめします。指定したフィールド値は既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされ、以前の配列要素は破棄されます。
update
ユーザーのカレンダー リストにある既存のカレンダーを更新します。
watch
CalendarList リソースの変更を監視します。