- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- Chế độ xem danh sách người dùng
Liệt kê các danh sách người dùng do khách hàng Ads Data Hub được chỉ định quản lý.
Yêu cầu HTTP
GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Các tham số | |
---|---|
parent |
Bắt buộc. Tên tài nguyên dành cho khách hàng gốc, ví dụ: &g/39;customer/123#39; |
Tham số truy vấn
Các tham số | |
---|---|
pageSize |
Số mục tối đa được trả về. Nếu là 0, máy chủ sẽ xác định số lượng danh sách người dùng cần trả về. |
pageToken |
Mã thông báo trang (do một lệnh gọi trước đó trả về) dùng để yêu cầu trang kết quả tiếp theo. |
filter |
Bộ lọc ví dụ: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND residentialTime > "2012-04-21T11-00:30:30:30:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00 tối 1 vô cùng: |
view |
Chỉ định những trường mà bạn muốn đưa vào mỗi danh sách người dùng. |
showDeleted |
Nếu bạn đặt chính sách này thành true, thì các danh sách người dùng đã xóa sẽ được thêm vào phản hồi. |
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Phản hồi cho yêu cầu userLists.list. Chứa danh sách người dùng do khách hàng Ads Data Hub được chỉ định quản lý.
Biểu diễn dưới dạng JSON |
---|
{
"userLists": [
{
object ( |
Các trường | |
---|---|
userLists[] |
Danh sách danh sách người dùng. |
nextPageToken |
Mã thông báo có thể dùng để yêu cầu trang kết quả tiếp theo. Trường này sẽ trống nếu không có thêm kết quả nào. |
Phạm vi cấp phép
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/adsdatahub
Chế độ xem danh sách người dùng
Enum để cho biết các trường cần đưa vào mỗi danh sách người dùng do API [userLists.list] trả về.
Enum | |
---|---|
USER_LIST_VIEW_UNSPECIFIED |
Giá trị mặc định / chưa đặt. API sẽ mặc định sử dụng chế độ xem HOÀN CHỈNH. |
BASIC |
Bao gồm các trường, ngoại trừ [ReceiveAdsDataLinks]. |
FULL |
Bao gồm mọi thứ. |