イベントを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当て単位を消費します。get の後に update を使用することをおすすめします。指定したフィールド値は、既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドが指定されている場合、既存の配列が上書きされ、以前の配列要素はすべて破棄されます。こちらから今すぐお試しください。
リクエスト
HTTP リクエスト
PATCH 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 です。 |
eventLabelVersion |
integer |
API クライアントでサポートされているイベントラベル機能のバージョン番号。バージョン 0 では、イベントラベルのサポートがないことを前提として、カラー マネジメントのために colorId フィールドを処理します。バージョン 1 では、イベントラベルのサポートが有効になり、イベントの本文の eventLabelId が処理されます。この場合、colorId フィールドは無視されます。デフォルトは 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 |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
詳細については、認証と認可のページをご覧ください。
リクエストの本文
パッチのセマンティクスの規則に従って、リクエストの本体に Events リソースの該当部分を指定します。
レスポンス
成功すると、このメソッドはレスポンスの本文で Events リソースを返します。
試してみよう:
以下の API Explorer を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。