Method: advertisers.lineItems.list

Wyświetla listę elementów zamówienia reklamodawcy.

Kolejność jest określana przez parametr orderBy. Jeśli nie określisz relacji filter do entityStatus, elementy zamówienia z wartością ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/lineItems

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ć elementy zamówienia.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 200. 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 lineItems.list. Jeśli nie określono tego ustawienia, zostanie zwrócona 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 elementu zamówienia.

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}.
  • 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
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Wszystkie elementy zamówienia w ramach zamówienia reklamowego: insertionOrderId="1234"
  • Wszystkie elementy zamówienia ENTITY_STATUS_ACTIVE lub ENTITY_STATUS_PAUSED i LINE_ITEM_TYPE_DISPLAY_DEFAULT w ramach reklamodawcy: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Wszystkie pozycje z czasem aktualizacji równym lub mniejszym niż 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszystkie pozycje z czasem aktualizacji równym lub większym niż 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 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 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Pola
lineItems[]

object (LineItem)

Lista elementów zamówienia.

Jeśli 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 lineItems.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 OAuth 2.0.