Method: advertisers.creatives.list

Liệt kê các mẫu 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ì mẫu 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/v1beta2/advertisers/{advertiserId}/creatives

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ê mẫu 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 creatives.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à:

  • creativeId (mặc định)
  • createTime
  • mediaDuration
  • dimensions (sắp xếp theo chiều rộng trước, sau đó theo chiều cao)

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ụ: createTime desc
filter

string

Cho phép lọc theo thuộc tính của mẫu 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.
  • Quy định hạn chế cho cùng một trường phải được kết hợp trước OR.
  • Quy định hạn chế cho các trường khác nhau phải được kết hợp trước AND.
  • Từ ( đến ), chỉ OR có thể kết hợp các quy định hạn chế cho cùng một trường.
  • Hạn chế có dạng {field} {operator} {value}.
  • Toán tử phải là EQUALS (=) cho các trường sau:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • Toán tử phải là HAS (:) cho các trường sau:
    • lineItemIds
  • Toán tử phải là GREATER THAN OR EQUAL TO (>=) hoặc LESS THAN OR EQUAL TO (<=) cho các trường sau:
    • updateTime (dữ liệu đầu vào theo định dạng ISO 8601 hoặc YYYY-MM-DDTHH:MM:SSZ)
  • Đối với entityStatus, minDuration, maxDuration, updateTime và dynamic, có thể có tối đa một quy định hạn chế.
  • Đối với dimensions, giá trị có dạng "{width}x{height}".
  • Đối với exchangeReviewStatus, giá trị có dạng {exchange}-{reviewStatus}.
  • Đối với minDuration và maxDuration, giá trị có dạng "{duration}s". Chỉ giây được hỗ trợ với độ chi tiết đến từng mili giây.
  • Đối với updateTime, giá trị trường của tài nguyên mẫu quảng cáo phản ánh lần cập nhật mẫu quảng cáo gần đây nhất, bao gồm cả nội dung cập nhật do hệ thống thực hiện (ví dụ: cập nhật đánh giá mẫu quảng cáo).
  • Có thể có nhiều quy định hạn chế về lineItemIds để tìm kiếm dựa trên nhiều mã mục hàng có thể có.
  • Có thể có nhiều hạn chế về creativeId để tìm kiếm dựa trên nhiều mã mẫu quảng cáo khả thi.

Ví dụ:

  • Tất cả mẫu quảng cáo gốc: creativeType="CREATIVE_TYPE_NATIVE"
  • Tất cả mẫu quảng cáo đang hoạt động có kích thước 300x400 hoặc 50x100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Tất cả quảng cáo động được AdX hoặc AppNexus phê duyệt, với thời lượng tối thiểu là 5 giây và 200 mili giây. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Tất cả mẫu quảng cáo dạng video được liên kết với mã mục hàng 1 hoặc 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Tìm mẫu quảng cáo theo nhiều mã mẫu quảng cáo: creativeId=1 OR creativeId=2

  • Tất cả mẫu 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 (format of 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ự.

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

object (Creative)

Danh sách mẫu 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 ListCreativesRequest để truy xuất trang kết quả tiếp theo. Nếu trường này rỗng, có nghĩa đây là trang cuối cùng.

Phạm vi cấp phép

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.