Method: advertisers.adGroups.list
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)
Wymagany. 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 usługi:
adGroupId
displayName
entityStatus
lineItemId
adGroupFormat
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ń filtrowania 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-02-25 UTC.
[null,null,["Ostatnia aktualizacja: 2025-02-25 UTC."],[[["Lists ad groups belonging to a specified advertiser using the `GET` method and the `adGroups.list` endpoint."],["Allows filtering, sorting, and pagination of results via query parameters such as `filter`, `orderBy`, `pageSize`, and `pageToken`."],["Request body should be empty, and the response includes an array of `AdGroup` objects and a `nextPageToken` for retrieving further results."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."]]],["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"]]