Method: groups.list

Bir alanın veya bir kullanıcının tüm gruplarını, userKey değeri verilerek alır (sayfalandırılmış).

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. Çok alanlı hesaplarda, bir müşterinin tüm gruplarını getirmek için domain yerine bu alanı kullanın. Hesabınızın customerId değerini temsil etmek için my_customer takma adını da kullanabilirsiniz. customerId, Users 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 alandaki grupları almak için bu alanı kullanın. Bir müşteri hesabının tüm alanlarını 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ı. Her biri alan, operatör ve değer içeren bir veya daha fazla arama ifadesi içerir. Tam doküman için Grupları arama başlıklı makaleyi inceleyin.

sortOrder

enum (SortOrder)

Sonuçların artan düzende mi yoksa azalan düzende mi döndürüleceğini belirtir. Yalnızca orderBy de kullanıldığında işe yarar.

userKey

string

Yalnızca bu gruplar listelenecekse ve belirtilen kullanıcı bu grupların üyesiyse kullanıcının e-posta adresi veya değişmez kimliği. Kimlik ise kullanıcı nesnesinin kimliğiyle eşleşmelidir. customer parametresiyle kullanılamaz.

İ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 kaynağın türü.

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ılavuzu'na bakın.

Şuna göre sırala

Sıralamalar
EMAIL Grubun e-posta adresi.

SortOrder

Sıralamalar
ASCENDING Artan düzende.
DESCENDING Azalan düzende.