Method: advertisers.creatives.list

Wyświetla listę 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/v1beta2/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. 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 creatives.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:

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

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą w polu, dodaj sufiks „desc” . Przykład: createTime desc.
filter

string

Umożliwia filtrowanie według właściwości kreacji.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej jednego ograniczenia.
  • Ograniczenie dla tego samego pola należy połączyć w polu OR.
  • Ograniczenia dotyczące różnych pól należy łączyć za pomocą atrybutu AND.
  • Od ( do ) ograniczenia dla tego samego pola mogą być łączone tylko przez OR.
  • Ograniczenie ma postać {field} {operator} {value}.
  • W tych polach operator musi mieć wartość EQUALS (=):
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • W tych polach operator musi mieć wartość HAS (:):
    • lineItemIds
  • W tych polach operator musi być typu GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=):
    • updateTime (wpisz w formacie ISO 8601 lub RRRR-MM-DDTGG:MM:SSZ)
  • W przypadku usług entityStatus, minDuration, maxDuration, updateTime i dynamic może obowiązywać maksymalnie 1 ograniczenie.
  • Wartość w polu dimensions ma postać "{width}x{height}".
  • Wartość w polu exchangeReviewStatus ma postać {exchange}-{reviewStatus}.
  • Wartości minDuration i maxDuration mają postać "{duration}s". Dozwolone są tylko sekundy z dokładnością do milisekund.
  • W przypadku updateTime wartość pola zasobu kreacji odzwierciedla czas ostatniej aktualizacji kreacji, co obejmuje zmiany wprowadzone przez system (np. aktualizacje w opinii kreacji).
  • Przy wyszukiwaniu według wielu możliwych identyfikatorów elementów zamówienia może występować wiele ograniczeń lineItemIds.
  • Podczas wyszukiwania według wielu możliwych identyfikatorów kreacji może być kilka ograniczeń creativeId.

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)
  • Znajdź kreacje na podstawie wielu identyfikatorów: creativeId=1 OR creativeId=2

  • Wszystkie kreacje z czasem aktualizacji równym 2020-11-04T18:54:47Z (format of ISO 8601) lub dłuższym: updateTime>="2020-11-04T18:54:47Z" Długość tego pola nie powinna przekraczać 500 znaków.

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 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 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 artykule Omówienie protokołu OAuth 2.0.