Method: advertisers.youtubeAdGroupAds.list

Wyświetla listę reklam z grupy reklam w YouTube.

Żądanie HTTP

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

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

Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 100. 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

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody youtubeAdGroupAds.list. Jeśli nie określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.
orderBy

string

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

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

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 pola:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Przykłady:

  • Wszystkie reklamy w grupie reklam w grupie reklam: adGroupId="1234"
  • Wszystkie reklamy w grupie reklam należące do grupy reklam o stanie encji ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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 
{
  "youtubeAdGroupAds": [
    {
      object (YoutubeAdGroupAd)
    }
  ],
  "nextPageToken": string
}
Pola
youtubeAdGroupAds[]

object (YoutubeAdGroupAd)

Lista reklam w grupie 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 youtubeAdGroupAds.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.