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)

Wymagane. Identyfikator reklamodawcy, do którego należą grupy reklam.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie: Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 200. Jeśli nie określono inaczej, domyślna wartość to 100. Zwraca kod błędu INVALID_ARGUMENT w przypadku określenia nieprawidłowej wartości.
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 określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.
orderBy

string

Opcjonalnie: Pole, według którego lista ma być sortowana. Akceptowane wartości:

  • displayName (domyślnie)
  • entityStatus

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą w polu, dodaj sufiks „desc” . Przykład: displayName desc.
filter

string

Opcjonalnie: Umożliwia filtrowanie według niestandardowych pól grupy reklam.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej jednego ograniczenia.
  • Ograniczenia mogą być łączone przez AND i OR. Sekwencja ograniczeń domyślnie używa funkcji AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Wszystkie pola muszą używać operatora EQUALS (=).

Obsługiwane właściwości:

  • 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 po filtrowaniu żą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 będzie pusta, nie będzie ona dostępna.
nextPageToken

string

Token do pobrania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody adGroups.list, aby pobrać następną stronę wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/display-video

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.