CalendarList: patch
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
ユーザーのカレンダー リストにある既存のカレンダーを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get
の後に update
を使用することをおすすめします。指定したフィールド値が既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドが指定されている場合、既存の配列が上書きされます。これにより、以前の配列要素は破棄されます。今すぐお試しください。
リクエスト
HTTP リクエスト
PATCH https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId
パラメータ
パラメータ名 |
値 |
説明 |
パスパラメータ |
calendarId |
string |
カレンダー ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary 」キーワードを使用します。
|
省略可能なクエリ パラメータ |
colorRgbFormat |
boolean |
foregroundColor フィールドと backgroundColor フィールドを使用してカレンダーの色(RGB)を書き込むかどうか。この機能を使用すると、インデックスベースの colorId フィールドが最適な一致オプションに自動的に設定されます。省略可。デフォルトは False です。
|
承認
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
範囲 |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendarlist |
詳しくは、認証と認可のページをご覧ください。
リクエストの本文
パッチのセマンティクスの規則に従って、リクエストの本体に CalendarList リソースの該当部分を指定します。
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# CalendarList: patch\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an existing calendar on the user's calendar list. 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/users/me/calendarList/calendarId\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| **Optional query parameters** |||\n| `colorRgbFormat` | `boolean` | Whether to use the `foregroundColor` and `backgroundColor` fields to write the calendar colors (RGB). If this feature is used, the index-based `colorId` field will be set to the best matching option automatically. 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.app.created` |\n| `https://www.googleapis.com/auth/calendar.calendarlist` |\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 a [CalendarList resource](/workspace/calendar/api/v3/reference/calendarList#resource), according to the rules of patch semantics.\n\nResponse\n--------\n\nIf successful, this method returns a [CalendarList resource](/workspace/calendar/api/v3/reference/calendarList#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."]]