REST Resource: exchanges.auctionPackages

Zasób: AuctionPackage

Zawiera pojedynczy pakiet aukcji. Reklamodawcy w DV3 mogą przeglądać wszystkie pakiety aukcji w DV3 za pomocą interfejsu odkrywania rynków i wyrazić zgodę na korzystanie z tych pakietów bez działania sprzedawcy.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "status": enum (DiscoveryObjectStatus),
  "description": string,
  "format": enum (Format),
  "forecast": {
    object (SellerProvidedInventoryAvailabilityEstimate)
  },
  "externalDealId": string,
  "logoUrl": string,
  "floorPrice": {
    object (Money)
  },
  "startTime": string,
  "endTime": string,
  "mediumType": enum (MediumType),
  "urgOwners": [
    enum (UnderRepresentedGroup)
  ],
  "dv3MarketplaceUri": string
}
Pola
name

string

Identyfikator. Względna nazwa trasy dla tego pakietu aukcji. Powinna mieć format „exchanges/{seller_id}/auctionpackages/{auction_package_id}”. Przykład: „exchanges/1234/auctionPackage/5678”. Tylko dane wyjściowe.
displayName

string

Wymagane. Wyświetlana nazwa tego pakietu aukcji. Musi być zakodowana w formacie UTF-8 i mieć maksymalnie 240 znaków. Wymagane.
status

enum (DiscoveryObjectStatus)

Wymagane. Stan tego pakietu aukcji. Pakiety ze stanem PAUSED lub REMOVED nie są wyświetlane reklamodawcom w DV3. Wymagane.
description

string

Wymagane. Tekst opisu tego pakietu. Musi być zakodowany w formacie UTF-8 i mieć maksymalnie 2000 znaków. Wymagane.
format

enum (Format)

Wymagane. Wartość niezmienna. Podstawowy typ formatu reklamy. Wymagane. Po utworzeniu nie można aktualizować.
forecast

object (SellerProvidedInventoryAvailabilityEstimate)

Opcjonalnie. Zestawienie prognozowania dla zasobów reklamowych tego pakietu aukcji. Reklamodawcy w DV3 mogą wyświetlać i filtrować te podziały. Opcjonalnie.
externalDealId

string

Wymagane. Wartość niezmienna. Identyfikator umowy na giełdzie używany w żądaniach stawek. Maksymalnie 100 znaków. Dopuszczalne znaki to alfanumeryczne, podkreślenie, myślnik i kropka. Wymagane. Wymagane. Po utworzeniu nie można aktualizować.
logoUrl

string

Tylko dane wyjściowe. Adres URL logo tego pakietu aukcji.

Tylko dane wyjściowe.
floorPrice

object (Money)

Wymagane. Cena minimalna tego pakietu aukcji. Wymagane.
startTime

string (Timestamp format)

Wymagane. Czas, kiedy ten produkt staje się aktywny. Musi być wcześniejszy niż endTime. Czas rozpoczęcia nie może być późniejszy niż 1 rok. Wymagane.

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".
endTime

string (Timestamp format)

Wymagane. Czas, kiedy ten produkt staje się nieaktywny. Wymagane.

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".
mediumType

enum (MediumType)

Wymagane. Typ mediów pakietu aukcji.
urgOwners[]

enum (UnderRepresentedGroup)

Opcjonalnie. Niedostatecznie reprezentowane grupy, do których należy właściciel.
dv3MarketplaceUri

string

Tylko dane wyjściowe. Link do pakietu aukcji w DV360.

Format

Format reklamy w pakiecie aukcji.

Wartości w polu enum
DEAL_FORMAT_UNSPECIFIED Format umowy nieokreślony. Nieprawidłowa wartość wejściowa.
DEAL_FORMAT_DISPLAY Format wyświetlania.
DEAL_FORMAT_VIDEO Format filmu.
DEAL_FORMAT_AUDIO Format dźwięku.

Metody

create

 Tworzy nowy pakiet aukcji.

get

 Pobiera pakiet aukcji.

list

 Wyświetla listę pakietów aukcji.

patch

 Aktualizuje pakiet aukcji.
Przesyła logo określonego pakietu.