Method: subscriptions.patch
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
HTTP isteği
PATCH https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
| Parametreler |
subscription.name |
string
Tanımlayıcı. Aboneliğin kaynak adı. Biçim: subscriptions/{subscription}
|
Sorgu parametreleri
| Parametreler |
updateMask |
string (FieldMask format)
İsteğe bağlıdır. Güncellenecek alan. Atlanırsa istekte yer alan tüm alanlar güncellenir. Abonelikte aşağıdaki alanlardan birini güncelleyebilirsiniz:
expireTimettleventTypes * joker karakteri (PUT ile eşdeğer) kullanıldığında, atlanan alanlar boş değerlere ayarlanır ve geçersizse reddedilir.
|
validateOnly |
boolean
İsteğe bağlıdır. true olarak ayarlanırsa isteği doğrular ve önizlemesini yapar ancak aboneliği güncellemez.
|
İstek içeriği
İstek metni, Subscription öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.
metadata alanı boş bir dizi içeriyor.response alanı, Subscription öğesinin güncellenmiş bir örneğini içeriyor.
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
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
Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 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)."]]
