イベントを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get
の後に update
を使用することをおすすめします。指定したフィールド値が既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドが指定されている場合、既存の配列が上書きされます。これにより、以前の配列要素は破棄されます。今すぐお試しください。
リクエスト
HTTP リクエスト
PATCH 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 |
イベントの更新(タイトルの変更など)に関する通知を受け取るゲスト。
有効な値は次のとおりです。
|
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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。