- Zasób: produkt
- CreativeConfig
- CreativeType
- DimensionCreativeConfig
- DurationCreativeConfig
- DurationMatchType
- SkippableMatchType
- MakegoodDetails
- CreativeSource
- AudienceTargetingConfig
- AudienceType
- TargetingCriteria
- SelectedTargetingOption
- TargetingType
- AudienceSelection
- OrGroup
- TargetingSelection
- ForecastResult
- Prognoza
- ForecastCategory
- CpmRange
- ForecastBreakdownData
- ForecastBreakdown
- ErrorDetails
- InstantDealErrorStatus
- FrequencyCap
- TimeUnit
- Metody
Zasób: produkt
Produkt
| Zapis JSON |
|---|
{ "name": string, "displayName": string, "externalDealId": string, "transactionType": enum ( |
| Pola | |
|---|---|
name |
Względna nazwa zasobu produktu. Generowany przez serwer. Przykład: „exchanges/1234/orders/5678/products/abc”. Tylko dane wyjściowe. |
displayName |
Wyświetlana nazwa usługi. Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów. Wymagane. |
externalDealId |
Identyfikator zewnętrzny. Jest to identyfikator umowy w systemie giełdy. Maksymalnie 100 znaków. Dozwolone znaki to znaki alfanumeryczne, podkreślenia, łączniki i kropki. Musi być unikalny wśród wszystkich produktów. Wymagane. |
transactionType |
Typ transakcji dotyczącej produktu. Wymagane. |
pricingType |
Typ ceny produktu. Wymagane. |
updateTime |
Sygnatura czasowa określająca, kiedy produkt został ostatnio zaktualizowany. 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: |
startTime |
Czas, kiedy 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: |
endTime |
Czas, kiedy ta usługa stanie się nieaktywna. Nie może przypadać później niż w 2036 roku. 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: |
rateDetails |
Szczegóły oceny. Wymagane. |
creativeConfig[] |
Wymagania dotyczące kreacji dla produktu. Wymagane w przypadku typu transakcji zarezerwowanej. |
makegood |
Wskazuje, czy produkt jest produktem rekompensaty. |
makegoodDetails |
Szczegóły rekompensaty za produkt. Wymagane, gdy produkt jest rekompensatą. |
creativeSource |
Źródło kreacji produktu. Opcjonalne, domyślnie CREATIVE_SOURCE_ADVERTISER. Po utworzeniu produktu nie można go zmienić. |
mediumType |
Typ nośnika produktu. Jeśli nie zostanie określona, domyślnie przyjmuje wartość DIGITAL, aby zapewnić zgodność wsteczną. Po utworzeniu produktu nie można go zmienić. |
audienceTargetingConfig |
Opcjonalnie: Konfiguracja kierowania na odbiorców zastosowana na poziomie umowy na giełdzie. |
targetingCriteria |
Tylko dane wyjściowe. Informacje o kryteriach kierowania na produkt. Dotyczy to tylko scenariuszy umów błyskawicznych. |
forecastResult |
Wyniki prognozy dotyczącej produktu. Wymagane, gdy kryteria kierowania nie są puste i nie podano prognozy. Dotyczy to tylko scenariuszy umów błyskawicznych. |
errorDetails |
Jeśli nie można zaktualizować konkretnych pól usługi, należy podać szczegóły błędu. Wymagane, gdy nie można podać wyniku prognozy z powodu kryterium kierowania lub nie można zaktualizować usługi. Dotyczy to tylko scenariuszy umów błyskawicznych. |
frequencyCap |
Tylko dane wyjściowe. Limit wyświetleń na użytkownika wybrany przez kupującego. Dotyczy to tylko scenariuszy umów błyskawicznych. |
program |
Tylko dane wyjściowe. Program, w ramach którego kupujący utworzył umowę błyskawiczną. Pozostaw puste w przypadku zwykłego przepływu wymiany. Dotyczy to tylko scenariuszy umów błyskawicznych. |
buyerCustomParameters |
Tylko dane wyjściowe. Niestandardowe parametry pary klucz-wartość ustawione przez kupującego w żądaniu umowy błyskawicznej. Dotyczy to tylko scenariuszy umów błyskawicznych. Obiekt zawierający listę par |
etag |
Element 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 umów błyskawicznych. |
CreativeConfig
Konfiguracja wymagań dotyczących kreacji dla usługi.
| Zapis JSON |
|---|
{ "creativeType": enum ( |
| Pola | |
|---|---|
creativeType |
Typ kreacji. Wymagane. |
dimensionCreativeConfig |
Konfiguracja kreacji displayowych. To pole nie jest obsługiwane w przypadku kreacji natywnych (CREATIVE_TYPE_NATIVE). |
durationCreativeConfig |
Konfiguracja kreacji wideo. |
CreativeType
Możliwe typy kreacji.
| Wartości w polu enum | |
|---|---|
CREATIVE_TYPE_UNSPECIFIED |
Nie określono typu 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. Nie jest to obsługiwane w przypadku produktów typu transakcji RESERVED. |
DimensionCreativeConfig
Wymiary kreacji displayowej w pikselach.
| Zapis JSON |
|---|
{ "width": integer, "height": integer } |
| Pola | |
|---|---|
width |
Szerokość kreacji displayowej. Wymagane. |
height |
Wysokość kreacji displayowej. Wymagane. |
DurationCreativeConfig
Konfiguracja czasu trwania kreacji.
| Zapis JSON |
|---|
{ "duration": string, "durationMatchType": enum ( |
| Pola | |
|---|---|
duration |
Czas trwania kreacji wideo w sekundach. Wymagane Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony literą „ |
durationMatchType |
Kryteria dopasowania czasu trwania. |
skippableMatchType |
Typ kreacji wideo możliwej do pominięcia. |
DurationMatchType
Kryteria dopasowania czasu trwania kreacji wideo.
| 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 jak wymagany czas trwania lub krótszy. |
SkippableMatchType
Kryteria dopasowania określające, czy kreacja wideo jest możliwa do pominięcia.
| Wartości w polu enum | |
|---|---|
SKIPPABLE_MATCH_TYPE_UNSPECIFIED |
Typ reklamy możliwej do 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 rekompensaty.
| Zapis JSON |
|---|
{ "originalExternalDealId": string, "reason": string } |
| Pola | |
|---|---|
originalExternalDealId |
Pierwotny zewnętrzny identyfikator umowy, której dotyczy prośba o rekompensatę. Maksymalnie 100 znaków. Dozwolone znaki to znaki alfanumeryczne, podkreślenia, łączniki i kropki. Wymagane. |
reason |
Powód 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 jest nieokreślone lub 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żde żądanie, które próbuje ustawić źródło kreacji na CREATIVE_SOURCE_PUBLISHER, zakończy się niepowodzeniem. |
AudienceTargetingConfig
Konfiguracja kierowania na odbiorców.
| Zapis JSON |
|---|
{
"audienceType": enum ( |
| Pola | |
|---|---|
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 odbiorców z list partnerów handlowych. |
TargetingCriteria
Określono kryteria kierowania.
| Zapis JSON |
|---|
{
"selectedTargetingOptions": [
{
object ( |
| Pola | |
|---|---|
selectedTargetingOptions[] |
Wybrane opcje. |
SelectedTargetingOption
Wybrane opcje kierowania dla pojedynczego typu kierowania.
| Zapis JSON |
|---|
{ "type": enum ( |
| Pola | |
|---|---|
type |
Typ kierowania powiązany z wybranymi opcjami. |
Można uwzględnić tylko 1 typ wyboru. Wybrana opcja musi odpowiadać wartości TargetingType wybranej w polu type. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
audienceSelection |
Wybrana grupa odbiorców. |
targetingSelection |
Ogólny zestaw identyfikatorów wybranych opcji. |
| Koniec pól wykluczających się wzajemnie. | |
TargetingType
Typy kierowania.
| Wartości w polu enum | |
|---|---|
TARGETING_TYPE_UNSPECIFIED |
Nieokreślony typ kierowania, nieprawidłowy dla danych wejściowych. |
TARGETING_TYPE_AUDIENCE |
Typ kierowania: odbiorcy. |
TARGETING_TYPE_COUNTRY |
Typ kierowania: kraj. |
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 |
Typ kierowania: urządzenie. |
TARGETING_TYPE_OPERATING_SYSTEM |
Typ kierowania: system operacyjny. |
TARGETING_TYPE_RATING |
Ocena typu kierowania. |
TARGETING_TYPE_ENVIRONMENT |
Typ kierowania: środowisko. |
TARGETING_TYPE_LANGUAGE |
Typ kierowania: język. |
TARGETING_TYPE_GEO |
Typ kierowania: lokalizacja geograficzna. |
TARGETING_TYPE_AGE |
Typ kierowania: wiek. |
TARGETING_TYPE_GENDER |
Typ kierowania: płeć. |
TARGETING_TYPE_CONTEXTUAL_SEGMENT |
Segment kontekstowy typu kierowania. |
TARGETING_TYPE_REQUEST_FORMAT |
Format żądania typu kierowania. |
TARGETING_TYPE_PUBLISHER |
Typ kierowania: wydawca. |
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 kierowania: typ wyświetlania reklam wideo. |
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE |
Typ kierowania: minimalny rozmiar odtwarzacza wideo. |
TARGETING_TYPE_VIDEO_COMPLETION |
Typ kierowania: miejsce docelowe reklamy wideo. |
TARGETING_TYPE_VIEWABILITY |
Widoczność typu kierowania. |
TARGETING_TYPE_REWARDED |
Typ kierowania: z nagrodą. |
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC |
Próg czasu trwania reklamy wideo typu kierowania (w sekundach) |
TARGETING_TYPE_VIDEO_PLACEMENT |
Typ kierowania: miejsce docelowe reklamy wideo. |
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD |
Typ kierowania: metoda odtwarzania reklamy wideo. |
TARGETING_TYPE_APP_ID |
Identyfikator aplikacji typu kierowania. |
TARGETING_TYPE_DOMAIN_URL |
Adres URL domeny typu kierowania. |
TARGETING_TYPE_CTR |
Współczynnik klikalności typu kierowania. |
TARGETING_TYPE_DEMOGRAPHICS |
Typ kierowania: dane demograficzne. |
TARGETING_TYPE_RESTRICTED_CATEGORY |
Kategoria objęta ograniczeniami typu kierowania. |
TARGETING_TYPE_AD_POSITION |
Pozycja reklamy według typu kierowania. |
TARGETING_TYPE_DAY_AND_TIME |
Typ kierowania: dzień i godzina. |
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE |
Typ kierowania: odbiorcy marketingu detalicznego. |
AudienceSelection
Wybrane opcje kierowania na odbiorców.
| Zapis JSON |
|---|
{
"includedOrGroups": [
{
object ( |
| Pola | |
|---|---|
includedOrGroups[] |
Uwzględnione opcje są połączone operatorem AND. Każda uwzględniona opcja może być pojedynczą opcją lub grupą opcji połączonych operatorem OR. |
excludedOptionIds[] |
Wykluczone opcje są połączone operatorem LUB. |
OrGroup
Grupa wybranych opcji połączonych operatorem LUB.
| Zapis JSON |
|---|
{ "optionIds": [ string ] } |
| Pola | |
|---|---|
optionIds[] |
Identyfikatory wybranych opcji. |
TargetingSelection
Wybrane i wykluczone opcje kierowania, które mają zastosowanie do większości typów kierowania.
| Zapis JSON |
|---|
{ "optionIds": [ string ], "externalIds": [ string ], "excludedOptionIds": [ string ], "excludedExternalIds": [ string ] } |
| Pola | |
|---|---|
optionIds[] |
Tylko dane wyjściowe. Wybrane identyfikatory opcji kierowania DV3 udostępnione giełdzie. Może być zwracany razem z |
externalIds[] |
Tylko dane wyjściowe. Identyfikatory wybranych opcji kierowania podane przez giełdę. Może być zwracany razem z |
excludedOptionIds[] |
Tylko dane wyjściowe. Identyfikatory wykluczonych opcji kierowania DV3 udostępnione giełdzie. Może być zwracany razem z |
excludedExternalIds[] |
Tylko dane wyjściowe. Identyfikatory wykluczonych opcji kierowania podane przez giełdę. Może być zwracany razem z |
ForecastResult
Określono wynik prognozy.
| Zapis JSON |
|---|
{
"forecasts": [
{
object ( |
| Pola | |
|---|---|
forecasts[] |
Prognoza. Atrybut |
Prognoza
Prognoza określonej kategorii prognozy.
| Zapis JSON |
|---|
{ "forecastCategory": enum ( |
| Pola | |
|---|---|
forecastCategory |
Określona kategoria prognozy, którą reprezentuje statystyka prognozy. |
Można uwzględnić tylko 1 typ danych statystycznych. Wypełnione dane muszą odpowiadać polu forecastCategory. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
number |
Dane liczbowe. |
percentage |
Dane procentowe. |
cpmPrice |
Dane o cenach CPM. |
cpmRange |
Dane o zakresie cen CPM. |
forecastBreakdownData |
Dane zestawienia prognoz. |
| Koniec pól wykluczających się wzajemnie. | |
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 internecie. Dane procentowe. |
FORECAST_CATEGORY_SUGGESTED_CPM |
Sugerowana cena CPM. Zakres CPM lub dane o cenie CPM. |
FORECAST_CATEGORY_UNIQUE_REACH |
prognozować zasięg 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 ( |
| Pola | |
|---|---|
minCpm |
Dolna granica zakresu CPM. |
maxCpm |
Górna granica zakresu CPM. |
ForecastBreakdownData
Dane zestawienia prognoz zawierają listę zestawień prognoz.
| Zapis JSON |
|---|
{
"forecastBreakdowns": [
{
object ( |
| Pola | |
|---|---|
forecastBreakdowns[] |
Lista zestawień prognoz. |
ForecastBreakdown
Zestawienie prognozy dla wybranej opcji kierowania.
| Zapis JSON |
|---|
{
"selectedTargetingOption": {
object ( |
| Pola | |
|---|---|
selectedTargetingOption |
Wybrane opcje kierowania dla pojedynczego typu kierowania. |
| Można uwzględnić tylko 1 rodzaj danych podziału. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: | |
impressions |
Prognozowanie wyświetleń. |
| Koniec pól wykluczających się wzajemnie. | |
ErrorDetails
Szczegóły błędu podane, gdy aktualizacja zawiera błędy.
| Zapis JSON |
|---|
{
"message": string,
"instantDealErrorStatus": enum ( |
| Pola | |
|---|---|
message |
Komunikat wyświetlany, gdy podczas aktualizacji wystąpią błędy. |
instantDealErrorStatus |
Stan błędu określony, gdy aktualizacja zawiera błędy dotyczące umów błyskawicznych. |
InstantDealErrorStatus
Stan błędu określany, gdy podczas aktualizacji umowy błyskawicznej wystąpią błędy.
| Wartości w polu enum | |
|---|---|
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED |
Nieokreślony błąd. |
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE |
Stan błędu wskazuje, ż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 wskazuje, że pola do wprowadzania danych są nieprawidłowe. |
FrequencyCap
Liczba wyświetleń tej samej reklamy użytkownikowi w danym okresie.
| Zapis JSON |
|---|
{
"timeUnit": enum ( |
| Pola | |
|---|---|
timeUnit |
Jednostka czasu, w której będzie stosowany limit wyświetleń na użytkownika. |
maxImpressions |
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 czas. |
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 zostanie zastosowany do określonej liczby tygodni. |
TIME_UNIT_DAYS |
Limit wyświetleń na użytkownika będzie stosowany przez określoną liczbę dni. |
Metody |
|
|---|---|
|
Tworzy produkt. |
|
Pobiera produkt. |
|
Wyświetla listę produktów. |
|
Aktualizuje produkt. |