Calendars: update

カレンダーのメタデータを更新します。 実習をご覧ください。

リクエスト

HTTP リクエスト

PUT https://www.googleapis.com/calendar/v3/calendars/calendarId

パラメータ

パラメータ名 値 説明
パスパラメータ
calendarId string カレンダー ID。カレンダー 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

詳細については、認証と認可のページをご覧ください。

リクエストの本文

リクエスト本文で、次のプロパティを持つカレンダー リソースを指定します。

プロパティ名 値 説明 メモ
省略可能なプロパティ
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」)。省略可。 書き込み可能
workingHours object ユーザーの勤務時間に関する情報を表します。Google Workspace ユーザーのメイン カレンダーでのみ利用できます。業務時間を更新するには、業務時間オブジェクト全体を渡す必要があります。指定しない場合(または null もしくは空のオブジェクトとして渡された場合)、既存の勤務時間は変更されません。勤務時間を無効にするか、スケジュールをクリアするには、workingHoursEnabled を false に設定します(availableTimes を省略するか、空のリストを渡します)。 書き込み可能
workingHours.availableTimes[] list 業務時間。各対応可能期間は、1 日のユーザーの勤務時間ブロックを表します。 書き込み可能
workingHours.availableTimes[].dayOfWeek string 曜日。必須。指定できる値は次のとおりです。
  • 「monday」
  • 「tuesday」
  • 「wednesday」
  • 「thursday」
  • 「friday」
  • 「saturday」
  • 「sunday」
書き込み可能
workingHours.availableTimes[].periodEnd integer 期間の終了。1 日の開始からの経過時間(分単位、この値は含まれません)。必須。 書き込み可能
workingHours.availableTimes[].periodStart integer 期間の開始。1 日の開始からの経過時間(分単位、この値を含む)。必須。 書き込み可能
workingHours.workingHoursEnabled boolean このカレンダーで業務時間が有効になっているかどうか。availableTimes が空の場合、true に設定することはできません。 書き込み可能

レスポンス

成功すると、このメソッドはレスポンスの本文に Calendars リソースを返します。

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。