Method: users.watch

คอยดูการเปลี่ยนแปลงในรายชื่อผู้ใช้

คำขอ HTTP

POST https://admin.googleapis.com/admin/directory/v1/users/watch

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

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

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

string

ชื่อโดเมน กรอกข้อมูลในช่องนี้เพื่อรับผู้ใช้จากโดเมนนี้เท่านั้น หากต้องการแสดงผู้ใช้ทั้งหมดในโดเมนหลายรายการ ให้กรอกช่องลูกค้าแทน"
customer

string

รหัสแบบคงที่ของบัญชี Google Workspace ในกรณีที่มีหลายโดเมน หากต้องการดึงข้อมูลผู้ใช้ทั้งหมดสำหรับลูกค้า ให้กรอกข้อมูลในช่องนี้แทนโดเมน
event

enum (EventType)

เหตุการณ์ที่ควรระวัง
customFieldMask

string

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

integer

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

enum (OrderBy)

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

string

โทเค็นสำหรับระบุหน้าถัดไปในรายการ
projection

enum (Projection)

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

string

การค้นหาสตริงการค้นหา ควรอยู่ในรูปแบบ "" เอกสารประกอบฉบับเต็มมีอยู่ที่ https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
showDeleted

string

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

enum (SortOrder)

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

enum (ViewType)

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

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

เนื้อความของคำขอมีอินสแตนซ์ของ SubscriptionChannel

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ SubscriptionChannel

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

ต้องใช้ขอบเขต 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

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

EventType

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

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 ผลลัพธ์จะมีเฉพาะช่องสำหรับผู้ใช้ที่ผู้ใช้รายอื่นในโดเมนมองเห็นแบบสาธารณะ