Method: groups.list

Bir kullanıcı anahtarı verilen (sayfalara ayrılmış) bir alanın veya kullanıcının tüm gruplarını alır.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
customer

string

Müşterinin Google Workspace hesabının benzersiz kimliği. Birden fazla alan adına sahip bir hesap söz konusu olduğunda, bir müşterinin tüm gruplarını getirmek için domain yerine bu alanı kullanın. Ayrıca, hesabınızın customerId ürününü temsil etmesi için my_customer takma adını da kullanabilirsiniz. customerId, Kullanıcılar kaynağının bir parçası olarak da döndürülür. customer veya domain parametresini sağlamanız gerekir.
domain

string

Alan adı. Yalnızca tek bir alandan grup almak için bu alanı kullanın. Bir müşteri hesabına ait tüm alanları döndürmek için bunun yerine customer sorgu parametresini kullanın.
maxResults

integer

Döndürülecek maksimum sonuç sayısı. İzin verilen maksimum değer 200'dür.
orderBy

enum (OrderBy)

Sonuçları sıralamak için kullanılacak sütun
pageToken

string

Listede sonraki sayfayı belirtmek için kullanılan jeton
query

string

Sorgu dizesi araması. "" biçiminde olmalıdır. Tüm belgeleri şu adreste bulabilirsiniz: https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Sonuçların artan veya azalan düzende döndürülüp döndürülmeyeceğini belirler. Yalnızca orderBy tarafından da kullanıldığında kullanılabilir
userKey

string

Yalnızca bu gruplar listelenecekse kullanıcının e-posta adresi veya sabit kimliği (söz konusu kullanıcı, üyesidir). Kimlikse, kullanıcı nesnesinin kimliğiyle eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Alanlar
kind

string

Bu, nasıl bir kaynak.
etag

string

Kaynağın eTag'i.
groups[]

object (Group)

Grup nesnelerinin listesi.
nextPageToken

string

Bu sonucun sonraki sayfasına erişmek için kullanılan jeton.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.

Sıralama Ölçütü

Sıralamalar
EMAIL Grubun e-posta adresi.

SortOrder

Sıralamalar
ASCENDING Artan sıra.
DESCENDING Azalan düzen.