Method: advertisers.campaigns.list

Liệt kê các chiến dịch trong một nhà quảng cáo.

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 chiến dịch 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}/campaigns

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

Tham số đường dẫn

Thông số
advertiserId

string (int64 format)

Mã của nhà quảng cáo mà bạn muốn liệt kê chiến dịch.

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 không chỉ định, giá trị mặc định sẽ là 100.
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 campaigns.list. Nếu không được chỉ định, trang kết quả đầu tiên sẽ được trả về.
orderBy

string

Trườ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, 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 chiến dịch.

Cú pháp được hỗ trợ:

  • Biểu thức lọc bao gồm một hoặc nhiều quy tắc hạn chế.
  • Bạn có thể kết hợp các quy tắc hạn chế bằng toán tử logic AND hoặc OR. Một trình tự các quy tắc hạn chế sử dụng ngầm AND.
  • Quy tắc 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 (đưa vào ở định dạng ISO 8601 hoặc YYYY-MM-DDTHH:MM:SSZ)

Ví dụ:

  • Tất cả chiến dịch ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSED thuộc một nhà quảng cáo: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Tất cả chiến dịch 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ả chiến dịch 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ự.

Tham khảo hướng dẫn lọc các yêu cầu LIST để 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Trường
campaigns[]

object (Campaign)

Danh sách chiến dịch.

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 trong trường pageToken trong lệnh gọi tiếp theo đến phương thức campaigns.list để truy xuất trang kết quả tiếp theo.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.