Method: advertisers.creatives.list

Wyświetla listę kreacji reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli nie określono filter według entityStatus, kreacje z ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, dla którego chcesz wyświetlić listę kreacji.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Musi należeć do przedziału od 1 do 200. Jeśli nie zostanie określony, domyślnie będzie to 100. Jeśli podano nieprawidłową wartość, zwraca kod błędu INVALID_ARGUMENT.
pageToken

string

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona przez poprzednie wywołanie metody creatives.list. Jeśli nie zostanie określona, zwrócona zostanie pierwsza strona wyników.
orderBy

string

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

  • creativeId (domyślnie)
  • createTime
  • mediaDuration
  • dimensions (sortowanie najpierw według szerokości, a potem według wysokości)

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą dla pola, do nazwy pola należy 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 można łączyć za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa operatora AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole lineItemIds musi używać operatora HAS (:).
  • Pole updateTime musi używać operatorów GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • Wszystkie pozostałe pola muszą 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 formie {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (dane wejściowe w formie {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (wpisz w formacie {duration}s. Obsługiwane są tylko sekundy)
  • minDuration (wpisz w formacie {duration}s. Obsługiwane są tylko sekundy)
  • updateTime (wpisz w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Uwagi:

  • W przypadku updateTime wartość pola zasobu kreacji odzwierciedla ostatni moment, w którym kreacja została zaktualizowana, w tym aktualizacje wprowadzone przez system (np. aktualizacje sprawdzania 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 minimalnym czasie trwania 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 identyfikatorem elementu zamówienia 1 lub 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Znajdowanie kreacji według wielu identyfikatorów kreacji: creativeId=1 OR creativeId=2
  • Wszystkie kreacje z czasem aktualizacji równym lub późniejszym niż 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Więcej informacji znajdziesz w naszym przewodniku dotyczącym filtrowania żą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 
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Pola
creatives[]

object (Creative)

Lista kreacji.

Jeśli ta lista jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobierania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody ListCreativesRequest, aby pobrać następną stronę wyników. Jeśli to 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 OAuth 2.0 Overview.