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

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

string

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