イベントを更新します。このメソッドはパッチのセマンティクスをサポートせず、常にイベント リソース全体を更新します。部分更新を行うには、アトミック性を確保するために、get
の後に ETag を使用して update
を実行します。こちらから今すぐ試してみるか、例をご覧ください。
リクエスト
HTTP リクエスト
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
calendarId |
string |
カレンダーの識別子。カレンダー 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 |
予定の更新(タイトルの変更など)に関する通知を受け取るゲスト。
有効な値は次のとおりです。
|
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 の 添付ファイルを追加する場合は必須です。 |
書き込み可能 |
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 |
参加者の返信ステータス。有効な値は次のとおりです。
|
書き込み可能 |
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 |
ガジェットの表示モード。非推奨です。有効な値は次のとおりです。
|
書き込み可能 |
gadget.height |
integer |
ピクセル単位のガジェットの高さです。高さには 0 より大きい整数を指定してください。(省略可)廃止されました。 | 書き込み可能 |
gadget.iconLink |
string |
ガジェットのアイコンの URL。URL スキームは HTTPS にする必要があります。廃止されました。 | 書き込み可能 |
gadget.link |
string |
ガジェットの URL。URL スキームは HTTPS にする必要があります。廃止されました。 | 書き込み可能 |
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 |
このリマインダーで使用されるメソッド。有効な値は次のとおりです。
リマインダーを追加する場合は必須です。 |
書き込み可能 |
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 |
イベントのステータス。(省略可)有効な値は次のとおりです。
|
書き込み可能 |
summary |
string |
予定のタイトル。 | 書き込み可能 |
transparency |
string |
その予定がカレンダー上の時間をブロックしているかどうか。(省略可)有効な値は次のとおりです。
|
書き込み可能 |
visibility |
string |
イベントの公開設定。(省略可)有効な値は次のとおりです。
|
書き込み可能 |
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 |
デスク ID(省略可)。 | 書き込み可能 |
workingLocationProperties.officeLocation.floorId |
string |
階数 ID(省略可)。 | 書き込み可能 |
workingLocationProperties.officeLocation.floorSectionId |
string |
階数セクション ID(省略可)。 | 書き込み可能 |
workingLocationProperties.officeLocation.label |
string |
カレンダーのウェブ クライアントとモバイル クライアントに表示されるオフィス名。組織のリソース データベースでビルディング名を参照することをおすすめします。 | 書き込み可能 |
workingLocationProperties.type |
string |
勤務場所の種類。有効な値は次のとおりです。
勤務場所のプロパティを追加する場合は必須です。 |
書き込み可能 |
レスポンス
成功すると、このメソッドはレスポンスの本文でイベント リソースを返します。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。