Events: update

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

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名	値	説明
パスパラメータ
`calendarId`	`string`	カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメインカレンダーにアクセスする場合は、「`primary`」キーワードを使用します。
`eventId`	`string`	イベント識別子。
省略可能なクエリパラメータ
`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`」 - 出席者が招待を承諾しました。警告: `declined`、`tentative`、`accepted` の値を使用して予定を追加すると、[カレンダーに招待状を追加] の設定が [招待メールから出欠確認に返答したときに追加] または [知っているユーザーから届いた場合のみ追加] になっている出席者の返信が `needsAction` にリセットされ、予定招待メールで返信を変更しない限り、カレンダーに予定が表示されなくなる可能性があります。また、予定に 200 人を超えるゲストが招待されている場合、返信ステータスはゲストに伝播されません。	書き込み可能
`attendeesOmitted`	`boolean`	予定の表現から出席者が省略されているかどうか。イベントを取得する際に、`maxAttendee` クエリパラメータで指定された制限が原因でこのエラーが発生することがあります。イベントを更新する際に、参加者の回答のみを更新するために使用できます。省略可。デフォルトは False です。	書き込み可能
`colorId`	`string`	イベントの色。これは、色定義の `event` セクションのエントリを参照する ID です（色のエンドポイントを参照）。省略可。	書き込み可能
`conferenceData`	`nested object`	Google Meet の会議の詳細など、会議に関連する情報。新しい会議の詳細を作成するには、`createRequest` フィールドを使用します。変更を永続化するには、すべてのイベント変更リクエストで `conferenceDataVersion` リクエストパラメータを `1` に設定してください。警告: 異なるイベント間で Google Meet の会議データを再利用すると、アクセスに関する問題が発生し、会議の詳細が意図しないユーザーに公開される可能性があります。会議のプライバシーを確保するため、`createRequest` フィールドを使用して、イベントごとに一意の会議を生成してください。	書き込み可能
`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.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` フィールドで指定します。このフィールドは、単一のイベントまたは定期的なイベントのインスタンスでは省略されます。	書き込み可能
`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 つの異なる状態を表します。キャンセルされていない定期的な予定の例外がキャンセルされた場合、このインスタンスはユーザーに表示されなくなります。クライアントは、親の定期的な予定の存続期間中、これらの予定を保存する必要があります。キャンセルされた例外では、`id`、`recurringEventId`、`originalStartTime` フィールドの値のみが入力されることが保証されます。他のフィールドは空の場合があります。キャンセルされた他のすべてのイベントは、削除されたイベントを表します。クライアントはローカルで同期されたコピーを削除する必要があります。このようなキャンセルされたイベントは最終的に消滅するため、無期限に利用できるとは限りません。削除されたイベントでは、`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 リソースを返します。

試してみよう:

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