Method: groups.list

Pobiera wszystkie grupy domeny lub użytkownika na podstawie klucza użytkownika (stronicowane).

Żą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żyć aliasu my_customer, aby reprezentować customerId na swoim koncie. Wartość customerId jest też zwracana w ramach 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 określający następną stronę na liście.
query

string

Wyszukiwanie ciągu zapytania. Zawiera co najmniej 1 klauzulę wyszukiwania, z której każda ma pole, operator i wartość. Pełną dokumentację znajdziesz w artykule Wyszukiwanie grup.
sortOrder

enum (SortOrder)

Określa, czy wyniki mają zostać zwrócone w kolejności rosnącej czy malejącej. Przydatny tylko wtedy, gdy używany jest też parametr orderBy
userKey

string

Adres e-mail lub niezmienny identyfikator użytkownika, jeśli mają być wyświetlane tylko te grupy, do których należy dany użytkownik. Jeśli jest to identyfikator, powinien być zgodny z identyfikatorem 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

ETag zasobu.
groups[]

object (Group)

Lista obiektów grupy.
nextPageToken

string

Token używany do uzyskiwania dostępu do następnej strony tego wyniku.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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 po autoryzacji.

OrderBy

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

SortOrder

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