カレンダーのメタデータを更新します。 実習をご覧ください。
リクエスト
HTTP リクエスト
PUT https://www.googleapis.com/calendar/v3/calendars/calendarIdパラメータ
| パラメータ名 | 値 | 説明 |
|---|---|---|
| パスパラメータ | ||
calendarId |
string |
カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスする場合は、キーワード「primary」を使用します。
|
承認
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
| スコープ |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendars |
詳しくは、認証と認可のページをご覧ください。
リクエストの本文
リクエストの本文には、以下のプロパティを使用して Calendars リソースを指定します。
| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
| 省略可能なプロパティ | |||
description |
string |
カレンダーの説明。省略可。 | 書き込み可能 |
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"）。省略可。 | 書き込み可能 |
レスポンス
成功すると、このメソッドによりレスポンスの本文で Calendars リソース が返されます。
試してみよう:
以下の API Explorer を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。