Method: advertisers.lineItems.list

Liệt kê các mục hàng 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ì mục hàng có ENTITY_STATUS_ARCHIVED sẽ không được đưa vào kết quả.

Yêu cầu HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

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

Tham số đường dẫn

Các tham số
advertiserId

string (int64 format)

Bắt buộc. Mã của nhà quảng cáo cần liệt kê mục hàng.

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 lineItems.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
  • flight.dateRange.endDate
  • 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 thuộc tính mục hàng.

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}.
  • Toán tử được sử dụng trên flight.dateRange.endDate phải là LESS THAN (<).
  • Toán tử được sử dụng trên updateTime phải là GREATER THAN OR EQUAL TO (>=) hoặc LESS THAN OR EQUAL TO (<=).
  • Toán tử được sử dụng trên warningMessages phải là HAS (:).
  • Toán tử dùng trong tất cả các trường khác phải là EQUALS (=).
  • Các thuộc tính được hỗ trợ:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (dữ liệu đầu vào có định dạng YYYY-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (dữ liệu đầu vào theo định dạng ISO 8601 hoặc YYYY-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

Ví dụ:

  • Tất cả các mục hàng trong một đơn đặt hàng quảng cáo: insertionOrderId="1234"
  • Tất cả các mục hàng ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSED và LINE_ITEM_TYPE_DISPLAY_DEFAULT thuộc một nhà quảng cáo: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Tất cả mục hàng có ngày hiển thị kết thúc trước ngày 28 tháng 3 năm 2019: flight.dateRange.endDate<"2019-03-28"
  • Tất cả các mục hàng có NO_VALID_CREATIVE trong warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • Tất cả các mục hàng có thời gian cập nhật nhỏ hơn hoặc bằng 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tất cả các mục hàng có thời gian cập nhật lớn hơn hoặc bằng 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • Tất cả các mục hàng đang sử dụng cả kênh đã chỉ định và danh sách từ khoá phủ định đã chỉ định trong tiêu chí nhắm mục tiêu: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

Độ dài của trường này không được vượt quá 500 ký tự.

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 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Các trường
lineItems[]

object (LineItem)

Danh sách mục hàng.

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 lineItems.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 Tổng quan về OAuth 2.0.