Method: customers.userLists.list

แสดงรายชื่อผู้ใช้ที่จัดการโดยลูกค้า Ads Data Hub ที่ระบุ

คำขอ HTTP

GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists

URL ใช้ไวยากรณ์ gRPC Transcoding

พารามิเตอร์เส้นทาง

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

string

ต้องระบุ ชื่อทรัพยากรลูกค้าระดับบนสุด เช่น 'customers/123'

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

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

integer

จํานวนสูงสุดของสินค้าที่ส่งคืน หากเป็น 0 เซิร์ฟเวอร์จะกําหนดจํานวนรายชื่อผู้ใช้ที่จะส่งคืน
pageToken

string

โทเค็นหน้าเว็บที่แสดงจากการเรียกก่อนหน้า ใช้ในการขอผลการค้นหาถัดไป
filter

string

ตัวกรองตัวอย่าง: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND filledTime > "2012-04-31T1010
view

enum (UserListView)

ระบุช่องที่จะรวมในรายชื่อผู้ใช้แต่ละรายการ
showDeleted

boolean

หากตั้งค่าเป็น "จริง" รายการผู้ใช้ที่ถูกลบจะรวมอยู่ในคําตอบ

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

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

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

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

ตอบกลับคําขอ userLists.list ประกอบด้วยรายชื่อผู้ใช้ที่จัดการโดยลูกค้า Ads Data Hub ที่ระบุ

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

object (UserList)

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

string

โทเค็นที่ใช้ขอหน้าผลการค้นหาถัดไปได้ ช่องนี้ว่างเปล่าหากไม่มีผลลัพธ์เพิ่มเติม

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

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

  • https://www.googleapis.com/auth/adsdatahub

มุมมองรายการผู้ใช้

แจกแจงเพื่อระบุว่าจะรวมช่องใดในรายชื่อผู้ใช้แต่ละรายการที่แสดงโดย [userLists.list] API

Enum
USER_LIST_VIEW_UNSPECIFIED ค่าเริ่มต้น / ไม่ได้ตั้งค่า API จะใช้มุมมองแบบเต็มเป็นค่าเริ่มต้น
BASIC ใส่ช่องยกเว้น [recipientAdsDataLinks]
FULL รวมทุกอย่าง