Method: users.list

แสดงรายการผู้ใช้ที่ผู้ใช้ปัจจุบันเข้าถึงได้ หากผู้ใช้ 2 คนมีบทบาทของผู้ใช้บนพาร์ทเนอร์หรือผู้ลงโฆษณาเดียวกัน ผู้ใช้ดังกล่าวจะเข้าถึงกันและกันได้

วิธีการนี้มีข้อกำหนดการตรวจสอบสิทธิ์ที่ไม่ซ้ำกัน โปรดอ่านข้อกำหนดเบื้องต้นในคู่มือผู้ใช้ก่อนที่จะใช้วิธีนี้

แท็ก "ลองใช้วิธีนี้" ไม่ทำงานสำหรับวิธีการนี้

คำขอ HTTP

GET https://displayvideo.googleapis.com/v3/users

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

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

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

integer

ขนาดหน้าที่ขอ ต้องอยู่ระหว่าง 1 และ 200 หากไม่ระบุจะมีค่าเริ่มต้นเป็น 100
pageToken

string

โทเค็นที่ระบุหน้าผลลัพธ์ที่เซิร์ฟเวอร์ควรแสดงผล โดยทั่วไปแล้วจะเป็นค่าของ nextPageToken ที่ส่งคืนจากการเรียกเมธอด users.list ก่อนหน้านี้ หากไม่ได้ระบุ ระบบจะแสดงผลหน้าแรกของผลการค้นหา
orderBy

string

ช่องที่ใช้จัดเรียงรายการ ค่าที่ยอมรับได้ มีดังนี้

  • displayName (ค่าเริ่มต้น)

ลำดับการจัดเรียงเริ่มต้นคือจากน้อยไปมาก ในการระบุลำดับจากมากไปน้อยสำหรับช่อง ให้ใส่คำต่อท้าย "desc" ควรเพิ่มลงในชื่อช่อง เช่น displayName desc
filter

string

อนุญาตให้กรองตามฟิลด์ผู้ใช้

ไวยากรณ์ที่รองรับ:

  • นิพจน์ตัวกรองประกอบด้วยข้อจำกัดอย่างน้อย 1 ข้อ
  • โอเปอเรเตอร์ทางตรรกะ AND รวมข้อจำกัดได้
  • โดยข้อจำกัดจะอยู่ในรูปแบบ {field} {operator} {value}
  • ฟิลด์ displayName และ email ต้องใช้โอเปอเรเตอร์ HAS (:)
  • ฟิลด์ lastLoginTime ต้องใช้โอเปอเรเตอร์ LESS THAN OR EQUAL TO (<=) หรือ GREATER THAN OR EQUAL TO (>=)
  • ช่องอื่นๆ ทั้งหมดต้องใช้โอเปอเรเตอร์ EQUALS (=)

ฟิลด์ที่รองรับ:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: นี่คือช่องสังเคราะห์ของ AssignedUserRole ที่ใช้สำหรับการกรอง ระบุประเภทเอนทิตีที่ได้รับมอบหมายบทบาทของผู้ใช้ ค่าที่ถูกต้องคือ Partner และ Advertiser
  • assignedUserRole.parentPartnerId: นี่คือช่องสังเคราะห์ของ AssignedUserRole ที่ใช้สำหรับการกรอง ระบุพาร์ทเนอร์หลักของเอนทิตีที่ได้รับมอบหมายบทบาทของผู้ใช้
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ป้อนในรูปแบบ ISO 8601 หรือ YYYY-MM-DDTHH:MM:SSZ)

ตัวอย่าง

  • ผู้ใช้ที่มี displayName ที่มี "foo": displayName:"foo"
  • ผู้ใช้ที่มี email ประกอบด้วย "bar": email:"bar"
  • ผู้ใช้ทุกคนที่มีบทบาทผู้ใช้มาตรฐาน: assignedUserRole.userRole="STANDARD"
  • ผู้ใช้ทั้งหมดที่มีบทบาทของผู้ใช้สำหรับพาร์ทเนอร์ 123: assignedUserRole.partnerId="123"
  • ผู้ใช้ทั้งหมดที่มีบทบาทของผู้ใช้สำหรับผู้ลงโฆษณา 123: assignedUserRole.advertiserId="123"
  • ผู้ใช้ทั้งหมดที่มีบทบาทของผู้ใช้ระดับพาร์ทเนอร์: entityType="PARTNER"
  • ผู้ใช้ทั้งหมดที่มีบทบาทของผู้ใช้สำหรับพาร์ทเนอร์ 123 และผู้ลงโฆษณาที่ต่ำกว่าพาร์ทเนอร์ 123: parentPartnerId="123"
  • ผู้ใช้ทั้งหมดที่เข้าสู่ระบบครั้งล่าสุดในวันที่ 2023-01-01T00:00:00Z (รูปแบบ ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ

โปรดดูข้อมูลเพิ่มเติมในคำแนะนำเกี่ยวกับคำขอตัวกรองLIST

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

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

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

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

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

object (User)

รายชื่อผู้ใช้

รายการนี้จะหายไปหากว่างเปล่า
nextPageToken

string

โทเค็นเพื่อเรียกผลลัพธ์หน้าถัดไป ส่งต่อค่านี้ในฟิลด์ pageToken ในการเรียกครั้งต่อๆ ไปไปยังเมธอด users.list เพื่อดึงผลลัพธ์หน้าถัดไป โทเค็นนี้จะหายไปหากไม่มีผลลัพธ์ให้แสดงเพิ่มเติม

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

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

  • https://www.googleapis.com/auth/display-video-user-management

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0