Method: guaranteedOrders.list

Wyświetla listę zamówień gwarantowanych, które są dostępne dla bieżącego użytkownika.

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

Żądanie HTTP

GET https://displayvideo.googleapis.com/v1/guaranteedOrders

Adres URL używa składni transkodowania gRPC.

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.
pageToken

string

Token określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody guaranteedOrders.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)

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

string

Umożliwia filtrowanie według pól zamówienia gwarantowanego.

  • 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}.
  • Wszystkie pola muszą używać operatora EQUALS (=).

Obsługiwane pola: * guaranteedOrderId * exchange * displayName * status.entityStatus

Przykłady:

  • Wszystkie aktywne zamówienia gwarantowane: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Gwarantowane zamówienia należące do giełd Google Ad Managera lub Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

Więcej informacji znajdziesz w naszym przewodniku po żądaniach filtra LIST.

Parametr sumy accessor. To pole jest wymagane.

Określa, do którego jednostki DV360 przesyłane jest żądanie. Żądanie LIST zwróci tylko gwarantowane elementy zamówienia, do których element DV360 wskazany w elemencie accessor ma dostęp. accessor może mieć tylko jedną z tych wartości:
partnerId

string (int64 format)

Identyfikator partnera, który ma dostęp do zamówienia gwarantowanego.
advertiserId

string (int64 format)

Identyfikator reklamodawcy, który ma dostęp do zamówienia gwarantowanego.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
Pola
guaranteedOrders[]

object (GuaranteedOrder)

Lista zamówień gwarantowanych.

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 guaranteedOrders.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.