既存のすべてのカレンダーのコレクション。カレンダーと CalendarList もご覧ください。
このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソース表現
{
"kind": "calendar#calendar",
"etag": etag,
"id": string,
"summary": string,
"description": string,
"location": string,
"timeZone": string,
"dataOwner": string,
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
string
]
},
"labelProperties": {
"eventLabels": [
{
"id": string,
"backgroundColor": string,
"name": string
}
]
},
"autoAcceptInvitations": boolean,
"workingHours": {
"workingHoursEnabled": boolean,
"availableTimes": [
{
"dayOfWeek": string,
"periodStart": integer,
"periodEnd": integer
}
]
}
}| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
autoAcceptInvitations |
boolean |
このカレンダーが招待を自動的に承諾するかどうか。リソース カレンダーでのみ有効です。 | |
conferenceProperties |
nested object |
このカレンダーの会議プロパティ（許可される会議の種類など）。 | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
このカレンダーでサポートされている会議ソリューションの種類。 使用できる値は次のとおりです。
|
|
dataOwner |
string |
カレンダーのオーナーのメールアドレス。予備カレンダーにのみ設定されます。読み取り専用です。 | |
description |
string |
カレンダーの説明。省略可。 | 書き込み可能 |
etag |
etag |
リソースの ETag。 | |
id |
string |
カレンダーの識別子。ID を取得するには、calendarList.list() メソッドを呼び出します。 | |
kind |
string |
リソースのタイプ（「calendar#calendar」）。 |
|
labelProperties |
nested object |
このカレンダーで定義されているラベルのプロパティ。指定すると、既存のラベル プロパティが上書きされます。指定しない場合、ラベルのプロパティは変更されません。 | 書き込み可能 |
labelProperties.eventLabels[] |
list |
このカレンダーで定義されている予定ラベル。カレンダーの更新時にこのフィールドが存在する場合、既存の予定ラベルが置き換えられます。 リストを拡張して新しい予定ラベルを追加し、リストからエンティティを削除してカレンダーからラベルを削除します。 各カレンダーに設定できるラベルは最大 200 個です。 |
書き込み可能 |
labelProperties.eventLabels[].backgroundColor |
string |
ラベルの背景色（16 進数形式、例: "#039be5"）。このラベルが付いたイベントは、この色で表示されます。必須。 |
書き込み可能 |
labelProperties.eventLabels[].id |
string |
ラベルの ID。新しいラベルを挿入する場合は省略可能です。指定しない場合は、一意の ID が生成されます。ラベルを更新する場合は必須です。 指定する場合、ID はカレンダー内で一意であり、UUID 形式に準拠している必要があります。 |
書き込み可能 |
labelProperties.eventLabels[].name |
string |
ラベルの名前。省略可。 指定する場合は、50 文字以下にする必要があります。 |
書き込み可能 |
location |
string |
カレンダーの地理的位置（自由形式のテキスト）。省略可。 | 書き込み可能 |
summary |
string |
カレンダーのタイトル。 | 書き込み可能 |
timeZone |
string |
カレンダーのタイムゾーン。（IANA タイムゾーン データベース名としてフォーマットされます。例: 「Europe/Zurich」）。省略可。 | 書き込み可能 |
workingHours |
object |
ユーザーの勤務時間に関する情報を表します。Google Workspace ユーザーのメイン カレンダーでのみ利用できます。業務時間を更新するには、業務時間オブジェクト全体を渡す必要があります。指定しない場合（または null もしくは空のオブジェクトとして渡された場合）、既存の勤務時間は変更されません。勤務時間を無効にするか、スケジュールをクリアするには、workingHoursEnabled を false に設定します（availableTimes を省略するか、空のリストを渡します）。 |
書き込み可能 |
workingHours.availableTimes[] |
list |
業務時間。各対応可能期間は、1 日のユーザーの勤務時間ブロックを表します。 | 書き込み可能 |
workingHours.availableTimes[].dayOfWeek |
string |
曜日。必須。指定できる値は次のとおりです。
|
書き込み可能 |
workingHours.availableTimes[].periodEnd |
integer |
期間の終了。1 日の開始からの経過時間（分単位、この値は含まれません）。必須。 | 書き込み可能 |
workingHours.availableTimes[].periodStart |
integer |
期間の開始。1 日の開始からの経過時間（分単位、この値を含む）。必須。 | 書き込み可能 |
workingHours.workingHoursEnabled |
boolean |
このカレンダーで業務時間が有効になっているかどうか。availableTimes が空の場合、true に設定することはできません。 |
書き込み可能 |
メソッド
- 鮮明度
- メイン カレンダーを消去します。このオペレーションでは、アカウントのメイン カレンダーに関連付けられているすべての予定が削除されます。
- delete
- 予備カレンダーを削除します。メイン カレンダーのすべての予定を消去するには、calendars.clear を使用します。
- get
- カレンダーのメタデータを返します。
- insert
- 予備カレンダーを作成します。
リクエストの認証済みユーザーが、新しいカレンダーのデータオーナーになります。
- patch
- カレンダーのメタデータを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。
getの後にupdateを使用することをおすすめします。指定したフィールド値によって既存の値が置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。これにより、以前の配列要素はすべて破棄されます。 - transferOwnership
- Google Workspace 組織内のユーザー間で予備カレンダーを移行します。カレンダーの管理の管理者権限と、次のいずれかの認可スコープを持つユーザー認証が必要です。
https://www.googleapis.com/auth/calendarhttps://www.googleapis.com/auth/calendar.calendars
useAdminAccessをtrueに設定します。予備カレンダーを移行するには、そのカレンダーが有効になっている必要があります。無効または削除されたカレンダーの移行はサポートされていません。 - update
- カレンダーのメタデータを更新します。