Method: advertisers.insertionOrders.list

Liệt kê các đơn đặt hàng quảng cáo trong một nhà quảng cáo.

Thứ tự này được xác định bằng tham số orderBy. Nếu bạn không chỉ định filter của entityStatus, thì đơn đặt hàng quảng cáo có ENTITY_STATUS_ARCHIVED sẽ không được đưa vào kết quả.

Yêu cầu HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders

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 cần liệt kê đơn đặt hàng quảng cáo.

Tham số truy vấn

Tham số
pageSize

integer

Kích thước trang được yêu cầu. Phải trong khoảng từ 1 đến 100. Nếu bạn không chỉ định, thì chế độ mặc định sẽ là 100. Trả về mã lỗi INVALID_ARGUMENT nếu chỉ định một giá trị không hợp lệ.
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 insertionOrders.list. Nếu không được chỉ định, trang kết quả đầu tiên sẽ được trả về.
orderBy

string

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

  • "displayName" (mặc định)
  • "entityStatus"
  • "updateTime"

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

string

Cho phép lọc theo trường đơn đặt hàng quảng cáo.

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 giới hạn.
  • Bạn có thể kết hợp các quy định hạn chế bằng toán tử logic AND hoặc OR. Một chuỗi các hạn chế ngầm sử dụng AND.
  • Hạn chế có dạng {field} {operator} {value}.
  • Trường updateTime phải sử dụng toán tử GREATER THAN OR EQUAL TO (>=) hoặc LESS THAN OR EQUAL TO (<=).
  • 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ợ:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (dữ liệu đầu vào ở định dạng ISO 8601 hoặc YYYY-MM-DDTHH:MM:SSZ)

Ví dụ:

  • Tất cả đơn đặt hàng quảng cáo trong một chiến dịch: campaignId="1234"
  • Tất cả ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSED đơn đặt hàng quảng cáo của một nhà quảng cáo: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Tất cả đơn đặt hàng quảng cáo có thời gian cập nhật ngắn hơn hoặc bằng 2020-11-04T18:54:47Z (định dạng ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tất cả đơn đặt hàng quảng cáo có thời gian cập nhật lớn hơn hoặc bằng 2020-11-04T18:54:47Z (định dạng ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Hãy tham khảo hướng dẫn về bộ lọc LIST yêu cầu 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 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Trường
insertionOrders[]

object (InsertionOrder)

Danh sách đơn đặt hàng quảng cáo.

Danh sách này sẽ không có 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 insertionOrders.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.