Od
8 września 2025 r. każdy nowy element zamówienia będzie musiał deklarować, czy będzie wyświetlać reklamy polityczne w Unii Europejskiej (UE). Przesyłanie plików SDF i wywoływanie interfejsu Display & Video 360 API bez deklaracji zakończy się niepowodzeniem. Więcej informacji o tym, jak zaktualizować integrację, aby złożyć to oświadczenie, znajdziesz na naszej
stronie dotyczącej wycofania.
Method: advertisers.adGroups.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Wyświetla listę grup reklam.
Żądanie HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
advertiserId |
string (int64 format)
Wymagane. Identyfikator reklamodawcy, do którego należą grupy reklam.
|
Parametry zapytania
| Parametry |
pageSize |
integer
Opcjonalnie: Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podana zostanie nieprawidłowa wartość, zwraca kod błędu INVALID_ARGUMENT.
|
pageToken |
string
Opcjonalnie: Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody adGroups.list. Jeśli nie zostanie określony, zwrócona zostanie pierwsza strona wyników.
|
orderBy |
string
Opcjonalnie: Pole, według którego ma być sortowana lista. Akceptowane wartości:
displayName (domyślnie)entityStatus Domyślna kolejność sortowania to rosnąco. Aby określić pole w kolejności malejącej, do nazwy pola należy dodać sufiks „desc”. Przykład: displayName desc.
|
filter |
string
Opcjonalnie: Umożliwia filtrowanie według pól niestandardowych grup reklam. Obsługiwana składnia:
- Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
- Ograniczenia można łączyć za pomocą
AND i OR. Sekwencja ograniczeń używa domyślnie AND.
- Ograniczenie ma postać
{field} {operator} {value}.
- Wszystkie pola muszą zawierać operator
EQUALS (=).
Obsługiwane właściwości:
adGroupIddisplayNameentityStatuslineItemIdadGroupFormat Przykłady:
- Wszystkie grupy reklam w ramach elementu zamówienia:
lineItemId="1234"
- Wszystkie grupy reklam
ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"
Długość tego pola nie powinna przekraczać 500 znaków. Więcej informacji znajdziesz w przewodniku dotyczącym żądań LIST.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"adGroups": [
{
object (AdGroup)
}
],
"nextPageToken": string
} |
| Pola |
adGroups[] |
object (AdGroup)
Lista grup reklam. Jeśli lista jest pusta, nie będzie widoczna.
|
nextPageToken |
string
Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody adGroups.list.
|
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/display-video
Więcej informacji znajdziesz w OAuth 2.0 Overview.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-25 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,["# Method: advertisers.adGroups.list\n\n| Display \\& Video 360 API 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\n### HTTP 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\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 `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\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| ``` { \"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\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)."]]
