Method: subscriptions.patch

Actualiza o renueva una suscripción a Google Workspace. Para aprender a usar este método, consulta Cómo actualizar o renovar una suscripción a Google Workspace.

Solicitud HTTP

PATCH https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
subscription.name

string

Identificador. Es el nombre del recurso de la suscripción.

Formato: subscriptions/{subscription}

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Opcional. Es el campo que se actualizará. Si se omite, se actualizan los campos incluidos en la solicitud.

Puedes actualizar uno de los siguientes campos en una suscripción:

  • expireTime: Es la marca de tiempo en la que vence la suscripción.
  • ttl: El tiempo de actividad (TTL) o la duración de la suscripción.
  • eventTypes: Es la lista de tipos de eventos que se recibirán sobre el recurso objetivo.

Para reemplazar por completo la suscripción (el equivalente de PUT), usa *. Los campos omitidos se actualizan con valores vacíos.

validateOnly

boolean

Opcional. Si se configura como true, valida y obtiene una vista previa de la solicitud, pero no actualiza la suscripción.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Subscription.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

  • El campo metadata contiene un array vacío.
  • El campo response contiene una instancia actualizada de Subscription.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta la Guía de autorización.