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

CalendarList

ユーザーのカレンダーリストにあるカレンダーのコレクション。 Calendars と 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
    ]
  }
}

プロパティ名	値	説明	メモ
`accessRole`	`string`	認証済みユーザーがカレンダーに対して持つ有効なアクセスロール。読み取り専用。指定できる値は次のとおりです。「`freeBusyReader`」 - 空き時間情報の読み取りアクセス権を付与します。「`reader`」 - カレンダーへの読み取りアクセス権を提供します。限定公開の予定は閲覧権限を持つユーザーに表示されますが、予定の詳細は非表示になります。「`writer`」 - カレンダーに対する読み取り / 書き込みアクセス権を付与します。限定公開の予定は、書き込み権限を持つユーザーに表示され、予定の詳細も表示されます。「`owner`」 - カレンダーへの管理者アクセス権を付与します。このロールには、ライターロールのすべての権限に加えて、他のユーザーのアクセスレベルを表示して変更する権限が付与されています。重要: `owner` ロールは、カレンダーのデータ所有者とは異なります。カレンダーには 1 人のデータ所有者がいますが、`owner` ロールを持つユーザーは複数存在できます。
`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"` 省略可。
`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` プロパティに優先します。このプロパティを設定または変更するには、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: ユーザーのカレンダーリストにある既存のカレンダーを更新します。
watch: CalendarList リソースの変更を監視します。

CalendarList コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース表現

メソッド

CalendarList