Method: subscriptions.patch
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Permintaan HTTP
PATCH https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
subscription.name |
string
ID. Nama resource langganan. Format: subscriptions/{subscription}
|
Parameter kueri
| Parameter |
updateMask |
string (FieldMask format)
Opsional. Kolom yang akan diperbarui. Jika tidak disertakan, akan memperbarui kolom apa pun yang disertakan dalam permintaan. Anda dapat memperbarui salah satu kolom berikut dalam langganan:
expireTimettleventTypes Saat menggunakan karakter pengganti * (setara dengan PUT), kolom yang tidak disertakan akan ditetapkan ke nilai kosong dan ditolak jika tidak valid.
|
validateOnly |
boolean
Opsional. Jika disetel ke true, permintaan akan divalidasi dan dipratinjau, tetapi langganan tidak akan diperbarui.
|
Isi permintaan
Isi permintaan memuat instance Subscription.
Isi respons
Jika berhasil, isi respons memuat instance Operation.
- Kolom
metadata berisi array kosong. - Kolom
response berisi instance Subscription yang diperbarui.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
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
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[[["\u003cp\u003eThis method updates or renews a Google Workspace subscription using a PATCH request to the specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can update subscription fields like expireTime, ttl, and eventTypes using the updateMask query parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequest bodies should contain a Subscription object, while successful responses include an Operation object with the updated Subscription.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires one of the listed OAuth scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/chat.spaces\u003c/code\u003e or similar, granting specific permissions.\u003c/p\u003e\n"]]],["This describes how to update or renew a Google Workspace subscription via a `PATCH` HTTP request to the specified URL `https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}`. The request utilizes path parameters for the subscription name and optional query parameters, `updateMask` and `validateOnly`, to control updates and validation. The request body contains subscription details, while the successful response body contains an operation and updated subscription instance. Updating the subscription also require one of the specific OAuth scopes.\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\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/v1/{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/v1/subscriptions#Subscription.FIELDS.expire_time): The timestamp when the subscription expires. - [`ttl`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.ttl): The time-to-live (TTL) or duration of the subscription. - [`eventTypes`](/workspace/events/reference/rest/v1/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/v1/subscriptions#Subscription).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/events/reference/rest/v1/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\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
