REST Resource: exchanges.orders.products

Zasób: Product

Produkt

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
Pola
name

string

Względna nazwa trasy dla produktu. Wygenerowany przez serwer. Przykład: „exchanges/1234/orders/5678/products/abc”. Tylko dane wyjściowe.
displayName

string

Wyświetlana nazwa produktu.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów. Wymagane.
externalDealId

string

Identyfikator zewnętrzny. Jest to identyfikator umowy w systemie giełdy. Maksymalnie 100 znaków. Dozwolone znaki to znaki alfanumeryczne, podkreślenie, myślnik i kropka. Musi być unikalny we wszystkich produktach. Wymagane.
transactionType

enum (TransactionType)

Typ transakcji dotyczący produktu. Wymagane.
pricingType

enum (PricingType)

Typ ceny produktu. Wymagane.
updateTime
(deprecated)

string (Timestamp format)

Sygnatura czasowa ostatniej aktualizacji produktu.

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

string (Timestamp format)

Czas, w którym ten produkt staje się aktywny. Musi być wcześniejsza niż endTime. Czas rozpoczęcia nie może przypadać później niż za 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)

Czas, w którym ten produkt stanie się nieaktywny. Obecnie nie może przypadać później niż w 2036 r. 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".
rateDetails

object (RateDetails)

Szczegóły stawki. Wymagane.
creativeConfig[]

object (CreativeConfig)

Wymagania dotyczące kreacji w przypadku produktu. Wymagany w przypadku produktu z zarezerwowanym typem transakcji.
makegood
(deprecated)

boolean

Określa, czy produkt jest produktem kompensacyjnym.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Szczegóły rekompensaty za produkt. Wymagany, gdy produkt jest rekompensatą.
creativeSource

enum (CreativeSource)

Źródło kreacji produktu. Opcjonalny, domyślnie CREATIVE_SOURCE_ADVERTISER. Po utworzeniu produktu nie można tego zmienić.
mediumType

enum (MediumType)

Typ nośnika produktu. Jeśli nie zostanie określony, domyślnie przyjmuje wartość DIGITAL na potrzeby zgodności wstecznej. Po utworzeniu produktu nie można tego zmienić.
audienceTargetingConfig

object (AudienceTargetingConfig)

Opcjonalnie: Wybrana konfiguracja kierowania na odbiorców została zastosowana na poziomie umowy na giełdzie.
targetingCriteria

object (TargetingCriteria)

Tylko dane wyjściowe. Odwołania do kryteriów kierowania na produkt. Dotyczy to tylko scenariuszy transakcji natychmiastowych.
forecastResult

object (ForecastResult)

wyniki prognozy produktu, Wymagane, gdy kryteria kierowania nie są puste, a prognoza nie jest podana. Dotyczy to tylko scenariuszy transakcji natychmiastowych.
errorDetails

object (ErrorDetails)

Jeśli nie można zaktualizować określonych pól produktu, należy podać szczegóły błędu. Wymagane, gdy nie można podać wyniku prognozy z powodu kryterium kierowania lub nie można zaktualizować produktu. Dotyczy to tylko scenariuszy transakcji natychmiastowych.
frequencyCap

object (FrequencyCap)

Tylko dane wyjściowe. Limit wyświetleń na użytkownika wybrany przez kupującego. Dotyczy to tylko scenariuszy transakcji natychmiastowych.
etag

string

Tag ETag, który należy podać podczas aktualizowania produktu. W przypadku aktualizacji należy go podać tylko wtedy, gdy pole etag nie jest puste. Dotyczy to tylko scenariuszy transakcji natychmiastowych.

CreativeConfig

Konfiguracja wymagań dotyczących kreacji dla produktu.

Zapis JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Pola
creativeType

enum (CreativeType)

Typ kreacji. Wymagane.
dimensionCreativeConfig

object (DimensionCreativeConfig)

Konfiguracja kreacji displayowych.

To pole nie jest obsługiwane w przypadku kreacji natywnych (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

Konfiguracja kreacji wideo.

CreativeType

Możliwe typy kreacji.

Wartości w polu enum
CREATIVE_TYPE_UNSPECIFIED Nieokreślony typ kreacji. Nieprawidłowa wartość wejściowa.
CREATIVE_TYPE_DISPLAY Typ kreacji displayowej.
CREATIVE_TYPE_VIDEO Typ kreacji wideo.
CREATIVE_TYPE_AUDIO Typ kreacji audio.
CREATIVE_TYPE_NATIVE Typ kreacji natywnej.

DimensionCreativeConfig

Wymiary kreacji displayowej w pikselach.

Zapis JSON 
{
  "width": integer,
  "height": integer
}
Pola
width

integer

Szerokość kreacji displayowej. Wymagane.
height

integer

Wysokość kreacji displayowej. Wymagane.

DurationCreativeConfig

Konfiguracja kreacji w zakresie czasu trwania.

Zapis JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Pola
duration

string (Duration format)

Czas trwania kreacji wideo w sekundach. Wymagane

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
durationMatchType

enum (DurationMatchType)

Okres obowiązywania jest zgodny z kryteriami.
skippableMatchType

enum (SkippableMatchType)

Typ kreacji wideo, którą można pominąć.

DurationMatchType

Możliwe formaty kryterium dopasowania czasu trwania.

Wartości w polu enum
DURATION_MATCH_TYPE_UNSPECIFIED Kryterium dopasowania czasu trwania nie jest określone lub jest nieznane w tej wersji. Nieprawidłowa wartość wejściowa.
DURATION_MATCH_TYPE_EQUAL_TO Czas trwania kreacji musi być taki sam jak wymagany czas trwania.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO Czas trwania kreacji musi być taki sam lub krótszy niż wymagany czas trwania.

SkippableMatchType

Możliwe formaty produktu.

Wartości w polu enum
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Typ możliwości pominięcia nie jest określony lub jest nieznany w tej wersji. Nieprawidłowa wartość wejściowa.
SKIPPABLE_MATCH_TYPE_SKIPPABLE Kreacja musi być możliwa do pominięcia.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE Kreacja nie może być możliwa do pominięcia.
SKIPPABLE_MATCH_TYPE_ANY Kreacja może być możliwa lub niemożliwa do pominięcia.

MakegoodDetails

Konfiguracja szczegółów dotyczących rekompensaty.

Zapis JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
Pola
originalExternalDealId

string

Pierwotny zewnętrzny identyfikator umowy, w przypadku której zgłoszono żądanie rekompensaty. Maksymalnie 100 znaków. Dozwolone znaki to znaki alfanumeryczne, podkreślenie, myślnik i kropka. Wymagane.
reason

string

Uzasadnienie rekompensaty zainicjowanej przez sprzedawcę. Maksymalnie 250 znaków. Wymagane.

CreativeSource

Źródło kreacji, czyli miejsce, z którego będą wyświetlane kreacje.

Wartości w polu enum
CREATIVE_SOURCE_UNSPECIFIED Źródło kreacji nie jest określone lub jest nieznane w tej wersji. Nieprawidłowa wartość wejściowa.
CREATIVE_SOURCE_ADVERTISER Kreacje będą wyświetlane przez DV3.
CREATIVE_SOURCE_PUBLISHER Kreacje będą wyświetlane przez wydawcę. Kreacje hostowane przez wydawcę nie są obecnie obsługiwane. Każda próba ustawienia źródła kreacji na CREATIVE_SOURCE_PUBLISHER zakończy się niepowodzeniem.

AudienceTargetingConfig

Konfiguracja kierowania na odbiorców.

Zapis JSON 
{
  "audienceType": enum (AudienceType)
}
Pola
audienceType

enum (AudienceType)

Typ odbiorców. Wymagane.

AudienceType

Typ odbiorców.

Wartości w polu enum
AUDIENCE_TYPE_UNSPECIFIED Nieokreślony typ odbiorców. Nieprawidłowe dane wejściowe.
AUDIENCE_TYPE_COMMERCE Typ listy odbiorców z list partnerów handlowych.

TargetingCriteria

Określono kryteria kierowania.

Zapis JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Pola
selectedTargetingOptions[]

object (SelectedTargetingOption)

Wybrane opcje.

SelectedTargetingOption

Wybrana opcja lub opcje kierowania dla jednego typu kierowania.

Zapis JSON 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Pola
type

enum (TargetingType)

Typ kierowania powiązany z wybranymi opcjami.
Pole zbiorcze value. Można uwzględnić tylko 1 typ wyboru. Wybrana opcja musi odpowiadać wartości TargetingType wybranej w polu „type”. value może mieć tylko jedną z tych wartości:
audienceSelection

object (AudienceSelection)

Wybrana grupa odbiorców.
targetingSelection

object (TargetingSelection)

Ogólny zestaw identyfikatorów wybranych opcji.

TargetingType

Typy kierowania.

Wartości w polu enum
TARGETING_TYPE_UNSPECIFIED Nieokreślony typ kierowania, nieprawidłowy dla danych wejściowych.
TARGETING_TYPE_AUDIENCE Odbiorcy typu kierowania.
TARGETING_TYPE_COUNTRY Kraj typu kierowania.
TARGETING_TYPE_DMA Typ kierowania dma.
TARGETING_TYPE_PROGRAMMER Programista typu kierowania.
TARGETING_TYPE_BRAND Typ kierowania: marka.
TARGETING_TYPE_CONTENT_GENRE Typ kierowania: gatunek treści.
TARGETING_TYPE_DEVICE Urządzenie typu kierowania.
TARGETING_TYPE_OPERATING_SYSTEM Typ kierowania: system operacyjny.
TARGETING_TYPE_RATING Ocena typu kierowania.
TARGETING_TYPE_ENVIRONMENT Środowisko typu kierowania.
TARGETING_TYPE_LANGUAGE Język typu kierowania.
TARGETING_TYPE_GEO Typ kierowania geograficznego.
TARGETING_TYPE_AGE Typ kierowania: wiek.
TARGETING_TYPE_GENDER Typ kierowania na płeć.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segment kontekstowy typu kierowania.
TARGETING_TYPE_REQUEST_FORMAT Format żądania typu kierowania.
TARGETING_TYPE_PUBLISHER Typ kierowania wydawcy.
TARGETING_TYPE_INVENTORY_SIZE Rozmiar typu kierowania.
TARGETING_TYPE_NETWORK Sieć typu kierowania.
TARGETING_TYPE_PLATFORM Platforma typu kierowania.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Typ wyświetlania reklamy wideo typu kierowania.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Minimalny rozmiar odtwarzacza wideo w przypadku typu kierowania.

AudienceSelection

Wybrane opcje kierowania na odbiorców.

Zapis JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Pola
includedOrGroups[]

object (OrGroup)

Uwzględnione opcje są połączone operatorem AND. Każda z nich może być pojedynczą opcją lub grupą opcji połączonych operatorem OR.
excludedOptionIds[]

string (int64 format)

Wykluczone opcje są połączone spójnikiem LUB.

OrGroup

Grupa wybranych opcji połączonych operatorem LUB.

Zapis JSON 
{
  "optionIds": [
    string
  ]
}
Pola
optionIds[]

string (int64 format)

Identyfikatory wybranych opcji.

TargetingSelection

Zbiór zawierający co najmniej 1 wybrany identyfikator opcji, który można zastosować w przypadku większości typów kierowania.

Zapis JSON 
{
  "optionIds": [
    string
  ]
}
Pola
optionIds[]

string (int64 format)

Identyfikatory wybranych opcji.

ForecastResult

Określono wynik prognozy.

Zapis JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Pola
forecasts[]

object (Forecast)

Prognoza. Wartość „forecastCategory” musi być niepowtarzalna dla każdego określonego elementu.

Prognoza

Prognoza określonej kategorii prognozy.

Zapis JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Pola
forecastCategory

enum (ForecastCategory)

Określona kategoria prognozy, którą reprezentuje statystyka prognozy.
Pole zbiorcze forecast_data. Można uwzględnić tylko 1 typ danych statystycznych. Wypełnione dane muszą odpowiadać polu „forecastCategory”. forecast_data może mieć tylko jedną z tych wartości:
number

string (int64 format)

Dane liczbowe.
percentage

integer

Dane procentowe.
cpmPrice

object (Money)

dane o cenie CPM,
cpmRange

object (CpmRange)

dane dotyczące zakresu cen CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Dane zestawienia prognoz.

ForecastCategory

Kategoria prognozy.

Wartości w polu enum
FORECAST_CATEGORY_UNSPECIFIED Kategoria nieokreślona. Nieprawidłowe dane wejściowe.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Łączna liczba możliwości. Dane liczbowe.
FORECAST_CATEGORY_TOTAL_AUDIENCE Łączna liczba odbiorców. Dane liczbowe.
FORECAST_CATEGORY_DIGITAL_TRP Wskaźnik wyświetleń w grupie docelowej w przypadku treści cyfrowych. Dane procentowe.
FORECAST_CATEGORY_SUGGESTED_CPM Sugerowana stawka CPM. zakres CPM lub dane o cenie CPM.
FORECAST_CATEGORY_UNIQUE_REACH Prognozowanie zasięgu wśród unikalnych użytkowników. Dane liczbowe.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Zestawienie prognoz. Dane zestawienia prognoz.

CpmRange

Zakres CPM zawiera minimalną i maksymalną wartość CPM.

Zapis JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Pola
minCpm

object (Money)

Dolna granica zakresu CPM.
maxCpm

object (Money)

Górna granica zakresu CPM.

ForecastBreakdownData

Dane zestawienia prognoz zawierają listę zestawień prognoz.

Zapis JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Pola
forecastBreakdowns[]

object (ForecastBreakdown)

Lista zestawień prognoz.

ForecastBreakdown

Szczegółowa prognoza dla wybranej opcji kierowania.

Zapis JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Pola
selectedTargetingOption

object (SelectedTargetingOption)

Wybrana opcja lub opcje kierowania dla jednego typu kierowania.
Pole zbiorcze breakdown_data. Można uwzględnić tylko 1 rodzaj danych podziału. breakdown_data może mieć tylko jedną z tych wartości:
impressions

string (int64 format)

prognozować wyświetlenia,

ErrorDetails

Szczegóły błędu są podawane, gdy aktualizacja zawiera błędy.

Zapis JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Pola
message

string

Wiadomość określa, kiedy aktualizacja zawiera błędy.
instantDealErrorStatus

enum (InstantDealErrorStatus)

Stan błędu określony, gdy aktualizacja zawiera błędy dotyczące ofert błyskawicznych.

InstantDealErrorStatus

Stan błędu określony, gdy aktualizacja oferty natychmiastowej zawiera błędy.

Wartości w polu enum
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Nieokreślony stan błędu.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Stan błędu oznacza, że zasoby reklamowe są niedostępne.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Stan błędu oznacza, że prognoza jest niedostępna.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Stan błędu oznacza, że występują nieprawidłowe pola wejściowe.

FrequencyCap

Liczba wyświetleń tej samej reklamy użytkownikowi w danym okresie.

Zapis JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Pola
timeUnit

enum (TimeUnit)

Jednostka czasu, w której będzie stosowany limit wyświetleń na użytkownika.
maxImpressions

string (int64 format)

Maksymalna liczba wyświetleń tej samej reklamy użytkownikowi w tym okresie.

TimeUnit

Jednostka czasu, w której będzie stosowany limit wyświetleń na użytkownika.

Wartości w polu enum
TIME_UNIT_UNSPECIFIED Nieokreślona jednostka czasu.
TIME_UNIT_LIFETIME Limit wyświetleń na użytkownika będzie obowiązywać przez cały okres.
TIME_UNIT_MONTHS Limit wyświetleń na użytkownika będzie stosowany przez określoną liczbę miesięcy.
TIME_UNIT_WEEKS Limit wyświetleń na użytkownika będzie stosowany przez kilka tygodni.
TIME_UNIT_DAYS Limit wyświetleń na użytkownika będzie obowiązywać przez określoną liczbę dni.

Metody

create

 Tworzy produkt.

get

 Pobiera produkt.

list

 Wyświetla produkt.

patch

 Aktualizuje produkt.