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)

To pole jest wymagane. Identyfikator reklamodawcy, do którego należą grupy reklam.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 200. Jeśli nie określono inaczej, domyślnie przyjmuje się wartość 100. Zwraca kod błędu INVALID_ARGUMENT, jeśli określono nieprawidłową wartość.
pageToken

string

Opcjonalnie. Token określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody adGroups.list. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników.
orderBy

string

Opcjonalnie. Pole służące do sortowania listy. Dopuszczalne wartości:

  • displayName (domyślnie)
  • entityStatus

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą w przypadku pola, do jego nazwy musisz dodać sufiks „desc”. Przykład: displayName desc.
filter

string

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

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • Ograniczenia można łączyć za pomocą tych zasad: AND i OR. Sekwencja ograniczeń domyślnie używa elementu 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 jednym elemencie zamówienia: lineItemId="1234"
  • Wszystkie grupy reklam ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM w ramach reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

To pole nie może zawierać więcej niż 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku po żądaniach filtra 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.

Tej listy nie będzie, jeśli będzie pusta.
nextPageToken

string

Token do pobierania następnej strony wyników. W kolejnym wywołaniu metody adGroups.list przekaż tę wartość w polu pageToken, 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.