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 ยังส่งกลับเป็นส่วนหนึ่งของทรัพยากร ผู้ใช้ ด้วย คุณต้องระบุพารามิเตอร์ customer หรือ domain
domain

string

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

enum (Event)

เหตุการณ์ตามวัตถุประสงค์ของการสมัครใช้บริการ (หากสมัครใช้บริการ)
maxResults

integer

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

enum (OrderBy)

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

string

โทเค็นสำหรับระบุหน้าถัดไปในรายการ
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

เหตุการณ์ที่ทริกเกอร์การตอบกลับนี้ (ใช้ในกรณีที่มีข้อความตอบกลับเท่านั้น)
etag

string

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

object (User)

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

string

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

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

ต้องใช้ขอบเขต 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 ผลลัพธ์จะมีเฉพาะฟิลด์ของผู้ใช้ ซึ่งเป็นที่ปรากฏแบบสาธารณะต่อผู้ใช้รายอื่นในโดเมน