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

CalendarList: insert

ユーザーのカレンダーリストに既存のカレンダーを挿入します。今すぐ試すまたは例を見る。

リクエスト

HTTP リクエスト

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

パラメータ

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

承認

このリクエストには、次のスコープによる認証が必要です。

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

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

リクエスト本文

リクエストの本文には、以下のプロパティを使用して 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 リソースを返します。

例

注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません（サポートされている言語の一覧については、クライアントライブラリページをご覧ください）。

Java

Java クライアントライブラリを使用します。

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Create a new calendar list entry
CalendarListEntry calendarListEntry = new CalendarListEntry();
calendarListEntry.setId("calendarId");

// Insert the new calendar list entry
CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute();

System.out.println(createdCalendarListEntry.getSummary());

Python

Python クライアントライブラリを使用します。

calendar_list_entry = {
    'id': 'calendarId'
}

created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute()

print created_calendar_list_entry['summary']

PHP

PHP クライアントライブラリを使用します。

$calendarListEntry = new Google_Service_Calendar_CalendarListEntry();
$calendarListEntry->setId("calendarId");

$createdCalendarListEntry = $service->calendarList->insert($calendarListEntry);

echo $createdCalendarListEntry->getSummary();

Ruby

Ruby クライアントライブラリを使用します。

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

試してみよう:

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