Events: patch
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
イベントを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 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 |
イベントの更新(タイトルの変更など)に関する通知を受け取るゲスト。
有効な値は次のとおりです。
- 「
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 リソースの該当部分を指定します。
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Events: patch\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an event. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a `get` followed by an `update`. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `calendarId` | `string` | Calendar identifier. To retrieve calendar IDs call the [calendarList.list](/workspace/calendar/api/v3/reference/calendarList/list) method. If you want to access the primary calendar of the currently logged in user, use the \"`primary`\" keyword. |\n| `eventId` | `string` | Event identifier. |\n| **Optional query parameters** |||\n| `alwaysIncludeEmail` | `boolean` | Deprecated and ignored. A value will always be returned in the `email` field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). |\n| `conferenceDataVersion` | `integer` | Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Acceptable values are `0` to `1`, inclusive. |\n| `maxAttendees` | `integer` | The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. |\n| `sendNotifications` | `boolean` | Deprecated. Please use [sendUpdates](/workspace/calendar/api/v3/reference/events/update#sendUpdates) instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to `false`. The default is `false`. |\n| `sendUpdates` | `string` | Guests who should receive notifications about the event update (for example, title changes, etc.). \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`all`\": Notifications are sent to all guests. - \"`externalOnly`\": Notifications are sent to non-Google Calendar guests only. - \"`none`\": No notifications are sent. For calendar migration tasks, consider using the [Events.import](/workspace/calendar/api/v3/reference/events/import) method instead. |\n| `supportsAttachments` | `boolean` | Whether API client performing operation supports event attachments. Optional. The default is False. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|---------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.events` |\n| `https://www.googleapis.com/auth/calendar.app.created` |\n| `https://www.googleapis.com/auth/calendar.events.owned` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply the relevant portions of an [Events resource](/workspace/calendar/api/v3/reference/events#resource), according to the rules of patch semantics.\n\nResponse\n--------\n\nIf successful, this method returns an [Events resource](/workspace/calendar/api/v3/reference/events#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]