Method: groups.list

ดึงข้อมูลกลุ่มทั้งหมดของโดเมนหรือของผู้ใช้ที่ระบุ userKey (แบ่งหน้า)

คำขอ HTTP

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

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

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

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

string

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

string

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

integer

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

enum (OrderBy)

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

string

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

string

การค้นหาสตริงการค้นหา มีกลไกการค้นหาอย่างน้อย 1 รายการ ซึ่งแต่ละรายการมีฟิลด์ โอเปอเรเตอร์ และค่า ดูเอกสารประกอบทั้งหมดได้ที่ค้นหากลุ่ม
sortOrder

enum (SortOrder)

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

string

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

เนื้อความของคำขอ

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

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

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

การแสดง 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 เรียงลำดับจากมากไปน้อย