Method: subscriptions.list

Wyświetla listę subskrypcji Google Workspace. Aby dowiedzieć się, jak korzystać z tej metody, przeczytaj artykuł Wyświetlanie listy subskrypcji Google Workspace.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba subskrypcji do zwrócenia. Usługa może zwrócić mniej subskrypcji niż ta wartość.

Jeśli nie określisz tej wartości lub ustawisz ją na 0, zostanie zwróconych maksymalnie 50 subskrypcji.

Maksymalna wartość to 100. Jeśli podasz wartość większą niż 100, system zwróci tylko 100 subskrypcji.
pageToken

string

Opcjonalnie. Token strony otrzymany w poprzednim wywołaniu listy subskrypcji. Podaj ten parametr, aby pobrać następną stronę.

Podczas paginacji wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazanie innej wartości może spowodować nieoczekiwane wyniki.
filter

string

Wymagane. Filtr zapytania.

Możesz filtrować subskrypcje według typu zdarzenia (event_types) i zasobu docelowego (target_resource).

W zapytaniu musisz określić co najmniej 1 typ zdarzenia. Aby filtrować według wielu typów zdarzeń, użyj operatora OR.

Aby filtrować według typu zdarzenia i zasobu docelowego, użyj operatora AND i podaj pełną nazwę zasobu, np. //chat.googleapis.com/spaces/{space}.

Poniżej znajdziesz przykłady prawidłowych zapytań:

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

To zapytanie jest dostępne w 

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//admin.googleapis.com/customers/my_customer"

Serwer odrzuca nieprawidłowe zapytania z błędem INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat odpowiedzi dla SubscriptionsService.ListSubscriptions.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Pola
subscriptions[]

object (Subscription)

Lista subskrypcji.
nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.