Method: guaranteedOrders.list

Liệt kê những đơn đặt hàng được đảm bảo 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. Nếu bạn không chỉ định filter theo entityStatus, thì các đơn đặt hàng được đảm bảo có trạng thái thực thể là ENTITY_STATUS_ARCHIVED sẽ không được đưa vào kết quả.

Yêu cầu HTTP

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

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 guaranteedOrders.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 (mặc định)

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 đơn đặt hàng được đảm bảo.

  • 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ợ: * guaranteedOrderId * exchange * displayName * status.entityStatus

Ví dụ:

  • Tất cả đơn đặt hàng được đảm bảo đang hoạt động: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Đơn đặt hàng được đảm bảo thuộc Google Ad Manager hoặc Rubicon Exchange: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

Tham số hợp nhất accessor. Bắt buộc.

Xác định thực thể DV360 mà yêu cầu đang được thực hiện trong đó. Yêu cầu LIST sẽ chỉ trả về các thực thể đơn đặt hàng được đảm bảo mà thực thể DV360 được xác định trong accessor có thể truy cập. accessor chỉ có thể là một trong những trạng thái sau:
partnerId

string (int64 format)

Mã nhận dạng của đối tác có quyền truy cập vào đơn đặt hàng được đảm bảo.
advertiserId

string (int64 format)

Mã nhận dạng của nhà quảng cáo có quyền truy cập vào đơn đặt hàng được đảm bảo.

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

object (GuaranteedOrder)

Danh sách đơn đặt hàng được đảm bảo.

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 guaranteedOrders.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.