Events: update

イベントを更新します。この方法では、パッチのセマンティクスはサポートされておらず、常にイベント リソース全体を更新します。部分的な更新を行うには、アトミック性を確保するために ETag を使用して get の後に 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

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

リクエスト本文

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

プロパティ名 値 説明 メモ
必須プロパティ
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 時刻が指定されているタイムゾーン。（形式は「Europe/Zurich」などの IANA タイムゾーン データベース名になります）。定期的な予定の場合、このフィールドは必須です。展開されるタイムゾーンのタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能で、イベントの開始と終了のカスタム タイムゾーンを示します。 書き込み可能
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 時刻が指定されているタイムゾーン。（形式は「Europe/Zurich」などの IANA タイムゾーン データベース名になります）。定期的な予定の場合、このフィールドは必須です。展開されるタイムゾーンのタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能で、イベントの開始と終了のカスタム タイムゾーンを示します。 書き込み可能
outOfOfficeProperties nested object 不在の予定データ。eventType が outOfOffice の場合に使用されます。 書き込み可能
recurrence[] list RFC5545 で指定されている、定期的なイベントの RRULE、EXRULE、RDATE、EXDATE 行のリスト。このフィールドでは、DTSTART 行と DTEND 行は使用できません。イベントの開始時刻と終了時刻は、start フィールドと end フィールドで指定します。単一の予定または定期的な予定の場合、このフィールドは省略されます。 書き込み可能
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 時刻が指定されているタイムゾーン。（形式は「Europe/Zurich」などの IANA タイムゾーン データベース名になります）。定期的な予定の場合、このフィールドは必須です。展開されるタイムゾーンのタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能で、イベントの開始と終了のカスタム タイムゾーンを示します。 書き込み可能
status string イベントのステータス。省略可。有効な値は次のとおりです。
  • 「confirmed」- イベントが確定した。これがデフォルトのステータスです。
  • 「tentative」- イベントは暫定的に確定する。
  • 「cancelled」- 予定はキャンセル（削除）されています。list メソッドは、キャンセルされたイベントのみを増分同期のとき（syncToken または updatedMin が指定されている場合）、または showDeleted フラグが true に設定されている場合にのみ返します。get メソッドは常にそれらを返します。

    キャンセル ステータスは、イベントの種類に応じて次の 2 つのステータスを表します。

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

      キャンセルされた例外では、id、recurringEventId、originalStartTime フィールドの値が入力されていることが保証されます。他のフィールドは空である場合があります。

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

      削除されたイベントについては、id フィールドに値が入力されることのみが保証されます。

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

    予定の主催者が変更されたときに（move 操作などにより）、元の主催者が参加者リストに含まれていなかった場合、その予定はキャンセルされ、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（省略可）。組織のリソース データベースにあるビルディング ID を参照する必要があります。 書き込み可能
workingLocationProperties.officeLocation.deskId string デスク ID（省略可）。 書き込み可能
workingLocationProperties.officeLocation.floorId string オプションの階 ID。 書き込み可能
workingLocationProperties.officeLocation.floorSectionId string オプションの階のセクション ID。 書き込み可能
workingLocationProperties.officeLocation.label string ウェブ版カレンダーおよびモバイル版カレンダー クライアントに表示されるオフィス名。組織のリソース データベースにあるビルディング名を参照することをおすすめします。 書き込み可能
workingLocationProperties.type string 勤務場所のタイプ。有効な値は次のとおりです。
  • 「homeOffice」- ユーザーは自宅で仕事をしている。
  • 「officeLocation」- ユーザーはオフィスで勤務している。
  • 「customLocation」- ユーザーはカスタムの場所から勤務している。
すべての詳細は指定された名前のサブフィールドで指定しますが、このフィールドが空の場合、このフィールドが見つからないことがあります。それ以外のフィールドは無視されます。

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

 書き込み可能

レスポンス

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

例

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

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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。