Method: partners.list

Liệt kê các đố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 không chỉ định, giá trị mặc định sẽ là 100.
pageToken

string

Mã thông báo xác định 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 được chỉ định, hệ thống sẽ trả về trang kết quả đầu tiên.
orderBy

string

Trườ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 phải thêm hậu tố " giảm dần" vào tên trường. Ví dụ: displayName desc.
filter

string

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

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

  • Biểu thức lọc bao gồm một hoặc nhiều quy tắc hạn chế.
  • Bạn có thể kết hợp các quy tắc hạn chế bằng toán tử logic AND hoặc OR. Một chuỗi các quy tắc hạn chế sử dụng ngầm AND.
  • Quy tắc 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"

Trường này không được dài quá 500 ký tự.

Hãy tham khảo hướng dẫn lọc các yêu cầu LIST để 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 trong 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 bài viết Tổng quan về OAuth 2.0.