Events: update

イベントを更新します。このメソッドはパッチのセマンティクスをサポートしておらず、常にイベント リソース全体を更新します。部分更新を行うには、get を実行してから、etags を使用して update を実行し、アトミック性を保証します。こちらからお試しいただくか、例をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 値 説明
パスパラメータ
calendarId string カレンダー ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary」キーワードを使用します。
eventId string イベント ID。
省略可能なクエリ パラメータ
alwaysIncludeEmail boolean 非推奨となり、無視されます。実際のメールアドレスが使用できない場合でも、主催者、作成者、参加者の email フィールドには常に値が返されます（つまり、生成された動作しない値が提供されます）。
conferenceDataVersion integer API クライアントでサポートされている会議データのバージョン番号。バージョン 0 では、会議データのサポートがないと想定され、イベントの本文内の会議データは無視されます。バージョン 1 では、ConferenceData のコピーと、conferenceData の createRequest フィールドを使用して新しい会議の作成がサポートされています。デフォルトは 0 です。有効な値は 0 以上 1 以下です。
maxAttendees integer レスポンスに含める参加者の最大数。指定した人数を超える場合は、参加者のみが返されます。省略可能。
sendNotifications boolean 非推奨です。代わりに sendUpdates を使用してください。

イベントの更新（説明の変更など）に関する通知を送信するかどうか。値を false に設定しても、一部のメールは送信される場合があります。デフォルトは false です。
sendUpdates string イベントの更新（タイトルの変更など）に関する通知を受け取るゲスト。

有効な値は次のとおりです。
  • 「all」: すべてのゲストに通知が送信されます。
  • 「externalOnly」: 通知は Google カレンダーを使用しないゲストにのみ送信されます。
  • 「none」: 通知は送信されません。カレンダーの移行タスクの場合は、代わりに Events.import メソッドの使用を検討してください。
supportsAttachments boolean オペレーションを実行する API クライアントがイベント アタッチメントをサポートしているかどうか。省略可。デフォルトは False です。

承認

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

範囲
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

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

リクエストの本文

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

プロパティ名 値 説明 メモ
必須プロパティ
end nested object イベントの終了時刻（終了時間は含まない）。繰り返しの予定の場合は、最初のインスタンスの終了時間です。
start nested object イベントの開始時間（この時間も含まれます）。定期的な予定の場合、これは最初のインスタンスの開始時間です。
省略可能なプロパティ
anyoneCanAddSelf boolean 誰でもイベントに自分自身を招待できるかどうか（非推奨）。省略可。デフォルトは False です。 書き込み可能
attachments[].fileUrl string 添付ファイルへの URL リンク。

Google ドライブのファイル添付ファイルを追加する場合は、Drive API の Files リソースの alternateLink プロパティと同じ形式を使用します。

添付ファイルを追加する際に必要です。

 書き込み可能
attendees[] list イベントの参加者。他のカレンダー ユーザーとの予定のスケジュール設定について詳しくは、参加者がいる予定のガイドをご覧ください。サービス アカウントは、ドメイン全体の権限の委任を使用して参加者リストにデータを入力する必要があります。 書き込み可能
attendees[].additionalGuests integer 追加のゲストの人数。省略可。デフォルトは 0 です。 書き込み可能
attendees[].comment string 参加者の回答コメント。省略可。 書き込み可能
attendees[].displayName string 参加者の名前（該当する場合）。省略可。 書き込み可能
attendees[].email string 参加者のメールアドレス（利用可能な場合）。このフィールドは、参加者を追加する際に指定する必要があります。RFC5322 に準拠した有効なメールアドレスにする必要があります。

参加者を追加する際に必要です。

 書き込み可能
attendees[].optional boolean 参加者が任意かどうか。省略可。デフォルトは False です。 書き込み可能
attendees[].resource boolean 参加者がリソースかどうか。参加者がイベントに初めて追加されたときにのみ設定できます。その後の変更は無視されます。省略可。デフォルトは False です。 書き込み可能
attendees[].responseStatus string 参加者の返信ステータス。指定できる値は次のとおりです。
  • 「needsAction」- 参加者が招待に返信していない（新しい予定に推奨）。
  • 「declined」 - 参加者が招待を拒否しました。
  • 「tentative」- 参加者が招待を仮承諾しています。
  • 「accepted」- 参加者が招待を承諾しました。
 書き込み可能
attendeesOmitted boolean イベントの表示から出席者が除外されている可能性があるかどうか。イベントを取得するときに、maxAttendee クエリ パラメータで指定された制限が原因で発生することがあります。イベントを更新する際に、参加者の回答のみを更新できます。省略可。デフォルトは False です。 書き込み可能
colorId string イベントの色。これは、色定義の event セクションのエントリを参照する ID です（ 色エンドポイントをご覧ください）。省略可。 書き込み可能
conferenceData nested object Google Meet 会議の詳細など、会議関連の情報。新しい会議の詳細を作成するには、createRequest フィールドを使用します。変更を永続化するには、すべてのイベント変更リクエストで conferenceDataVersion リクエスト パラメータを 1 に設定してください。 書き込み可能
description string イベントの説明。HTML を含めることができます。省略可。 書き込み可能
end.date date 終日の予定の場合は、日付（「yyyy-mm-dd」形式）。 書き込み可能
end.dateTime datetime 日時を組み合わせた値（RFC3339 に従ってフォーマット）。タイムゾーンが timeZone で明示的に指定されていない限り、タイムゾーン オフセットが必要です。 書き込み可能
end.timeZone string 時間を指定するタイムゾーン。（IANA タイムゾーン データベース名の形式で指定します。例: Europe/Zurich）。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 書き込み可能
extendedProperties.private object このカレンダーに表示される予定のコピーに固有のプロパティ。 書き込み可能
extendedProperties.shared object 他の参加者のカレンダーの予定のコピー間で共有されるプロパティ。 書き込み可能
focusTimeProperties nested object サイレント モードの予定データ。eventType が focusTime の場合に使用されます。 書き込み可能
gadget.display string ガジェットの表示モード。非推奨です。指定できる値は次のとおりです。
  • 「icon」 - カレンダー ビューで、予定のタイトルの横にガジェットが表示されます。
  • 「chip」 - イベントがクリックされたときにガジェットが表示されます。
 書き込み可能
gadget.height integer ガジェットの高さ（ピクセル単位）。高さには 0 より大きい整数を指定してください。省略可。サポート終了。 書き込み可能
gadget.preferences object 設定] をクリックします。 書き込み可能
gadget.title string ガジェットのタイトル。サポート終了。 書き込み可能
gadget.type string ガジェットのタイプ。サポート終了。 書き込み可能
gadget.width integer ガジェットの幅（ピクセル単位）。幅には 0 より大きい整数を指定してください。省略可。サポート終了。 書き込み可能
guestsCanInviteOthers boolean 主催者以外の参加者がイベントに他のユーザーを招待できるかどうか。省略可。デフォルトは True です。 書き込み可能
guestsCanModify boolean 主催者以外の参加者がイベントを変更できるかどうか。省略可。デフォルトは False です。 書き込み可能
guestsCanSeeOtherGuests boolean 主催者以外の参加者がイベントの参加者を確認できるかどうか。省略可。デフォルトは True です。 書き込み可能
location string イベントの地理的位置（自由形式のテキスト）。省略可。 書き込み可能
originalStartTime.date date 終日の予定の場合は、日付（「yyyy-mm-dd」形式）。 書き込み可能
originalStartTime.dateTime datetime 日時を組み合わせた値（RFC3339 に従ってフォーマット）。タイムゾーンが timeZone で明示的に指定されていない限り、タイムゾーン オフセットが必要です。 書き込み可能
originalStartTime.timeZone string 時間を指定するタイムゾーン。（IANA タイムゾーン データベース名の形式で指定します。例: Europe/Zurich）。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 書き込み可能
outOfOfficeProperties nested object 不在の予定データ。eventType が outOfOffice の場合に使用されます。 書き込み可能
recurrence[] list RFC5545 で指定されている、繰り返しイベントの RRULE、EXRULE、RDATE、EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は使用できません。イベントの開始時間と終了時間は start フィールドと end フィールドで指定します。1 回のイベントや定期的なイベントのインスタンスの場合は、このフィールドは省略されます。 書き込み可能
reminders.overrides[] list イベントでデフォルトのリマインダーを使用していない場合は、イベントに固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことを示します。オーバーライド リマインダーの最大数は 5 つです。 書き込み可能
reminders.overrides[].method string このリマインダーで使用されるメソッド。指定できる値は次のとおりです。
  • 「email」- リマインダーはメールで送信されます。
  • 「popup」- リマインダーは UI ポップアップを介して送信されます。

リマインダーを追加する際に必須です。

 書き込み可能
reminders.overrides[].minutes integer イベントの開始前にリマインダーをトリガーするまでの時間（分）。有効な値は 0 ～ 40320（4 週間分）です。

リマインダーを追加する際に必須です。

 書き込み可能
reminders.useDefault boolean カレンダーのデフォルトのリマインダーを予定に適用するかどうか。 書き込み可能
sequence integer iCalendar のシーケンス番号。 書き込み可能
source.title string ソースのタイトル（ウェブページのタイトルやメールの件名など）。 書き込み可能
source.url string リソースを参照するソースの URL。URL スキームは HTTP または HTTPS にする必要があります。 書き込み可能
start.date date 終日の予定の場合は、日付（「yyyy-mm-dd」形式）。 書き込み可能
start.dateTime datetime 日時を組み合わせた値（RFC3339 に従ってフォーマット）。タイムゾーンが timeZone で明示的に指定されていない限り、タイムゾーン オフセットが必要です。 書き込み可能
start.timeZone string 時間を指定するタイムゾーン。（IANA タイムゾーン データベース名の形式で指定します。例: Europe/Zurich）。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 書き込み可能
status string イベントのステータス。省略可。指定できる値は次のとおりです。
  • 「confirmed」 - イベントが確定しています。これがデフォルトのステータスです。
  • 「tentative」- イベントは仮承諾されています。
  • 「cancelled」 - イベントはキャンセルされています（削除済み）。list メソッドは、増分同期（syncToken または updatedMin が指定されている場合）または showDeleted フラグが true に設定されている場合にのみ、キャンセルされたイベントを返します。get メソッドは常にそれらを返します。

    キャンセル済みステータスは、イベントの種類に応じて 2 つの異なる状態を表します。

    1. キャンセルされていない定期的な予定の例外をキャンセルすると、そのインスタンスはユーザーに表示されなくなります。クライアントは、親の定期的なイベントの存続期間中、これらのイベントを保存する必要があります。

      キャンセルされた例外では、id、recurringEventId、originalStartTime フィールドの値のみが確実に入力されます。他のフィールドは空の場合があります。

    2. その他のキャンセルされたイベントは、削除されたイベントを表します。クライアントは、ローカルに同期したコピーを削除する必要があります。キャンセルされたイベントは最終的には削除されるため、無期限に利用できるとは限りません。

      削除されたイベントでは、id フィールドにのみ値が入力されます。

    主催者のカレンダーでは、キャンセルされた予定の詳細（概要、場所など）は引き続き表示されるため、復元（削除解除）できます。同様に、ユーザーが招待されたイベントで、ユーザーが手動で削除したイベントの詳細も引き続き表示されます。ただし、showDeleted が false に設定された増分同期リクエストでは、これらの詳細は返されません。

    イベントの主催者が変更された場合（移動オペレーションなど）、元の主催者が出席者リストにない場合、id フィールドのみが確実に入力されたキャンセル済みイベントが残ります。

 書き込み可能
summary string イベントのタイトル。 書き込み可能
transparency string 予定がカレンダーで時間をブロックするかどうか。省略可。指定できる値は次のとおりです。
  • 「opaque」- デフォルト値。カレンダーで時間はブロックされます。これは、カレンダーの UI で [表示する] を [予定あり] に設定するのと同じです。
  • 「transparent」- カレンダー上の時間をブロックしません。これは、カレンダーの UI で [表示名] を [空き時間] に設定するのと同じです。
 書き込み可能
visibility string イベントの公開設定。省略可。指定できる値は次のとおりです。
  • 「default」 - カレンダーの予定のデフォルトの公開設定を使用します。これがデフォルト値です。
  • 「public」- 予定は公開され、カレンダーのすべての閲覧者に予定の詳細が表示されます。
  • 「private」 - イベントは非公開で、イベントの参加者のみイベントの詳細を表示できます。
  • 「confidential」 - イベントは非公開です。この値は互換性を確保するために提供されています。
 書き込み可能
workingLocationProperties nested object 勤務地イベントデータ。 書き込み可能
workingLocationProperties.customLocation object 指定されている場合、ユーザーがカスタムの勤務場所で勤務していることを示します。 書き込み可能
workingLocationProperties.customLocation.label string 追加情報用の追加ラベル（省略可）。 書き込み可能
workingLocationProperties.homeOffice any value 指定されている場合、ユーザーが在宅勤務中であることを指定します。 書き込み可能
workingLocationProperties.officeLocation object 指定されている場合、ユーザーがオフィスで勤務していることを示します。 書き込み可能
workingLocationProperties.officeLocation.buildingId string 建物の識別子（省略可）。これは、組織のリソース データベース内のビルディング ID を参照する必要があります。 書き込み可能
workingLocationProperties.officeLocation.deskId string デスクの識別子（省略可）。 書き込み可能
workingLocationProperties.officeLocation.floorId string フロア識別子（省略可）。 書き込み可能
workingLocationProperties.officeLocation.floorSectionId string フロア セクションの識別子（省略可）。 書き込み可能
workingLocationProperties.officeLocation.label string カレンダーのウェブ クライアントとモバイル クライアントに表示されるオフィス名。組織のリソース データベース内の建物名を参照することをおすすめします。 書き込み可能
workingLocationProperties.type string 勤務地のタイプ。指定できる値は次のとおりです。
  • 「homeOffice」- ユーザーが自宅で勤務している。
  • 「officeLocation」- ユーザーがオフィスで勤務している。
  • 「customLocation」- ユーザーがカスタムの場所で勤務している。
詳細は、指定された名前のサブフィールドで指定されますが、このフィールドが空の場合は省略されることがあります。他のフィールドはすべて無視されます。

勤務場所のプロパティを追加する場合に必須です。

 書き込み可能

レスポンス

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

例

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

Java

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

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

// ...

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

// Retrieve the event from the API
Event event = service.events().get("primary", "eventId").execute();

// Make a change
event.setSummary("Appointment at Somewhere");

// Update the event
Event updatedEvent = service.events().update("primary", event.getId(), event).execute();

System.out.println(updatedEvent.getUpdated());

Python

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

# First retrieve the event from the API.
event = service.events().get(calendarId='primary', eventId='eventId').execute()

event['summary'] = 'Appointment at Somewhere'

updated_event = service.events().update(calendarId='primary', eventId=event['id'], body=event).execute()

# Print the updated date.
print updated_event['updated']

PHP

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

// First retrieve the event from the API.
$event = $service->events->get('primary', 'eventId');

$event->setSummary('Appointment at Somewhere');

$updatedEvent = $service->events->update('primary', $event->getId(), $event);

// Print the updated date.
echo $updatedEvent->getUpdated();

Ruby

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

event = client.get_event('primary', 'eventId')
event.summary = 'Appointment at Somewhere'
result = client.update_event('primary', event.id, event)
print result.updated

試してみよう:

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