Method: advertisers.lineItems.list

Wyświetla listę elementów zamówienia we właściwościach reklamodawcy.

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

Żądanie HTTP

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

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 mają zostać wyświetlone elementy zamówienia.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 200. 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 identyfikujący stronę z wynikami, który powinien zwrócić serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody lineItems.list. Jeśli nie podasz żadnej wartości, wyświetlana będzie pierwsza strona wyników.
orderBy

string

Pole służące do sortowania listy. Akceptowane wartości:

  • displayName (domyślnie)
  • entityStatus
  • updateTime

Domyślna kolejność sortowania rosnąco. Aby określić kolejność malejącą w polu, 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 obejmują co najmniej 1 ograniczenie.
  • 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ć operator GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • We wszystkich innych polach musi być używany operator EQUALS (=).

Obsługiwane pola:

  • campaignId
  • displayName
  • entityStatus
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (dane wejściowe 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 elementy zamówienia z czasem aktualizacji krótszym lub równym 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszystkie elementy zamówienia z czasem aktualizacji nieprzekraczającym 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 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 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Pola
lineItems[]

object (LineItem)

Lista elementów zamówienia.

Jeśli lista jest pusta, nie będzie jej widać.
nextPageToken

string

Token pobierający następną stronę wyników. W kolejnym wywołaniu metody lineItems.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 omówieniu protokołu OAuth 2.0.