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