Method: advertisers.insertionOrders.list

Wyświetla zamówienia reklamowe w reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli nie określisz wartości filter w komponencie entityStatus, zamówienia na wstawione reklamy z wartością ENTITY_STATUS_ARCHIVED nie będą uwzględniane w wynikach.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, którego zamówienia reklamowe mają być wyświetlane.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–100. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podana zostanie nieprawidłowa 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 insertionOrders.list. Jeśli nie zostanie określony, 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 to rosnąco. Aby określić pole w kolejności malejącej, 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ń używa domyślnie AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • W polu updateTime musisz użyć operatora GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • W pozostałych polach musisz użyć operatora EQUALS (=).

Obsługiwane pola:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (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 w sekcji Reklamodawca: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Wszystkie zamówienia z aktualizacją o czasie 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 lub większym niż 2020-11-04T18:54:47Z (w formacie ISO 8601): updateTime>="2020-11-04T18:54:47Z"

Długość tego pola nie powinna przekraczać 500 znaków.

Więcej informacji znajdziesz w przewodniku dotyczącym żą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 jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody insertionOrders.list.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/display-video

Więcej informacji znajdziesz w OAuth 2.0 Overview.