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

CalendarList

ユーザーのカレンダーリスト内のカレンダーのコレクション。 Calendars と CalendarListもご覧ください。

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

リソース表現

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": 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
    ]
  }
}

プロパティ名	値	説明	メモ
`accessRole`	`string`	認証されたユーザーがカレンダーで保持している有効なアクセスロール。読み取り専用。有効な値は次のとおりです。「`freeBusyReader`」- 空き時間情報への読み取りアクセス権を付与します。「`reader`」- カレンダーの読み取りアクセス権を付与します。限定公開の予定は閲覧者のアクセス権を持つユーザーに表示されますが、予定の詳細は非表示になります。「`writer`」- カレンダーに対する読み取り / 書き込みアクセス権を付与します。非公開イベントは書き込み権限を持つユーザーに表示され、イベントの詳細も表示されます。「`owner`」- カレンダーのオーナーである。このロールには、書き込みロールのすべての権限に加えて、ACL を参照および操作できる追加の権限があります。
`backgroundColor`	`string`	カレンダーのメインの色（16 進数形式「`#0088aa`」）。このプロパティは、インデックスベースの `colorId` プロパティよりも優先されます。このプロパティを設定または変更するには、insert、update、patch メソッドのパラメータで `colorRgbFormat=true` を指定する必要があります。省略可。	書き込み可能
`colorId`	`string`	カレンダーの色。これは、色定義の `calendar` セクションのエントリを参照する ID です（色のエンドポイントを参照）。このプロパティは `backgroundColor` プロパティと `foregroundColor` プロパティに置き換わるので、これらのプロパティを使用する場合は無視できます。省略可。	書き込み可能
`conferenceProperties`	`nested object`	このカレンダーの会議プロパティ（許可されている会議の種類など）。
`conferenceProperties.allowedConferenceSolutionTypes[]`	`list`	このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。 `"eventHangout"` `"eventNamedHangout"` `"hangoutsMeet"` 省略可。
`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` プロパティよりも優先されます。このプロパティを設定または変更するには、insert、update、patch メソッドのパラメータで `colorRgbFormat=true` を指定する必要があります。省略可。	書き込み可能
`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: ユーザーのカレンダーリストの既存のカレンダーを更新します。
スマートウォッチ: CalendarList リソースの変更を監視します。