Kể từ
ngày 8 tháng 9 năm 2025, mỗi mục hàng mới sẽ cần phải khai báo xem mục hàng đó có phân phát quảng cáo chính trị ở Liên minh Châu Âu (EU) hay không. Display & Video 360 API và các tệp SDF được tải lên mà không cung cấp thông tin khai báo sẽ không thành công. Hãy xem
trang thông báo về những nội dung không dùng nữa để biết thêm thông tin về cách cập nhật quy trình tích hợp để đưa ra nội dung khai báo này.
Method: advertisers.adGroupAds.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Liệt kê quảng cáo trong nhóm quảng cáo.
Yêu cầu HTTP
GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds
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 100. 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 adGroupAds.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 quảng cáo của nhóm quảng cáo tuỳ chỉnh. 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 (=).
Các trường được hỗ trợ:
adGroupIddisplayNameentityStatusadGroupAdId Ví dụ:
- Tất cả quảng cáo trong nhóm quảng cáo:
adGroupId="1234"
- Tất cả quảng cáo trong nhóm quảng cáo có entityStatus là
ENTITY_STATUS_ACTIVE hoặc ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupId="12345"
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 |
{
"adGroupAds": [
{
object (AdGroupAd)
}
],
"nextPageToken": string
} |
| Trường |
adGroupAds[] |
object (AdGroupAd)
Danh sách quảng cáo trong 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 adGroupAds.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.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[],["The Display & Video 360 API v4 allows listing ad group ads via a GET request to `https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds`. The `advertiserId` path parameter is required. Query parameters include `pageSize`, `pageToken`, `orderBy` for sorting (e.g., `displayName`), and `filter` to filter by fields like `adGroupId`. The response contains a list of ad group ads and a `nextPageToken` for pagination. The request body must be empty. The API requires OAuth scope `https://www.googleapis.com/auth/display-video`.\n"],null,["# Method: advertisers.adGroupAds.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAdGroupAdsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad group ads.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the advertiser the ad groups belongs to. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` Optional. A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/advertisers.adGroupAds/list#body.ListAdGroupAdsResponse.FIELDS.next_page_token) returned from the previous call to `adGroupAds.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Optional. Field by which to sort the list. Acceptable values are: - `displayName` (default) - `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`. |\n| `filter` | `string` Optional. Allows filtering by custom ad group ad fields. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `EQUALS (=)` operator. Supported fields: - `adGroupId` - `displayName` - `entityStatus` - `adGroupAdId` Examples: - All ad group ads under an ad group: `adGroupId=\"1234\"` - All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adGroupAds\": [ { object (/display-video/api/reference/rest/v4/advertisers.adGroupAds#AdGroupAd) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroupAds[]` | `object (`[AdGroupAd](/display-video/api/reference/rest/v4/advertisers.adGroupAds#AdGroupAd)`)` The list of ad group ads. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/advertisers.adGroupAds/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroupAds.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
