Method: advertisers.reachForecast.retrievePlannableUserLists

Truy xuất danh sách người dùng của bên thứ nhất và bên thứ ba có sẵn để dự báo.

Yêu cầu HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
advertiserId

string (int64 format)

Bắt buộc. Mã nhận dạng của nhà quảng cáo để truy xuất danh sách người dùng có thể lập kế hoạch.

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. Kích thước trang được yêu cầu. Phải nằm trong khoảng từ 1 đến 5000. Nếu bạn không chỉ định, giá trị mặc định sẽ là 5000.
pageToken

string

Không bắt buộc. Mã thông báo xác định một trang kết quả mà máy chủ sẽ trả về. Thông thường, đây là giá trị của nextPageToken được trả về từ lệnh gọi trước đó đến phương thức reachForecast.retrievePlannableUserLists. Nếu không chỉ định, trang kết quả đầu tiên sẽ được trả về.
filter

string

Không bắt buộc. Cho phép lọc theo các thuộc tính của danh sách người dùng có thể lập kế hoạch.

Cú pháp được hỗ trợ:

  • Biểu thức bộ lọc được tạo thành từ một hoặc nhiều quy tắc hạn chế.
  • Bạn có thể kết hợp các điều kiện hạn chế bằng toán tử logic AND hoặc OR.
  • Quy định hạn chế có dạng {field} {operator} {value}.
  • Trường displayName phải sử dụng toán tử HAS (:).
  • Tất cả các trường khác phải sử dụng toán tử EQUALS (=).

Các trường được hỗ trợ:

  • plannableStatus
  • displayName
  • userListType
  • name

Ví dụ:

  • Tất cả danh sách người dùng có thể lập kế hoạch: plannableStatus="PLANNABLE"
  • Danh sách người dùng có thể lập kế hoạch có tên hiển thị chứa "Mua sắm": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Danh sách người dùng của bên thứ nhất: userListType="FIRST_PARTY"

Độ dài của trường này không được quá 500 ký tự.

Tham khảo hướng dẫn về yêu cầu LIST lọc của chúng tôi để biết thêm thông tin.

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

Phản hồi cho reachForecast.retrievePlannableUserLists.

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:

Biểu diễn dưới dạng JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
Trường
plannableUserLists[]

object (PlannableUserList)

Chỉ có đầu ra. Danh sách người dùng có thể lập kế hoạch.
nextPageToken

string

Chỉ có đầu ra. Mã thông báo để truy xuất trang kết quả tiếp theo.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/display-video

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

PlannableUserList

Danh sách người dùng có thể lập kế hoạch được dùng để dự báo phạm vi tiếp cận.

Biểu diễn dưới dạng JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Trường
displayName

string

Chỉ có đầu ra. Tên hiển thị của danh sách người dùng.
userListType

enum (UserListType)

Chỉ có đầu ra. Loại danh sách người dùng.
name

string

Chỉ có đầu ra. Tên tài nguyên xác định danh sách người dùng.

Định dạng advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Chỉ có đầu ra. Trạng thái lập kế hoạch của danh sách người dùng.

UserListType

Các loại danh sách người dùng.

Enum
USER_LIST_TYPE_UNSPECIFIED Loại danh sách người dùng chưa chỉ định.
FIRST_PARTY Danh sách người dùng của bên thứ nhất.
THIRD_PARTY Danh sách người dùng bên thứ ba.

PlannableStatus

Trạng thái cho biết danh sách có thể lập kế hoạch hay không.

Enum
PLANNABLE_STATUS_UNSPECIFIED Trạng thái có thể lập kế hoạch không xác định.
PLANNABLE Bạn có thể lập kế hoạch cho danh sách người dùng.
UNPLANNABLE Không thể lập kế hoạch cho danh sách người dùng.