REST Resource: exchanges.orders.products

Kaynak: Ürün

Ürün

JSON gösterimi
{
  "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
}
Alanlar
name

string

Ürünün göreli rota adı. Sunucu tarafından oluşturulur. Örnek: "exchanges/1234/orders/5678/products/abc". Yalnızca çıkış.

displayName

string

Ürünün görünen adı.

Maksimum 240 bayt boyutunda ve UTF-8 kodlu olmalıdır. Zorunlu.

externalDealId

string

Harici kimlik. Bu, exchange sistemindeki anlaşma kimliğidir. En fazla 100 karakter. İzin verilen karakterler alfanümerik, alt çizgi, kısa çizgi ve noktadır. Tüm ürünler arasında benzersiz olmalıdır. Zorunlu.

transactionType

enum (TransactionType)

Ürün işlem türü. Zorunlu.

pricingType

enum (PricingType)

Ürünün fiyatlandırma türü. Zorunlu.

updateTime
(deprecated)

string (Timestamp format)

Ürünün en son güncellendiği zaman damgası.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

startTime

string (Timestamp format)

Bu ürünün etkinleşeceği zaman. endTime değerinden önce olmalıdır. Başlangıç saati, 1 yıldan daha uzun bir süre sonra olamaz. Zorunlu.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Bu ürünün devre dışı kalacağı zaman. Şu anda 2036 yılından sonra olamaz. Zorunlu.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

rateDetails

object (RateDetails)

Fiyat ayrıntıları. Zorunlu.

creativeConfig[]

object (CreativeConfig)

Bir ürünün reklam öğesi koşulları. Ayrılmış işlem türü ürün için gereklidir.

makegood
(deprecated)

boolean

Bir ürünün telafi ürünü olup olmadığını gösterir.

makegoodDetails
(deprecated)

object (MakegoodDetails)

Bir ürünün telafi ayrıntıları. Ürün telafi amaçlıysa zorunludur.

creativeSource

enum (CreativeSource)

Bir ürünün reklam öğesi kaynağı. İsteğe bağlıdır, varsayılan olarak CREATIVE_SOURCE_ADVERTISER değerine ayarlanır. Ürün oluşturulduktan sonra değiştirilemez.

mediumType

enum (MediumType)

Ürünün ortam türü. Geriye dönük uyumluluk için belirtilmezse varsayılan olarak DIGITAL değerine ayarlanır. Ürün oluşturulduktan sonra değiştirilemez.

audienceTargetingConfig

object (AudienceTargetingConfig)

İsteğe bağlıdır. Seçilen kitle hedefleme yapılandırması, Exchange'de anlaşma düzeyinde uygulanır.

targetingCriteria

object (TargetingCriteria)

Yalnızca çıkış. Ürün hedefleme ölçütleri referansları. Yalnızca Anlık Fırsat Senaryoları için geçerlidir.

forecastResult

object (ForecastResult)

Ürün tahmini sonuçları. Hedefleme ölçütleri boş olmadığında ve tahmin sağlanmadığında gereklidir. Yalnızca Anlık Fırsat Senaryoları için geçerlidir.

errorDetails

object (ErrorDetails)

Belirli ürün alanları güncellenemediğinde hata ayrıntıları belirtilmelidir. Hedefleme ölçütü nedeniyle tahmin sonucu sağlanamadığında veya üründe güncelleme yapılamadığında gereklidir. Yalnızca Anlık Fırsat Senaryoları için geçerlidir.

frequencyCap

object (FrequencyCap)

Yalnızca çıkış. Alıcı tarafından seçilen sıklık sınırı. Yalnızca Anlık Fırsat Senaryoları için geçerlidir.

etag

string

Bir ürünü güncellerken belirtilmesi gereken bir etiket. Yalnızca etag alanı boş değilse güncelleme için belirtilmesi gerekir. Yalnızca Anlık Fırsat Senaryoları için geçerlidir.

CreativeConfig

Bir ürün için reklam öğesi koşulları yapılandırması.

JSON gösterimi
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Alanlar
creativeType

enum (CreativeType)

Reklam öğesi türü. Zorunlu.

dimensionCreativeConfig

object (DimensionCreativeConfig)

Görüntülü reklam öğelerinin yapılandırması.

Bu alan, doğal reklam öğeleri (CREATIVE_TYPE_NATIVE) için desteklenmez.

durationCreativeConfig

object (DurationCreativeConfig)

Video reklam öğelerinin yapılandırması.

CreativeType

Olası reklam öğesi türleri.

Sıralamalar
CREATIVE_TYPE_UNSPECIFIED Reklam öğesi türü belirtilmedi. Geçerli bir giriş değeri değil.
CREATIVE_TYPE_DISPLAY Görüntülü reklam öğesinin türü.
CREATIVE_TYPE_VIDEO Videonun reklam öğesi türü.
CREATIVE_TYPE_AUDIO Sesli reklam öğesinin türü.
CREATIVE_TYPE_NATIVE Doğal reklam öğesinin reklam öğesi türü.

DimensionCreativeConfig

Piksel cinsinden görüntülü reklam öğesi boyutu.

JSON gösterimi
{
  "width": integer,
  "height": integer
}
Alanlar
width

integer

Görüntülü reklam öğesi genişliği. Zorunlu.

height

integer

Görüntülü reklam öğesi yüksekliği. Zorunlu.

DurationCreativeConfig

Reklam öğesinin süre içindeki yapılandırması.

JSON gösterimi
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Alanlar
duration

string (Duration format)

Video reklam öğesinin saniye cinsinden süresi. Zorunlu

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

durationMatchType

enum (DurationMatchType)

Süre eşleşme ölçütleri.

skippableMatchType

enum (SkippableMatchType)

Video reklam öğesinin atlanabilir türü.

DurationMatchType

Süre eşleşmesi ölçütü için olası biçimler.

Sıralamalar
DURATION_MATCH_TYPE_UNSPECIFIED Süre eşleme ölçütü belirtilmemiş veya bu sürümde bilinmiyor. Geçerli bir giriş değeri değil.
DURATION_MATCH_TYPE_EQUAL_TO Reklam öğesi süresi, gerekli süreyle aynı olmalıdır.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO Reklam öğesi süresi, gerekli süreyle aynı veya daha az olmalıdır.

SkippableMatchType

Bir ürün için olası biçimler.

Sıralamalar
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Atlanabilir türü belirtilmemiş veya bu sürümde bilinmiyor. Geçerli bir giriş değeri değil.
SKIPPABLE_MATCH_TYPE_SKIPPABLE Reklam öğesinin atlanabilir olması gerekir.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE Reklam öğesi atlanabilir olmamalıdır.
SKIPPABLE_MATCH_TYPE_ANY Reklam öğesi atlanabilir veya atlanamayan türde olabilir.

MakegoodDetails

Telafi ayrıntılarının yapılandırması.

JSON gösterimi
{
  "originalExternalDealId": string,
  "reason": string
}
Alanlar
originalExternalDealId

string

İyileştirme isteğinde bulunan orijinal harici anlaşma kimliği. En fazla 100 karakter. İzin verilen karakterler alfanümerik, alt çizgi, kısa çizgi ve noktadır. Zorunlu.

reason

string

Satıcı tarafından başlatılan iyileştirme nedeni. Maks. 250 karakter. Zorunlu.

CreativeSource

Reklam öğesi kaynağı: Reklam öğelerinin yayınlanacağı yer.

Sıralamalar
CREATIVE_SOURCE_UNSPECIFIED Reklam öğesi kaynağı bu sürümde belirtilmemiş veya bilinmiyor. Geçerli bir giriş değeri değil.
CREATIVE_SOURCE_ADVERTISER Reklam öğeleri DV3 tarafından yayınlanır.
CREATIVE_SOURCE_PUBLISHER Reklam öğeleri yayıncı tarafından yayınlanır. Yayıncı tarafından barındırılan reklam öğeleri şu anda desteklenmemektedir. Reklam öğesi kaynağını CREATIVE_SOURCE_PUBLISHER olarak ayarlamaya çalışan tüm istekler başarısız olur.

AudienceTargetingConfig

Kitle hedefleme için yapılandırma.

JSON gösterimi
{
  "audienceType": enum (AudienceType)
}
Alanlar
audienceType

enum (AudienceType)

Kitle türü. Zorunlu.

AudienceType

Kitle türü.

Sıralamalar
AUDIENCE_TYPE_UNSPECIFIED Belirtilmemiş kitle türü. Giriş için geçerli değil.
AUDIENCE_TYPE_COMMERCE Ticari kitle türü.

TargetingCriteria

Belirtilen hedefleme ölçütleri.

JSON gösterimi
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Alanlar
selectedTargetingOptions[]

object (SelectedTargetingOption)

Seçilen seçenekler.

SelectedTargetingOption

Tek bir hedefleme türü için seçilen hedefleme seçeneği veya seçenekleri.

JSON gösterimi
{
  "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.
}
Alanlar
type

enum (TargetingType)

Seçilen seçeneklerle ilişkili hedefleme türü.

value birleşik alanı. Yalnızca bir seçim türü eklenebilir. Seçilen seçenek, "tür" alanı için seçilen TargetingType ile eşleşmelidir. value aşağıdakilerden yalnızca biri olabilir:
audienceSelection

object (AudienceSelection)

Seçilen kitle.

targetingSelection

object (TargetingSelection)

Seçili seçenek kimliklerinin genel kümesi.

TargetingType

Hedefleme türleri.

Sıralamalar
TARGETING_TYPE_UNSPECIFIED Belirtilmeyen hedefleme türü, giriş için geçerli değil.
TARGETING_TYPE_AUDIENCE Hedefleme türü kitle.
TARGETING_TYPE_COUNTRY Hedefleme türü ülke.
TARGETING_TYPE_DMA Hedefleme türü dma.
TARGETING_TYPE_PROGRAMMER Hedefleme türü programcı.
TARGETING_TYPE_BRAND Hedefleme türü markası.
TARGETING_TYPE_CONTENT_GENRE Hedefleme türü içerik türü.
TARGETING_TYPE_DEVICE Hedefleme türü cihaz.
TARGETING_TYPE_OPERATING_SYSTEM Hedefleme türü işletim sistemi.
TARGETING_TYPE_RATING Hedefleme türü derecelendirmesi.
TARGETING_TYPE_ENVIRONMENT Hedefleme türü ortamı.
TARGETING_TYPE_LANGUAGE Hedefleme türü dili.
TARGETING_TYPE_GEO Hedefleme türü coğrafya.
TARGETING_TYPE_AGE Hedefleme türü yaş.
TARGETING_TYPE_GENDER Hedefleme türü cinsiyet.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Hedefleme türü içerik segmenti.
TARGETING_TYPE_REQUEST_FORMAT Hedefleme türü istek biçimi.
TARGETING_TYPE_PUBLISHER Hedefleme türü yayıncı.
TARGETING_TYPE_INVENTORY_SIZE Hedefleme türü boyutu.
TARGETING_TYPE_NETWORK Hedefleme türü ağı.
TARGETING_TYPE_PLATFORM Hedefleme türü platformu.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Hedefleme türü video yayınlama türü.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Hedefleme türü video minimum oynatıcı boyutu.

AudienceSelection

Seçilen kitle hedefleme seçenekleri.

JSON gösterimi
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Alanlar
includedOrGroups[]

object (OrGroup)

Dahil edilen seçenekler VE ile birleştirilir. Her dahil edilen seçenek, tek bir seçenek veya VEYA ile birleştirilmiş bir seçenek grubu olabilir.

excludedOptionIds[]

string (int64 format)

Hariç tutulan seçenekler OR ile birleştirilir.

OrGroup

OR ile birleştirilmiş bir grup seçili seçenek.

JSON gösterimi
{
  "optionIds": [
    string
  ]
}
Alanlar
optionIds[]

string (int64 format)

Seçilen seçenek kimlikleri.

TargetingSelection

Çoğu hedefleme türü için geçerli olan, seçilmiş bir veya daha fazla seçenek kimliğinden oluşan bir grup.

JSON gösterimi
{
  "optionIds": [
    string
  ]
}
Alanlar
optionIds[]

string (int64 format)

Seçilen seçenek kimlikleri.

ForecastResult

Tahmin sonucu belirtildi.

JSON gösterimi
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Alanlar
forecasts[]

object (Forecast)

Tahmin. "forecastCategory", belirtilen her öğe için benzersiz olmalıdır.

Tahmin

Belirtilen tahmin kategorisinin tahmini.

JSON gösterimi
{
  "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.
}
Alanlar
forecastCategory

enum (ForecastCategory)

Tahmin istatistiğinin temsil ettiği belirtilen tahmin kategorisi.

forecast_data birleşik alanı. Yalnızca bir tür istatistik verisi eklenebilir. Doldurulan veriler "forecastCategory" alanına karşılık gelmelidir. forecast_data aşağıdakilerden yalnızca biri olabilir:
number

string (int64 format)

Sayı verileri.

percentage

integer

Yüzde verileri.

cpmPrice

object (Money)

BGBM fiyatı verileri.

cpmRange

object (CpmRange)

BGBM fiyat aralığı verileri.

forecastBreakdownData

object (ForecastBreakdownData)

Tahmin dökümü verileri.

ForecastCategory

Tahmin kategorisi.

Sıralamalar
FORECAST_CATEGORY_UNSPECIFIED Belirtilmemiş kategori. Giriş için geçerli değil.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Toplam fırsat sayısı. Sayı verileri.
FORECAST_CATEGORY_TOTAL_AUDIENCE Toplam kitle. Sayı verileri.
FORECAST_CATEGORY_DIGITAL_TRP Dijital hedef kitlede gösterim puanları. Yüzde verileri.
FORECAST_CATEGORY_SUGGESTED_CPM Önerilen BGBM fiyatı. BGBM aralığı veya BGBM fiyatı verileri.
FORECAST_CATEGORY_UNIQUE_REACH Tekil erişimi tahmin edin. Sayı verileri.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Tahmin dökümü. Tahmin dökümü verileri.

CpmRange

BGBM aralığı, BGBM'nin minimum ve maksimum değerlerini içerir.

JSON gösterimi
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Alanlar
minCpm

object (Money)

BGBM aralığının alt sınırı.

maxCpm

object (Money)

BGBM aralığının üst sınırı.

ForecastBreakdownData

Tahmin dökümü verileri, tahmin dökümünün listesini içerir.

JSON gösterimi
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Alanlar
forecastBreakdowns[]

object (ForecastBreakdown)

Tahmin dökümlerinin listesi.

ForecastBreakdown

Seçilen hedefleme seçeneğinin tahmin dökümü.

JSON gösterimi
{
  "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.
}
Alanlar
selectedTargetingOption

object (SelectedTargetingOption)

Tek bir hedefleme türü için seçilen hedefleme seçeneği veya seçenekleri.

breakdown_data birleşik alanı. Yalnızca bir tür döküm verisi eklenebilir. breakdown_data aşağıdakilerden yalnızca biri olabilir:
impressions

string (int64 format)

Tahmini gösterim sayısı.

ErrorDetails

Güncellemede hatalar olduğunda belirtilen hata ayrıntıları.

JSON gösterimi
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Alanlar
message

string

Güncelleme hataları olduğunda belirtilen mesaj.

instantDealErrorStatus

enum (InstantDealErrorStatus)

Anlık fırsatlar için güncellemede hatalar olduğunda belirtilen hata durumu.

InstantDealErrorStatus

Anlık fırsat güncellemesinde hatalar olduğunda belirtilen hata durumu.

Sıralamalar
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Belirtilmemiş hata durumu.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Hata durumu, envanterin kullanılamadığını gösteriyor.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Hata durumu, tahminin kullanılamadığını gösterir.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Hata durumu, geçersiz giriş alanları olduğunu gösterir.

FrequencyCap

Belirli bir dönemde bir kullanıcıya aynı reklamın gösterilme sayısı

JSON gösterimi
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Alanlar
timeUnit

enum (TimeUnit)

Sıklık sınırının uygulanacağı zaman birimi.

maxImpressions

string (int64 format)

Bu dönemde bir kullanıcının aynı reklamla karşılaşabileceği maksimum sayı.

TimeUnit

Sıklık sınırının uygulanacağı zaman birimi.

Sıralamalar
TIME_UNIT_UNSPECIFIED Belirtilmemiş zaman birimi.
TIME_UNIT_LIFETIME Sıklık sınırı, tüm kullanım ömrü boyunca uygulanır.
TIME_UNIT_MONTHS Sıklık sınırı birkaç ay boyunca uygulanır.
TIME_UNIT_WEEKS Sıklık sınırı, belirli bir hafta sayısı için uygulanır.
TIME_UNIT_DAYS Sıklık sınırı belirli bir gün sayısına uygulanır.

Yöntemler

create

Ürün oluşturur.

get

Ürünü alır.

list

Ürünü listeler.

patch

Bir ürünü günceller.