Method: guaranteedOrders.list

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

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

Żądanie HTTP

GET https://displayvideo.googleapis.com/v2/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 identyfikujący stronę z wynikami, który powinien zwrócić serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody guaranteedOrders.list. Jeśli nie podasz żadnej wartości, wyświetlana będzie pierwsza strona wyników.

orderBy

string

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

  • displayName (domyślnie)

Domyślna kolejność sortowania rosnąco. Aby określić kolejność malejącą w polu, 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 obejmują co najmniej 1 ograniczenie.
  • 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 może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku po filtrowaniu żądań LIST.

Parametr sumy funkcji accessor. To pole jest wymagane.

Identyfikuje element DV360, w sprawie którego wysyłane jest żądanie. Żądanie LIST zwróci tylko elementy zamówień gwarantowanych, które są dostępne dla elementu DV360 określonego w elemencie accessor. accessor może być 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.

Jeśli lista jest pusta, nie będzie jej widać.

nextPageToken

string

Token pobierający następną stronę 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 omówieniu protokołu OAuth 2.0.