Calendars

既存のすべてのカレンダーのコレクション。カレンダーと 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
}
プロパティ名 説明 メモ
autoAcceptInvitations boolean このカレンダーで招待を自動的に受け入れるかどうか。リソース カレンダーでのみ有効です。
conferenceProperties nested object このカレンダーの会議プロパティ(許可される会議の種類など)。
conferenceProperties.allowedConferenceSolutionTypes[] list このカレンダーでサポートされている会議ソリューションの種類。

使用できる値は次のとおりです。

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
省略可。

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")。省略可。 書き込み可能

メソッド

鮮明度
メイン カレンダーをクリアします。この操作を行うと、アカウントのメイン カレンダーに関連付けられているすべての予定が削除されます。
delete
予備カレンダーを削除します。メイン カレンダーのすべての予定をクリアするには、calendars.clear を使用します。
get
カレンダーのメタデータを返します。
insert
予備カレンダーを作成します。

リクエストの認証済みユーザーが、新しいカレンダーのデータオーナーになります。

patch
カレンダーのメタデータを更新します。このメソッドは、パッチ セマンティクスをサポートしています。パッチ リクエストごとに 3 つの割り当てユニットが消費されます。get の後に update を使用することをおすすめします。指定したフィールド値は既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされ、以前の配列要素は破棄されます。
transferOwnership
Google Workspace 組織内のユーザー間で予備カレンダーを譲渡します。カレンダーの管理の管理者権限を持つユーザー認証と、次のいずれかの認可スコープが必要です。
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
リクエストで、useAdminAccesstrue に設定します。予備カレンダーを譲渡するには、有効にする必要があります。無効または削除されたカレンダーを譲渡することはできません。
update
カレンダーのメタデータを更新します。