Method: subscriptions.patch
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP 请求
PATCH https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}
网址采用 gRPC 转码语法。
路径参数
参数 |
subscription.name |
string
标识符。相应订阅的资源名称。 格式:subscriptions/{subscription}
|
查询参数
参数 |
updateMask |
string (FieldMask format)
可选。要更新的字段。如果省略,则更新请求中包含的所有字段。 您可以更新订阅中的以下某个字段:
使用 * 通配符(相当于 PUT )时,省略的字段会被设置为空值,如果无效则会被拒绝。
|
validateOnly |
boolean
可选。如果设置为 true ,则会验证并预览请求,但不会更新订阅。
|
请求正文
请求正文包含一个 Subscription
实例。
响应正文
如果成功,则响应正文包含一个 Operation
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.readonly
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly
https://www.googleapis.com/auth/meetings.space.created
https://www.googleapis.com/auth/meetings.space.readonly
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.readonly
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eThis API updates or renews a Google Workspace subscription using a PATCH request to the specified URL.\u003c/p\u003e\n"],["\u003cp\u003eYou can optionally specify an \u003ccode\u003eupdateMask\u003c/code\u003e to target specific fields for updating and \u003ccode\u003evalidateOnly\u003c/code\u003e to preview the request without applying changes.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ccode\u003eSubscription\u003c/code\u003e object and the successful response will include an \u003ccode\u003eOperation\u003c/code\u003e object with the updated \u003ccode\u003eSubscription\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific OAuth scopes related to Google Chat or Google Meet, as detailed in the documentation.\u003c/p\u003e\n"]]],["This documentation details updating Google Workspace subscriptions via a `PATCH` HTTP request to `https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}`. Key actions involve specifying the subscription name in the path and using `updateMask` in query parameters to selectively modify fields like `expireTime`, `ttl`, or `eventTypes`. The request body contains subscription details, while the successful response includes an `Operation` with the updated subscription. Authentication requires specific OAuth scopes. The process allows for request validation without actual modification.\n"],null,["# Method: subscriptions.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](/workspace/preview), which grants early access to certain features.\n\nUpdates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).\n\n### HTTP request\n\n`PATCH https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------------|------------------------------------------------------------------------------------------------|\n| `subscription.name` | `string` Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}` |\n\n### Query parameters\n\n| Parameters ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: - [`expireTime`](/workspace/events/reference/rest/v1beta/subscriptions#Subscription.FIELDS.expire_time): The timestamp when the subscription expires. - [`ttl`](/workspace/events/reference/rest/v1beta/subscriptions#Subscription.FIELDS.ttl): The time-to-live (TTL) or duration of the subscription. - [`eventTypes`](/workspace/events/reference/rest/v1beta/subscriptions#Subscription.FIELDS.event_types): The list of event types to receive about the target resource. When using the `*` wildcard (equivalent to `PUT`), omitted fields are set to empty values and rejected if they're invalid. |\n| `validateOnly` | `boolean` Optional. If set to `true`, validates and previews the request, but doesn't update the subscription. |\n\n### Request body\n\nThe request body contains an instance of [Subscription](/workspace/events/reference/rest/v1beta/subscriptions#Subscription).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/events/reference/rest/v1beta/operations#Operation).\n\n- The `metadata` field contains an empty array.\n- The `response` field contains an updated instance of [Subscription](/workspace/events/reference/rest/v1beta/subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.spaces`\n- `\n https://www.googleapis.com/auth/chat.spaces.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages`\n- `\n https://www.googleapis.com/auth/chat.messages.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions.readonly`\n- `\n https://www.googleapis.com/auth/chat.memberships`\n- `\n https://www.googleapis.com/auth/chat.memberships.readonly`\n- `\n https://www.googleapis.com/auth/meetings.space.created`\n- `\n https://www.googleapis.com/auth/meetings.space.readonly`\n- `\n https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]