このページは Cloud Translation API によって翻訳されました。

CalendarList: insert

既存のカレンダーをユーザーのカレンダーリストに挿入します。実習をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

パラメータ

パラメータ名	値	説明
省略可能なクエリパラメータ
`colorRgbFormat`	`boolean`	`foregroundColor` フィールドと `backgroundColor` フィールドを使用してカレンダーの色（RGB）を書き込むかどうか。この機能を使用すると、インデックスベースの `colorId` フィールドが最適な一致オプションに自動的に設定されます。省略可。デフォルトは False です。

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。

範囲
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.calendarlist`

詳しくは、認証と認可のページをご覧ください。

リクエストの本文

リクエストの本文には、以下のプロパティを使用して CalendarList リソースを指定します。

プロパティ名	値	説明	メモ
必須プロパティ
`id`	`string`	カレンダーの識別子。
省略可能なプロパティ
`backgroundColor`	`string`	カレンダーのメインカラー（16 進数形式「`#0088aa`」）。このプロパティは、インデックスベースの `colorId` プロパティに代わるものです。このプロパティを設定または変更するには、insert メソッド、update メソッド、patch メソッドのパラメータで `colorRgbFormat=true` を指定する必要があります。省略可。	書き込み可能
`colorId`	`string`	カレンダーの色。これは、色定義の `calendar` セクションのエントリを参照する ID です（色エンドポイントをご覧ください）。このプロパティは `backgroundColor` プロパティと `foregroundColor` プロパティに置き換えられ、これらのプロパティを使用する場合は無視できます。省略可。	書き込み可能
`defaultReminders[]`	`list`	認証されたユーザーがこのカレンダーに対して設定しているデフォルトのリマインダー。	書き込み可能
`defaultReminders[].method`	`string`	このリマインダーで使用されるメソッド。指定できる値は次のとおりです。「`email`」- リマインダーはメールで送信されます。「`popup`」- リマインダーは UI ポップアップを介して送信されます。リマインダーを追加する際に必須です。	書き込み可能
`defaultReminders[].minutes`	`integer`	イベントの開始前にリマインダーをトリガーするまでの時間（分）。有効な値は 0 ～ 40320（4 週間分）です。リマインダーを追加する際に必須です。	書き込み可能
`foregroundColor`	`string`	カレンダーの前景色（16 進数形式の「`#ffffff`」）。このプロパティは、インデックスベースの `colorId` プロパティに代わるものです。このプロパティを設定または変更するには、insert メソッド、update メソッド、patch メソッドのパラメータで `colorRgbFormat=true` を指定する必要があります。省略可。	書き込み可能
`hidden`	`boolean`	カレンダーがリストから非表示になっているかどうか。省略可。この属性は、カレンダーが非表示になっている場合にのみ返されます。その場合、値は `true` です。	書き込み可能
`notificationSettings`	`object`	認証されたユーザーがこのカレンダーに対して受信している通知。	書き込み可能
`notificationSettings.notifications[].method`	`string`	通知の配信に使用される方法。使用できる値は次のとおりです。「`email`」 - 通知はメールで送信されます。通知を追加する際に必須です。	書き込み可能
`notificationSettings.notifications[].type`	`string`	通知のタイプ。指定できる値は次のとおりです。「`eventCreation`」- カレンダーに新しい予定が追加されたときに送信される通知。「`eventChange`」 - 予定が変更されたときに送信される通知。「`eventCancellation`」- イベントがキャンセルされたときに送信される通知。「`eventResponse`」- 参加者がイベントの招待に返信したときに送信される通知。「`agenda`」 - 当日の予定が記載されたアジェンダ（午前中に送信）。通知を追加する際に必須です。	書き込み可能
`selected`	`boolean`	カレンダーコンテンツがカレンダー UI に表示されるかどうか。省略可。デフォルトは False です。	書き込み可能
`summaryOverride`	`string`	認証されたユーザーがこのカレンダーに設定した概要。省略可。	書き込み可能

レスポンス

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

試してみよう:

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