Method: subscriptions.list

Listet Google Workspace-Abos auf. Weitere Informationen zu dieser Methode finden Sie unter Google Workspace-Abos auflisten.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl von Abos, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben oder auf 0 festgelegt, werden bis zu 50 Abos zurückgegeben.

Der Höchstwert ist 100. Wenn Sie einen höheren Wert als 100 angeben, gibt das System nur 100 Abonnements zurück.
pageToken

string

Optional. Seitentoken, das von einem vorherigen Aufruf einer Aboliste empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren sollte der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter

string

Erforderlich. Einen Abfragefilter.

Sie können Abos nach Ereignistyp (event_types) und Zielressource (target_resource) filtern.

Sie müssen in Ihrer Abfrage mindestens einen Ereignistyp angeben. Mit dem Operator OR können Sie nach mehreren Ereignistypen filtern.

Wenn Sie sowohl nach Ereignistyp als auch nach Zielressource filtern möchten, verwenden Sie den Operator AND und geben Sie den vollständigen Ressourcennamen an, z. B. //chat.googleapis.com/spaces/{space}.

Die folgenden Abfragen sind beispielsweise gültig:

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}"

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwortnachricht für SubscriptionsService.ListSubscriptions.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Felder
subscriptions[]

object (Subscription)

Liste der Abos.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.