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ụ.
Bắt buộc. Mã nhận dạng nhà quảng cáo có chứa các nhóm quảng cáo.
Tham số truy vấn
Tham số
pageSize
integer
Kích thước trang yêu cầu. Giá trị phải nằm trong khoảng từ 1 đến 200. Nếu bạn 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
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 youtubeAdGroups.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
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 các trường nhóm quảng cáo tuỳ chỉnh trên YouTube.
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ế.
Bạn có thể kết hợp các quy định hạn chế bằng AND và OR. Một chuỗi các hạn chế ngầm sử dụng AND.
Quy định 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 (=).
Các 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ả nhóm quảng cáo ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSEDYOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM trong một nhà quảng cáo: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"
Độ 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 tiếp theo của kết quả. Truyền giá trị này vào trường pageToken trong lệnh gọi tiếp theo đến phương thức youtubeAdGroups.list để truy xuất trang kết quả tiếp theo.