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