Method: advertisers.creatives.list

Lista kreacji reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli wartość filter w związku entityStatus nie jest określona, kreacje z atrybutem ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, którego kreacje mają się wyświetlać na liście.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podana zostanie nieprawidłowa 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 z poprzedniego wywołania metody creatives.list. Jeśli nie zostanie określony, zwrócona zostanie pierwsza strona wyników.
orderBy

string

Pole, według którego lista ma być sortowana. 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 to rosnąco. Aby określić pole w kolejności malejącej, 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 jednego ograniczenia.
  • Ograniczenia można łączyć za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa funkcji AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • W polu lineItemIds musisz użyć operatora HAS (:).
  • Pole updateTime musi zawierać operatory GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • W pozostałych polach musisz użyć operatora EQUALS (=).
  • W przypadku pól entityStatus, minDuration, maxDuration, updateTime i dynamic może być zdefiniowana 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 (dane w formie {duration}s. Obsługiwane są tylko sekundy.
  • minDuration (dane w formie {duration}s. Dozwolone są tylko sekundy).
  • updateTime (w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Uwagi:

  • W przypadku wartości pola zasobu kreacji updateTime (zaktualizowano updateTime) odzwierciedla ona ostatnią aktualizację kreacji, w tym aktualizacje wprowadzone przez system (np. aktualizacje weryfikacji 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, minimalny czas trwania wynoszący 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)
  • Znajdowanie kreacji według wielu identyfikatorów kreacji: creativeId=1 OR creativeId=2
  • Wszystkie kreacje z czasem aktualizacji wynoszącym co najmniej 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

Długość tego pola nie powinna przekraczać 500 znaków.

Więcej informacji znajdziesz w przewodniku dotyczącym żą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 lista jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody ListCreativesRequest. 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 artykule Omówienie OAuth 2.0.