Method: guaranteedOrders.list

Wyświetla listę zamówień gwarantowanych, do których ma dostęp bieżący użytkownik.

Kolejność jest określana przez parametr orderBy. Jeśli nie podasz wartości filter by entityStatus, zamówienia gwarantowane ze stanem elementu ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Musi należeć do przedziału od 1 do 200. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna 100.
pageToken

string

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona przez poprzednie wywołanie metody guaranteedOrders.list. Jeśli nie zostanie określona, zwracana jest pierwsza strona wyników.
orderBy

string

Pole, według którego ma być posortowana lista. Akceptowane wartości:

  • displayName (domyślnie)

Domyślna kolejność sortowania to rosnąca. Aby określić kolejność malejącą dla pola, do nazwy pola należy 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 można łączyć za pomocą operatorów logicznych AND lub OR. Ciąg ograniczeń niejawnie używa symbolu 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"
  • Zamówienia gwarantowane należące do giełd Google Ad Manager lub Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

Więcej informacji znajdziesz w przewodniku dotyczącym przesyłania próśb o filtrowanie LIST.

Wymagane.

Określa, w którym podmiocie DV360 jest wysyłane żądanie. Żądanie LIST zwróci tylko jednostki zamówień gwarantowanych, które są dostępne dla jednostki DV360 zidentyfikowanej w parametrze accessor. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
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.
Koniec pól wykluczających się nawzajem.

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.

Jeśli lista jest pusta, nie będzie jej w odpowiedzi.
nextPageToken

string

Token umożliwiający pobranie następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody guaranteedOrders.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 OAuth 2.0 Overview.