선택사항. 요청한 페이지 크기입니다. 1~200의 값이어야 합니다. 지정하지 않으면 기본값은 100입니다. 잘못된 값이 지정되면 오류 코드 INVALID_ARGUMENT를 반환합니다.
pageToken
string
선택사항입니다. 서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이는 adGroups.list 메서드에 대한 이전 호출에서 반환된 nextPageToken 값입니다. 지정하지 않으면 결과의 첫 번째 페이지가 반환됩니다.
orderBy
string
선택사항입니다. 목록을 정렬할 필드입니다. 사용 가능한 값:
displayName(기본)
entityStatus
기본 정렬 순서는 오름차순입니다. 필드에서 내림차순으로 지정하려면 서픽스 'desc'를 필드 이름에 추가해야 합니다. 예: displayName desc
filter
string
선택사항입니다. 맞춤 광고 그룹 필드를 기준으로 필터링할 수 있습니다.
지원되는 문법:
필터 표현식은 하나 이상의 제한사항으로 구성됩니다.
제한사항은 AND 및 OR로 결합할 수 있습니다. 제한 시퀀스는 AND를 암시적으로 사용합니다.
제한사항은 {field} {operator} {value} 형식입니다.
모든 필드는 EQUALS (=) 연산자를 사용해야 합니다.
지원되는 속성:
adGroupId
displayName
entityStatus
lineItemId
adGroupFormat
예:
광고 항목 lineItemId="1234"의 모든 광고 그룹
광고주((entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM")의 모든 ENTITY_STATUS_ACTIVE 또는 ENTITY_STATUS_PAUSEDAD_GROUP_FORMAT_IN_STREAM 광고 그룹
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["필요한 정보가 없음","missingTheInformationINeed","thumb-down"],["너무 복잡함/단계 수가 너무 많음","tooComplicatedTooManySteps","thumb-down"],["오래됨","outOfDate","thumb-down"],["번역 문제","translationIssue","thumb-down"],["샘플/코드 문제","samplesCodeIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2025-09-10(UTC)"],[[["\u003cp\u003eLists ad groups belonging to a specified advertiser using the \u003ccode\u003eGET\u003c/code\u003e method and the \u003ccode\u003eadGroups.list\u003c/code\u003e endpoint.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering, sorting, and pagination of results via query parameters such as \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty, and the response includes an array of \u003ccode\u003eAdGroup\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving further results.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This resource lists ad groups using a `GET` request to a specified URL, including the advertiser ID as a path parameter. Optional query parameters allow for pagination (`pageSize`, `pageToken`), sorting (`orderBy`), and filtering. The request body is empty. The response body contains a list of ad groups and a `nextPageToken` for retrieving additional results. Access requires the `https://www.googleapis.com/auth/display-video` OAuth scope.\n"],null,["| Display \\& Video 360 API v3 is deprecated and will sunset on **October 7, 2025** . Migrate to [Display \\& Video 360 API v4](/display-video/api/reference/rest/v4) before sunset to avoid an interruption in service.\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.ListAdGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad groups.\n\nHTTP request\n\n`GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath 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\nQuery parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. Requested page size. Must be between `1` and `200`. 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/v3/advertisers.adGroups/list#body.ListAdGroupsResponse.FIELDS.next_page_token) returned from the previous call to `adGroups.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 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 properties: - `adGroupId` - `displayName` - `entityStatus` - `lineItemId` - `adGroupFormat` Examples: - All ad groups under an line item: `lineItemId=\"1234\"` - All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` 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\nRequest body\n\nThe request body must be empty.\n\nResponse body If successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adGroups\": [ { object (/display-video/api/reference/rest/v3/advertisers.adGroups#AdGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroups[]` | `object (`[AdGroup](/display-video/api/reference/rest/v3/advertisers.adGroups#AdGroup)`)` The list of ad groups. 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/v3/advertisers.adGroups/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroups.list` method to retrieve the next page of results. |\n\nAuthorization 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)."]]
