REST Resource: exchanges.orders

Zasób: Order

Oferta niepodlegająca negocjacjom, którą kupujący może zaakceptować.

Zapis JSON
{
  "name": string,
  "displayName": string,
  "partnerId": [
    string
  ],
  "publisherEmail": string,
  "publisherName": string,
  "budget": {
    object (Budget)
  },
  "status": enum (OrderStatus),
  "wseatConfig": {
    object (WSeatConfig)
  },
  "updateTime": string,
  "buyerInfo": {
    object (BuyerInfo)
  }
}
Pola
name

string

Względna nazwa zasobu zamówienia. Wygenerowany przez serwer. Przykład: „exchanges/1234/orders/5678”. Tylko dane wyjściowe.

displayName

string

Nazwa zamówienia wyświetlana kupującemu. Maksymalnie 250 znaków. Opcjonalnie.

partnerId[]

string (int64 format)

Identyfikator partnera w Google Display & Video 360, wcześniej znany jako DoubleClick Bid Manager(DBM). Umożliwia podanie tylko 1 identyfikatora partnera. Wymagany.

publisherEmail

string

Adres e-mail wydawcy. Musi mieć prawidłowy format adresu e-mail. Maksymalnie 250 znaków. Opcjonalnie.

publisherName

string

Nazwa wydawcy. Maksymalnie 250 znaków. Wymagany.

budget

object (Budget)

Tylko dane wyjściowe. Budżet ustalony przez kupującego. Dotyczy tylko scenariuszy transakcji natychmiastowych.

status

enum (OrderStatus)

Stan zamówienia. Stan może się zmienić, gdy użytkownicy DV3 zaakceptują, anulują lub zarchiwizują zamówienie. Obsługuje też aktualizację do stanu „ANULOWANO” po utworzeniu w interfejsie API, aby zasygnalizować, że to zamówienie zostało anulowane na giełdzie.

wseatConfig

object (WSeatConfig)

Opcjonalnie. WSeat Configuration Specifies the WSeat configuration on the exchange side. Giełdy korzystające z umów wielostanowiskowych powinny dbać o to, aby to pole było wypełnione i aktualne.

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy zamówienie lub powiązane z nim produkty zostały zaktualizowane.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

buyerInfo

object (BuyerInfo)

Tylko dane wyjściowe. Informacje o kupującym, w tym szczegóły dotyczące partnera i reklamodawcy. Dotyczy tylko scenariuszy transakcji natychmiastowych.

Budżet

Określono budżet.

Zapis JSON
{
  "budgetType": enum (BudgetType),

  // Union field budget can be only one of the following:
  "impressions": string,
  "money": {
    object (Money)
  }
  // End of list of possible types for union field budget.
}
Pola
budgetType

enum (BudgetType)

Określony typ budżetu.

Pole unii budget. Można uwzględnić tylko 1 typ budżetu. budget może mieć tylko jedną z tych wartości:
impressions

string (int64 format)

Budżet wyświetleń.

money

object (Money)

Budżet walutowy.

BudgetType

Typy budżetów

Wartości w polu enum
BUDGET_TYPE_UNSPECIFIED Nieokreślony budżet. Nieprawidłowe dane wejściowe.
BUDGET_TYPE_CURRENCY Budżet walutowy.
BUDGET_TYPE_IMPRESSION Budżet wyświetleń.

OrderStatus

Stan zamówienia.

Wartości w polu enum
ORDER_STATUS_UNSPECIFIED Stan zamówienia nieokreślony. Nieoczekiwany, wskazuje, że stan negocjacji jest nieznany. Nieprawidłowa wartość wejściowa.
PENDING_ACCEPTANCE Zamówienie oczekuje na zaakceptowanie.
ACCEPTED Stan zamówienia: zaakceptowane.
ARCHIVED Stan zamówienia został zarchiwizowany.
CANCELLED Stan zamówienia: anulowane.
NEGOTIATING Stan zamówienia: negocjowanie. Dotyczy tylko scenariuszy transakcji natychmiastowych.

WSeatConfig

Konfiguracja WSeat.

Zapis JSON
{
  "exchangeWseatStatus": enum (WSeatStatus),
  "exchangeWseatIds": [
    string
  ],
  "updateTime": string
}
Pola
exchangeWseatStatus

enum (WSeatStatus)

Opcjonalnie. Bieżący stan konfiguracji WSeat po stronie Exchange.

exchangeWseatIds[]

string (int64 format)

Opcjonalnie. Identyfikatory WSeat po stronie giełdy.

updateTime

string (Timestamp format)

Tylko dane wyjściowe. To pole jest automatycznie aktualizowane przez DV3, gdy platforma wymiany aktualizuje WSeatConfiguration.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

WSeatStatus

Opcje wyliczenia WSeat Status.

Wartości w polu enum
W_SEAT_STATUS_UNSPECIFIED WSeatStatus nieokreślony.
W_SEAT_STATUS_ENFORCED WSeatStatus enforced. Wskazuje, czy Exchange egzekwuje WSeatId, wysyłając WSeatId do DV3 lub weryfikując wseatids w odpowiedziach na stawki.
W_SEAT_STATUS_NOT_ENFORCED WSeatStatus nie jest wymuszany. Oznacza, że giełda nie wysyła w pytaniach o stawkę parametru wseatid ani go nie weryfikuje.

BuyerInfo

Informacje o kupującym w przypadku umów błyskawicznych.

Zapis JSON
{
  "partner": {
    object (PartnerInfo)
  },
  "advertisers": [
    {
      object (AdvertiserInfo)
    }
  ]
}
Pola
partner

object (PartnerInfo)

Tylko dane wyjściowe. Informacje o partnerze.

advertisers[]

object (AdvertiserInfo)

Tylko dane wyjściowe. Informacje o reklamodawcy.

PartnerInfo

Informacje o partnerze w przypadku umów błyskawicznych.

Zapis JSON
{
  "title": string
}
Pola
title

string

Tylko dane wyjściowe. Wyświetlana nazwa partnera w Display & Video 360.

AdvertiserInfo

Informacje o reklamodawcy w przypadku umów błyskawicznych.

Zapis JSON
{
  "advertiserId": string,
  "domainUri": string
}
Pola
advertiserId

string (int64 format)

Tylko dane wyjściowe. Identyfikator reklamodawcy w Display & Video 360.

domainUri

string

Tylko dane wyjściowe. Identyfikator URI domeny witryny reklamodawcy.

Metody

accept

Przyjmuje zamówienie.

create

Tworzy zamówienie.

get

Pobiera zamówienie.

list

Lista zamówień.

patch

Aktualizuje zamówienie.