Hiển thị và Video 360 API phiên bản 2 sẽ ngừng hoạt động từ ngày 3 tháng 9 năm 2024. Hãy chuyển sang phiên bản 3 trước thời điểm đó để tránh bị gián đoạn dịch vụ.
Liệt kê đơ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ì các đơ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
Bắt buộc. Mã của nhà quảng cáo liệt kê đơn đặt hàng quảng cáo.
Tham số truy vấn
Các tham số
pageSize
integer
Kích thước trang được yêu cầu. Phải nằm trong khoảng từ 1 đến 100. Nếu bạn chưa chỉ định, giá trị mặc định sẽ là 100. Trả về mã lỗi INVALID_ARGUMENT nếu bạn chỉ định một giá trị không hợp lệ.
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 insertionOrders.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 cần 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, bạn phải thêm hậu tố "description" 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 lọc được tạo thành từ một hoặc nhiều hạn chế.
Các giới hạn có thể được kết hợp bằng toán tử logic AND hoặc OR. Một chuỗi hạn chế sử dụng AND một cách ngầm ẩn.
Quy định 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ả đơn đặt hàng quảng cáo ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSED 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 nhỏ 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"
Độ dài của trường này không được vượt quá 500 ký tự.
Hãy tham khảo hướng dẫn về yêu cầu lọc LIST 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:
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.