Method: advertisers.adGroups.list

Liệt kê các nhóm quảng cáo.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Thông số
advertiserId

string (int64 format)

Bắt buộc. Mã của nhà quảng cáo sở hữu các nhóm quảng cáo.

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. 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. Trả về mã lỗi INVALID_ARGUMENT nếu bạn chỉ định một giá trị không hợp lệ.
pageToken

string

Không bắt buộc. 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 adGroups.list. Nếu không được chỉ định, trang kết quả đầu tiên sẽ được trả về.
orderBy

string

Không bắt buộc. Trường để sắp xếp danh sách. Các giá trị được chấp nhận là:

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

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

Không bắt buộc. Cho phép lọc theo các trường tuỳ chỉnh của nhóm quảng cáo.

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 định hạn chế bằng AND và 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}.
  • Tất cả các trường phải sử dụng toán tử EQUALS (=).

Thuộc tính được hỗ trợ:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Ví dụ:

  • Tất cả nhóm quảng cáo trong một mục hàng: lineItemId="1234"
  • Tất cả các nhóm quảng cáo ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM thuộc một nhà quảng cáo: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

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

object (AdGroup)

Danh sách nhóm quảng cáo.

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 adGroups.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 OAuth 2.0 Overview.