Method: groups.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera wszystkie grupy domeny lub użytkownika na podstawie klucza użytkownika (po stronie).
Żą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 obejmującego wiele domen, aby pobrać wszystkie grupy klienta, użyj tego pola zamiast pola domain. Możesz też użyć aliasu my_customer, aby reprezentować customerId na swoim koncie. Wartość customerId jest też zwracana jako część zasobu Users. Musisz podać parametr customer lub domain.
|
domain |
string
nazwę 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 za pomocą ciągu zapytania; mieć format „”. Pełną dokumentację znajdziesz na stronie https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups.
|
sortOrder |
enum (SortOrder)
Określa, czy wyniki mają zostać zwrócone w kolejności rosnącej czy malejącej. Przydatne tylko wtedy, gdy używany jest też element orderBy.
|
userKey |
string
adres e-mail lub niezmienny identyfikator użytkownika, jeśli mają być wyświetlone tylko te grupy, do których należy dany użytkownik. Jeśli jest to identyfikator, powinien on 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 z tymi wynikami.
|
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 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. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-25 UTC."],[],[],null,["# Method: groups.list\n\nRetrieves all groups of a domain or of a user given a userKey (paginated).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n| `domain` | `string` The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/groups/list#OrderBy)`)` Column to use for sorting results |\n| `pageToken` | `string` Token to specify next page in the list |\n| `query` | `string` Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/groups/list#SortOrder)`)` Whether to return results in ascending or descending order. Only of use when orderBy is also used |\n| `userKey` | `string` Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. Cannot be used with the `customer` parameter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"groups\": [ { object (/workspace/admin/directory/reference/rest/v1/groups#Group) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `groups[]` | `object (`[Group](/workspace/admin/directory/reference/rest/v1/groups#Group)`)` A list of group objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nOrderBy\n-------\n\n| Enums ||\n|---------|---------------------|\n| `EMAIL` | Email of the group. |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]
