Method: groups.list

เรียกกลุ่มทั้งหมดของโดเมนหรือผู้ใช้ที่ได้รับรหัสผู้ใช้ (มีเลขหน้า)

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
customer

string

รหัสที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace ของลูกค้า ในกรณีที่เป็นบัญชีหลายโดเมน ให้ใช้ช่องนี้แทน domain หากต้องการดึงข้อมูลกลุ่มทั้งหมดของลูกค้า คุณยังใช้ชื่อแทน my_customer เพื่อแสดงถึง customerId ของบัญชีได้ด้วย นอกจากนี้ customerId ยังแสดงผลเป็นส่วนหนึ่งของทรัพยากร Users ด้วย คุณต้องระบุพารามิเตอร์ customer หรือ domain
domain

string

ชื่อโดเมน ใช้ช่องนี้เพื่อเรียกกลุ่มจากโดเมนเดียวเท่านั้น หากต้องการส่งคืนโดเมนทั้งหมดสําหรับบัญชีลูกค้า ให้ใช้พารามิเตอร์การค้นหา customer แทน
maxResults

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง ค่าสูงสุดที่อนุญาตคือ 200
orderBy

enum (OrderBy)

คอลัมน์ที่ใช้สำหรับจัดเรียงผลลัพธ์
pageToken

string

โทเค็นที่จะระบุหน้าถัดไปในรายการ
query

string

การค้นหาสตริงคำค้นหา ควรอยู่ในรูปแบบ "" เอกสารฉบับสมบูรณ์อยู่ที่ https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

จะแสดงผลลัพธ์ตามลำดับจากน้อยไปมากหรือมากไปน้อย ใช้เมื่อมีการใช้ orderBy ด้วยเท่านั้น
userKey

string

อีเมลหรือรหัสที่เปลี่ยนแปลงไม่ได้ของผู้ใช้หากกลุ่มดังกล่าวแสดงเฉพาะในรายการ และผู้ใช้ที่กำหนดเป็นสมาชิก หากเป็นรหัส ค่านั้นควรตรงกับรหัสของออบเจ็กต์ผู้ใช้

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
ช่อง
kind

string

นี่แหละแหล่งข้อมูล
etag

string

ETag ของทรัพยากร
groups[]

object (Group)

รายการออบเจ็กต์กลุ่ม
nextPageToken

string

โทเค็นที่ใช้เข้าถึงหน้าถัดไปของผลการค้นหานี้

ขอบเขตการให้สิทธิ์

ต้องมีขอบเขต 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

โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์

OrderBy

Enum
EMAIL อีเมลของกลุ่ม

SortOrder

Enum
ASCENDING เรียงจากน้อยไปมาก
DESCENDING เรียงลำดับจากมากไปน้อย