Method: users.list

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

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

ฟีเจอร์ "ลองวิธีนี้" ใช้ไม่ได้กับวิธีนี้

คำขอ HTTP

GET https://displayvideo.googleapis.com/v1/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}
  • ฟิลด์ budget.budget_segments.date_range.end_date ต้องใช้โอเปอเรเตอร์ LESS THAN (<)
  • โอเปอเรเตอร์ displayName andemailfield must use theHAS (:)`
  • ช่องอื่นๆ ทั้งหมดต้องใช้โอเปอเรเตอร์ EQUALS (=)

ช่องที่รองรับ

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

ตัวอย่าง

  • ผู้ใช้ที่มี 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"

ช่องนี้ควรมีความยาวไม่เกิน 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