Method: advertisers.insertionOrders.list

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

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

Żądanie HTTP

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

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ę zamówień reklamowych.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Musi należeć do przedziału od 1 do 100. 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 insertionOrders.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:

  • „displayName” (domyślnie),
  • "entityStatus"
  • "updateTime"

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

Obsługiwane pola:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (wpisz w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Wszystkie zamówienia reklamowe w kampanii: campaignId="1234"
  • Wszystkie zamówienia reklamowe ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED u reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Wszystkie zamówienia reklamowe z czasem aktualizacji mniejszym lub równym 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszystkie zamówienia reklamowe 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 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Pola
insertionOrders[]

object (InsertionOrder)

Lista zamówień reklamowych.

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 insertionOrders.list, 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 OAuth 2.0 Overview.