Method: advertisers.creatives.list

Wyświetla listę kreacji reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli nie podasz wartości filter × entityStatus, kreacje o wartości 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, dla którego mają być wyświetlane kreacje.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w przedziale od 1 do 200. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna 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 z poprzedniego wywołania metody creatives.list. Jeśli nie zostanie określona, zwracana będzie pierwsza strona wyników.

orderBy

string

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

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

Domyślna kolejność sortowania to 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. Ciąg ograniczeń niejawnie używa symbolu 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 (<=).
  • W przypadku wszystkich pozostałych pól musisz użyć operatora EQUALS (=).
  • W przypadku pól entityStatus, minDuration, maxDuration, updateTimedynamic może występować co najwyżej 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 wejściowe w formie {duration}s. Obsługiwane są tylko sekundy)
  • minDuration (dane wejściowe w formie {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 ostatnią aktualizację kreacji, w tym aktualizacje wprowadzone przez system (np. aktualizacje przeglądu 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: creativeId=1 OR creativeId=2
  • Wszystkie kreacje, których czas aktualizacji jest większy lub równy 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 filtrowanie żą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 jej w tym miejscu.

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 sekcji OAuth 2.0 Overview.