Method: partners.list

Liệt kê những đối tác mà người dùng hiện tại có thể truy cập.

Thứ tự được xác định bằng tham số orderBy.

Yêu cầu HTTP

GET https://displayvideo.googleapis.com/v3/partners

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

Tham số truy vấn

Thông số
pageSize

integer

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

string

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 partners.list. Nếu không chỉ định, trang kết quả đầu tiên sẽ được trả về.
orderBy

string

Trường dùng để sắp xếp danh sách. Các giá trị được chấp nhận là:

  • displayName

Thứ tự sắp xếp mặc định là tăng dần. Để chỉ định thứ tự giảm dần cho một trường, bạn nên thêm hậu tố "desc" vào tên trường. Ví dụ: displayName desc.
filter

string

Cho phép lọc theo các trường đối tác.

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. Một chuỗi các quy định hạn chế ngầm sử dụng AND.
  • Quy định hạn chế có dạng {field} {operator} {value}.
  • Tất cả các trường đều phải sử dụng toán tử EQUALS (=).

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

  • entityStatus

Ví dụ:

  • Tất cả đối tác đang hoạt động: entityStatus="ENTITY_STATUS_ACTIVE"

Độ 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

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 
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Trường
partners[]

object (Partner)

Danh sách đối tác.

Danh sách này sẽ không xuất hiện nếu trống.
nextPageToken

string

Mã thông báo để truy xuất trang kết quả tiếp theo. Truyền giá trị này vào trường pageToken trong lệnh gọi tiếp theo đến phương thức partners.list để 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.