ユーザーのカレンダー リスト内のカレンダーのコレクション。 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 |
認証されたユーザーがカレンダーに対して持っている有効なアクセス ロール。読み取り専用。有効な値は次のとおりです。
|
|
backgroundColor |
string |
カレンダーのメインの色(16 進数形式「#0088aa 」)。このプロパティは、インデックス ベースの colorId プロパティよりも優先されます。このプロパティを設定または変更するには、insert、update、patch の各メソッドのパラメータで colorRgbFormat=true を指定する必要があります。省略可。 |
書き込み可能 |
colorId |
string |
カレンダーの色。これは、色定義の calendar セクション内のエントリを参照する ID です(カラー エンドポイントを参照)。このプロパティは backgroundColor プロパティと foregroundColor プロパティより優先されており、これらのプロパティを使用する場合は無視されます。省略可。 |
書き込み可能 |
conferenceProperties |
nested object |
このカレンダーの会議プロパティ(許可する会議の種類など)。 | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
このカレンダーでサポートされている会議ソリューションの種類。 可能な値は次のとおりです。
|
|
defaultReminders[] |
list |
認証されたユーザーがこのカレンダーに設定するデフォルトのリマインダー。 | 書き込み可能 |
defaultReminders[].method |
string |
このリマインダーで使用されるメソッド。有効な値は次のとおりです。
リマインダーを追加する場合は必須です。 |
書き込み可能 |
defaultReminders[].minutes |
integer |
リマインダーがトリガーされる、イベント開始前の分数。有効な値は 0 ~ 40320(4 週間分)です。 リマインダーを追加する場合は必須です。 |
書き込み可能 |
deleted |
boolean |
このカレンダー リストのエントリがカレンダー リストから削除されているかどうか。読み取り専用。(省略可)デフォルトは False です。 | |
description |
string |
カレンダーの説明。(省略可)読み取り専用です。 | |
etag |
etag |
リソースの ETag。 | |
foregroundColor |
string |
カレンダーのフォアグラウンドの色を 16 進数形式「#ffffff 」で表したものです。このプロパティは、インデックス ベースの colorId プロパティよりも優先されます。このプロパティを設定または変更するには、insert、update、patch の各メソッドのパラメータで colorRgbFormat=true を指定する必要があります。省略可。 |
書き込み可能 |
id |
string |
カレンダーの識別子。 | |
kind |
string |
リソースのタイプ(「calendar#calendarListEntry」)。 | |
location |
string |
自由形式のテキストで表されるカレンダーの地域。(省略可)読み取り専用です。 | |
notificationSettings |
object |
認証されたユーザーがこのカレンダーについて受け取る通知。 | 書き込み可能 |
notificationSettings.notifications[] |
list |
このカレンダーに設定された通知のリスト。 | |
notificationSettings.notifications[].method |
string |
通知の配信に使用された方法。可能な値:
通知を追加する場合は必須です。 |
書き込み可能 |
notificationSettings.notifications[].type |
string |
通知のタイプ。有効な値は次のとおりです。
通知を追加する場合は必須です。 |
書き込み可能 |
primary |
boolean |
カレンダーが認証済みユーザーのメイン カレンダーかどうか。読み取り専用。(省略可)デフォルトは False です。 | |
selected |
boolean |
カレンダーのコンテンツをカレンダー UI に表示するかどうかを指定します。(省略可)デフォルトは False です。 | 書き込み可能 |
summary |
string |
カレンダーのタイトル。読み取り専用です。 | |
summaryOverride |
string |
認証されたユーザーがこのカレンダーに設定した概要。省略可。 | 書き込み可能 |
timeZone |
string |
カレンダーのタイムゾーン。(省略可)読み取り専用です。 |
Methods
- delete
- ユーザーのカレンダー リストからカレンダーを削除します。
- get
- ユーザーのカレンダー リストからカレンダーを返します。
- 挿入
- ユーザーのカレンダー リストに既存のカレンダーを挿入します。
- list
- ユーザーのカレンダー リストのカレンダーを返します。
- パッチ
- ユーザーのカレンダー リストにある既存のカレンダーを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。
get
の後にupdate
を続けることをおすすめします。指定したフィールド値によって既存の値が置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。 - update
- ユーザーのカレンダー リストにある既存のカレンダーを更新します。
- スマートウォッチ
- CalendarList リソースの変更を監視します。