Method: groups.list

Pobiera wszystkie grupy domeny lub użytkownika z danym userKey (z podziałem na strony).

Żądanie HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
customer

string

Unikalny identyfikator konta Google Workspace klienta. W przypadku konta z wieloma domenami, aby pobrać wszystkie grupy klienta, użyj tego pola zamiast domain. Możesz też używać aliasu my_customer do reprezentowania domeny customerId Twojego konta. Wartość customerId jest też zwracana jako część zasobu Users. Musisz podać parametr customer lub domain.
domain

string

Nazwa domeny. Użyj tego pola, aby pobrać grupy tylko z jednej domeny. Aby zwrócić wszystkie domeny na koncie klienta, użyj parametru zapytania customer.
maxResults

integer

Maksymalna liczba wyników do zwrócenia. Maksymalna dozwolona wartość to 200.
orderBy

enum (OrderBy)

Kolumna używana do sortowania wyników
pageToken

string

Token do określenia następnej strony na liście
query

string

wyszukiwanie za pomocą ciągu zapytania; Powinien mieć postać „”. Pełna dokumentacja jest dostępna na stronie https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Określa, czy wyniki mają być zwracane w kolejności rosnącej czy malejącej. Przydatne tylko wtedy, gdy używany jest też element orderBy.
userKey

string

Adres e-mail lub stały identyfikator użytkownika, jeśli znajduje się na liście tylko te grupy, do których należy dany użytkownik. Jeśli jest to identyfikator, powinien odpowiadać identyfikatorowi obiektu użytkownika. Nie można go używać z parametrem customer.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zapis JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Pola
kind

string

Rodzaj zasobu.
etag

string

Tag ETag zasobu.
groups[]

object (Group)

Lista obiektów grupowych.
nextPageToken

string

Token używany do uzyskiwania dostępu do następnej strony z tymi wynikami.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

OrderBy

Wartości w polu enum
EMAIL Adres e-mail grupy.

SortOrder

Wartości w polu enum
ASCENDING rosnąco,
DESCENDING w kolejności malejącej.