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 na entityStatus nie jest określony, elementy zamówienia z ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v1beta2/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 100. 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 określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody lineItems.list. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników.
orderBy

string

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

  • displayName (domyślnie)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą w przypadku pola, do jego nazwy musisz dodać sufiks „desc”. Przykład: displayName desc.
filter

string

Umożliwia filtrowanie według właściwości elementu zamówienia.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • 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}.
  • Operator użyty w usłudze flight.dateRange.endDate musi być MNIEJ NIŻ (<).
  • Operatorem użytym w updateTime musi być GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • Operatorem użytym w warningMessages musi być HAS (:).
  • We wszystkich innych polach operatory muszą mieć wartość EQUALS (=).
  • Obsługiwane właściwości:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (dane wejściowe w formacie RRRR-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (dane wejściowe w formacie ISO 8601 lub RRRR-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

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, których daty wyświetlania reklam kończą się przed 28 marca 2019 roku: flight.dateRange.endDate<"2019-03-28"
  • Wszystkie elementy zamówienia, które mają NO_VALID_CREATIVE w kolumnie warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • Wszystkie elementy zamówienia z czasem aktualizacji krótszym lub równym 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszystkie elementy zamówienia z czasem aktualizacji co najmniej 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • Wszystkie elementy zamówienia, które używają zarówno określonego kanału, jak i określonej listy wykluczających słów kluczowych w kierowaniu: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

To pole nie może zawierać więcej niż 500 znaków.

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.

Tej listy nie będzie, jeśli będzie pusta.
nextPageToken

string

Token do pobierania następnej strony 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 artykule Omówienie protokołu OAuth 2.0.