Method: users.list

ดึงข้อมูลรายการผู้ใช้ที่ลบแล้วหรือผู้ใช้ทั้งหมดในโดเมนแบบแบ่งหน้า

คำขอ HTTP

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

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

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

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

string

รายการชื่อสคีมาที่คั่นด้วยคอมมา ระบบจะดึงข้อมูลฟิลด์ทั้งหมดจากสคีมาเหล่านี้ ควรตั้งค่าเฉพาะเมื่อ projection=custom
customer

string

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

string

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

enum (Event)

เหตุการณ์ที่ตั้งใจจะติดตาม (หากมีการติดตาม)
maxResults

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง
orderBy

enum (OrderBy)

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

string

โทเค็นสำหรับระบุหน้าถัดไปในรายการ โทเค็นหน้าจะใช้งานได้เพียง 3 วันเท่านั้น
projection

enum (Projection)

ฟิลด์ชุดย่อยที่จะดึงข้อมูลสําหรับผู้ใช้รายนี้
query

string

สตริงคําค้นหาสําหรับการค้นหาช่องผู้ใช้ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างคําค้นหาของผู้ใช้ที่หัวข้อค้นหาผู้ใช้
showDeleted

string

หากตั้งค่าเป็น true ระบบจะดึงข้อมูลรายชื่อผู้ใช้ที่ถูกลบ (ค่าเริ่มต้น: false)
sortOrder

enum (SortOrder)

แสดงผลลัพธ์ตามลําดับจากน้อยไปมากหรือมากไปน้อย โดยละเว้นรูปแบบตัวอักษร
viewType

enum (ViewType)

เลือกว่าจะดึงข้อมูลมุมมองสาธารณะของผู้ดูแลระบบเท่านั้นหรือมุมมองสาธารณะทั่วทั้งโดเมน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดึงข้อมูลผู้ใช้ในฐานะผู้ใช้ที่ไม่ใช่ผู้ดูแลระบบ

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

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

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

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

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

string

ประเภทของทรัพยากร
trigger_event

string

เหตุการณ์ที่ทริกเกอร์การตอบกลับนี้ (ใช้เฉพาะในกรณีที่มีการตอบกลับแบบ Push)
etag

string

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

object (User)

รายการออบเจ็กต์ผู้ใช้
nextPageToken

string

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

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

กิจกรรม

ประเภทเหตุการณ์การสมัครใช้บริการ

Enum
ADD เหตุการณ์ที่ผู้ใช้สร้างขึ้น
DELETE กิจกรรมที่ผู้ใช้ลบ
MAKE_ADMIN เหตุการณ์การเปลี่ยนแปลงสถานะผู้ดูแลระบบของผู้ใช้
UNDELETE เหตุการณ์ที่ยกเลิกการลบผู้ใช้
UPDATE เหตุการณ์ที่อัปเดตโดยผู้ใช้

OrderBy

Enum
EMAIL อีเมลหลักของผู้ใช้
FAMILY_NAME นามสกุลของผู้ใช้
GIVEN_NAME ชื่อจริงของผู้ใช้

การฉายภาพ

Enum
BASIC อย่าใส่ช่องที่กำหนดเองสำหรับผู้ใช้
CUSTOM รวมช่องที่กำหนดเองจากสคีมาที่ขอใน customFieldMask
FULL ใส่ช่องทั้งหมดที่เชื่อมโยงกับผู้ใช้รายนี้

SortOrder

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

ViewType

Enum
admin_view ผลลัพธ์จะมีทั้งช่องสำหรับผู้ดูแลระบบเท่านั้นและช่องโดเมนสาธารณะสำหรับผู้ใช้
domain_public ผลลัพธ์จะมีเฉพาะช่องสำหรับผู้ใช้ที่ผู้ใช้รายอื่นในโดเมนมองเห็นแบบสาธารณะ