Method: subscriptions.list

Enumera las suscripciones a Google Workspace. Para obtener información sobre cómo usar este método, consulta Cómo enumerar suscripciones de Google Workspace.

Solicitud HTTP

GET https://workspaceevents.googleapis.com/v1/subscriptions

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

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de suscripciones que se devolverán. El servicio puede devolver menos que este valor.

Si no se especifica o se establece en 0, se devuelven hasta 50 suscripciones.

El valor máximo es 100. Si especificas un valor superior a 100, el sistema solo devolverá 100 suscripciones.
pageToken

string

Opcional. Es un token de página, recibido de una llamada a list subscriptions anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Si pasas un valor diferente, es posible que se generen resultados inesperados.
filter

string

Obligatorio. Es un filtro de búsqueda.

Puedes filtrar las suscripciones por tipo de evento (event_types) y recurso de destino (target_resource).

Debes especificar al menos un tipo de evento en tu búsqueda. Para filtrar por varios tipos de eventos, usa el operador OR.

Para filtrar por tipo de evento y recurso de destino, usa el operador AND y especifica el nombre completo del recurso, como //chat.googleapis.com/spaces/{space}.

Por ejemplo, las siguientes consultas son válidas:

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

El mensaje de respuesta para SubscriptionsService.ListSubscriptions.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Campos
subscriptions[]

object (Subscription)

Es la lista de suscripciones.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • 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.