Method: advertisers.youtubeAdGroups.list

Wyświetla listę grup reklam w YouTube.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups

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

Żą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

Token identyfikujący stronę z wynikami, który powinien zwrócić serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody youtubeAdGroups.list. Jeśli nie podasz żadnej wartości, wyświetlana będzie pierwsza strona wyników.
orderBy

string

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

  • displayName (domyślnie)
  • entityStatus

Domyślna kolejność sortowania rosnąco. Aby określić kolejność malejącą w polu, do nazwy pola należy dodać sufiks „desc”. Przykład: displayName desc.
filter

string

Umożliwia filtrowanie według niestandardowych pól grupy reklam w YouTube.

Obsługiwana składnia:

  • Wyrażenia filtra obejmują co najmniej 1 ograniczenie.
  • Ograniczenia mogą być połączone za pomocą 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 ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM grupy reklam reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"

To pole może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym 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 
{
  "youtubeAdGroups": [
    {
      object (YoutubeAdGroup)
    }
  ],
  "nextPageToken": string
}
Pola
youtubeAdGroups[]

object (YoutubeAdGroup)

Lista grup reklam.

Jeśli lista jest pusta, nie będzie jej widać.
nextPageToken

string

Token pobierający następną stronę wyników. W kolejnym wywołaniu metody youtubeAdGroups.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 omówieniu protokołu OAuth 2.0.