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 Overview