Method: advertisers.insertionOrders.list

Wyświetla listę zamówień reklamowych na poziomie reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli filter na entityStatus nie jest określony, zamówienia reklamowe z ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

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

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 chcesz wyświetlić listę zamówień reklamowych.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 100. 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 insertionOrders.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:

  • „displayName” (domyślna)
  • „entityStatus”
  • "updateTime"

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

string

Umożliwia filtrowanie według pól zamówienia reklamowego.

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 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 (=).

Obsługiwane pola:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (dane wejściowe w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Wszystkie zamówienia reklamowe w ramach kampanii: campaignId="1234"
  • Wszystkie zamówienia reklamowe (ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED) przypisane do reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Wszystkie zamówienia reklamowe o czasie aktualizacji krótszym lub równym 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszystkie zamówienia reklamowe o czasie aktualizacji dłuższym lub równym 2020-11-04T18:54:47Z (format 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 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Pola
insertionOrders[]

object (InsertionOrder)

Lista zamówień reklamowych.

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 insertionOrders.list przekaż tę wartość w polu pageToken, aby pobrać następną stronę wyników.

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.