Method: guaranteedOrders.list

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

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

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. Jeśli nie podasz ż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 z poprzedniego wywołania metody guaranteedOrders.list. Jeśli nie zostanie określony, 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 to rosnąco. Aby określić kolejność malejącą, 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 jednego ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń używa domyślnie 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 żądań LIST.

Parametr unii accessor. Wymagane.

Określa, do której jednostki DV360 jest wysyłane żądanie. Żądanie LIST zwróci tylko gwarantowane elementy zamówienia, które są dostępne dla elementu DV360 określonego w zasadzie accessor. accessor może być tylko jednym z tych elementów:
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.

Jeśli lista jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobrania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody guaranteedOrders.list.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/display-video

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.