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

CalendarList: update

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

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名	値	説明
パスパラメータ
`calendarId`	`string`	カレンダーの ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメインカレンダーにアクセスするには、「`primary`」を使用します。できます。
省略可能なクエリパラメータ
`colorRgbFormat`	`boolean`	`foregroundColor` フィールドと `backgroundColor` フィールドを使用してカレンダーの色（RGB）を書き込むかどうか。この機能を使用する場合は、インデックスベースの `colorId` フィールドが最適なオプションに自動的に設定されます。省略可。デフォルトは False です。

承認

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

スコープ
`https://www.googleapis.com/auth/calendar`

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

リクエスト本文

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

プロパティ名	値	説明	メモ
省略可能なプロパティ
`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();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

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

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

PHP

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

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

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

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

試してみよう:

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