Method: advertisers.insertionOrders.list

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

Kolejność jest określana przez parametr orderBy. Jeśli wartość filter w wyniku entityStatus nie jest określona, zamówienia reklamowe z wartością 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)

Wymagane. Identyfikator reklamodawcy, dla którego chcesz wyświetlić listę zamówień reklamowych.

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 insertionOrders.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:

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

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą w polu, dodaj 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 jednego ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa funkcji AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole updateTime musi zawierać operatory GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • We wszystkich innych polach należy 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 ramach kampanii: campaignId="1234"
  • Wszystkie zamówienia reklamowe (ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED) powiązane z reklamodawcą: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Wszystkie zamówienia reklamowe z czasem aktualizacji krótszym 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 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 po filtrowaniu żą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 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 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 artykule Omówienie protokołu OAuth 2.0.