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/v1/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ć mniejszą wartość od tej wartości.

Jeśli wartość nie jest określona lub jest ustawiona na 0, zwróconych zostanie 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 z poprzedniego wywołania subskrypcji listy. Podaj ten parametr, aby pobrać kolejną stronę.

W przypadku podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Przekazywanie innej wartości może spowodować nieoczekiwane wyniki.
filter

string

To pole jest wymagane. Filtr zapytania.

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

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

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

Prawidłowe są np. te zapytania:

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

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na pytanie: 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.