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 określono filter według entityStatus, zamówienia gwarantowane ze stanem elementu ENTITY_STATUS_ARCHIVED nie zostaną uwzględnione w wynikach.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v5/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 zostanie określony, domyślnie będzie to 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, zwrócona zostanie pierwsza strona wyników.
orderBy

string

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

  • displayName (domyślnie)

Domyślna kolejność sortowania jest 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 gwarantowanego zamówienia.

  • 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ń domyślnie używa operatora 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"

To pole może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku dotyczącym filtrowania żądań LIST.

Wymagane.

Identyfikuje element DV360, w którym jest wysyłane żądanie. Żądanie LIST zwróci tylko encje zamówień gwarantowanych, które są dostępne dla encji DV360 określonej w parametrze accessor. Poniżej znajduje się lista pól, które wzajemnie się 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 gwarantowanego zamówienia.
advertiserId

string (int64 format)

Identyfikator reklamodawcy, który ma dostęp do gwarantowanego zamówienia.
Koniec pól wykluczających się wzajemnie.

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 gwarantowanych zamówień.

Jeśli ta 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 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.