Method: advertisers.creatives.list

Wyświetla listę kreacji reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli filter dla entityStatus nie zostanie określony, kreacje z ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/creatives

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

To pole jest wymagane. Identyfikator reklamodawcy, dla którego ma zostać wyświetlona lista kreacji.

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 określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody creatives.list. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników.
orderBy

string

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

  • creativeId (domyślnie)
  • createTime
  • mediaDuration
  • dimensions (najpierw sortuje według szerokości, a następnie wysokości)

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: createTime desc.
filter

string

Umożliwia filtrowanie według pól kreacji.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa elementu AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole lineItemIds musi zawierać operator HAS (:).
  • Pole updateTime musi zawierać operatory GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • W pozostałych polach należy używać operatora EQUALS (=).
  • W przypadku pól entityStatus, minDuration, maxDuration, updateTime i dynamic może być maksymalnie 1 ograniczenie.

Obsługiwane pola:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (dane wejściowe w formacie {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (dane wejściowe w formacie {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (dane wejściowe w formacie {duration}s. Obsługiwane są tylko sekundy)
  • minDuration (dane wejściowe w formacie {duration}s. Obsługiwane są tylko sekundy)
  • updateTime (dane wejściowe w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Uwagi:

  • W przypadku updateTime wartość pola zasobu kreacji odzwierciedla czas ostatniej aktualizacji kreacji, co obejmuje zmiany wprowadzone przez system (np. zmiany związane z weryfikacją kreacji).

Przykłady:

  • Wszystkie kreacje natywne: creativeType="CREATIVE_TYPE_NATIVE"
  • Wszystkie aktywne kreacje o wymiarach 300 x 400 lub 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Wszystkie kreacje dynamiczne zatwierdzone przez AdX lub AppNexus o długości co najmniej 5 sekund i 200 ms: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Wszystkie kreacje wideo powiązane z elementem zamówienia o identyfikatorze 1 lub 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Wyszukiwanie kreacji według wielu identyfikatorów: creativeId=1 OR creativeId=2
  • Wszystkie kreacje o czasie aktualizacji dłuższym lub równym 2020-11-04T18:54:47Z (w formacie ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

object (Creative)

Lista kreacji.

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 ListCreativesRequest przekaż tę wartość w polu pageToken, aby pobrać następną stronę wyników. Jeśli pole ma wartość null, oznacza to, że jest to ostatnia strona.

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.