REST Resource: advertisers.insertionOrders

Kaynak: InsertionOrder

Tek bir kampanya siparişi.

JSON gösterimi 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
Alanlar
name

string

Yalnızca çıkış. Kampanya siparişinin kaynak adı.
advertiserId

string (int64 format)

Yalnızca çıkış. Kampanya siparişinin ait olduğu reklamverenin benzersiz kimliği.
campaignId

string (int64 format)

Zorunlu. Sabit. Kampanya siparişinin ait olduğu kampanyanın benzersiz kimliği.
insertionOrderId

string (int64 format)

Yalnızca çıkış. Kampanya siparişinin benzersiz kimliği. Sistem tarafından atanır.
displayName

string

Zorunlu. Kampanya siparişinin görünen adı.

UTF-8 kodlu olmalı ve en fazla 240 bayt boyutunda olmalıdır.
insertionOrderType

enum (InsertionOrderType)

Kampanya siparişinin türü.

Bu alan oluşturulurken belirtilmezse değer varsayılan olarak RTB olur.
entityStatus

enum (EntityStatus)

Zorunlu. Kampanya siparişinin bütçesini harcayıp harcayamayacağını ve envanter için teklif verip veremeyeceğini kontrol eder.

  • insertionOrders.create yöntemi için yalnızca ENTITY_STATUS_DRAFT değerine izin verilir. Bir kampanya siparişini etkinleştirmek için insertionOrders.patch yöntemini kullanın ve oluşturduktan sonra durumu ENTITY_STATUS_ACTIVE olarak güncelleyin.
  • Kampanya siparişleri, başka bir durumdan ENTITY_STATUS_DRAFT durumuna geri döndürülemez.
  • Ana kampanyası etkin olmayan bir kampanya siparişi ENTITY_STATUS_ACTIVE olarak ayarlanamaz.
updateTime

string (Timestamp format)

Yalnızca çıkış. Kampanya siparişinin en son güncellendiği zaman damgası. Sistem tarafından atanır.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

Kampanya siparişiyle ilişkili iş ortağı maliyetleri.

insertionOrders.create yönteminde yoksa veya boşsa yeni oluşturulan kampanya siparişi, iş ortağı maliyetlerini iş ortağı ayarlarından devralır.
pacing

object (Pacing)

Zorunlu. Kampanya siparişinin bütçe harcama hızı ayarı.

pacingType PACING_TYPE_ASAP, pacingPeriod PACING_PERIOD_FLIGHT ile uyumlu değildir.
frequencyCap

object (FrequencyCap)

Zorunlu. Kampanya siparişinin sıklık sınırı ayarı.
integrationDetails

object (IntegrationDetails)

Kampanya siparişinin ek entegrasyon ayrıntıları.
kpi

object (Kpi)

Zorunlu. Kampanya siparişinin temel performans göstergesi (KPI).

Bu, Display & Video 360 arayüzünde "Hedef" olarak ifade edilir.
budget

object (InsertionOrderBudget)

Zorunlu. Kampanya siparişinin bütçe ayırma ayarları.
bidStrategy

object (BiddingStrategy)

Kampanya siparişinin teklif stratejisi. Varsayılan olarak fixedBid ayarlanır.
reservationType

enum (ReservationType)

Yalnızca çıkış. Kampanya siparişinin rezervasyon türü.
optimizationObjective

enum (OptimizationObjective)

İsteğe bağlı. Kampanya siparişinin optimizasyon hedefi.

Bu alan yalnızca izin verilenler listesindeki müşteriler tarafından kullanılabilir. Bir müşteri izin verilenler listesinde değilse bu alan null olur ve ayarlama girişimleri hata döndürür.

InsertionOrderType

Olası kampanya siparişi türleri.

Kampanya siparişinin türü, hangi ayar ve seçeneklerin (reklamların biçimi veya hedefleme seçenekleri gibi) geçerli olacağını belirler.

Sıralamalar
INSERTION_ORDER_TYPE_UNSPECIFIED Kampanya siparişi türü belirtilmemiş veya bilinmiyor.
RTB Gerçek zamanlı teklif verme.
OVER_THE_TOP Baypas.

TPG

Bir kampanya siparişinin temel performans göstergesini (TPG) kontrol eden ayarlar.

JSON gösterimi 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
Alanlar
kpiType

enum (KpiType)

Zorunlu. TPG türü.
kpiAlgorithmId

string (int64 format)

İsteğe bağlı. KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST ile ilişkili özel teklif verme algoritması kimliği. Doğru TPG seçilmezse bu alan yoksayılır.
Birlik alanı kpi_value. Zorunlu. TPG'nin değeri. İlgili alan kpi_type değerine karşılık gelir. kpi_value yalnızca aşağıdakilerden biri olabilir:
kpiAmountMicros

string (int64 format)

Reklamverenin para biriminde mikro cinsinden hedef tutar.

kpiType şunlardan biri olduğunda geçerlidir:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Örneğin: 1500000, para biriminin 1,5 standart birimini temsil eder.
kpiPercentageMicros

string (int64 format)

Hedef yüzdesinin mikro cinsinden ondalık gösterimi.

kpiType aşağıdakilerden biri olduğunda geçerlidir:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

Örneğin: 70000, %7'yi (ondalık 0,07) temsil eder.
kpiString

string

Boş olabilecek bir TPG dizesi. UTF-8 kodlu olmalı ve en fazla 100 karakter uzunluğunda olmalıdır.

kpiType KPI_TYPE_OTHER olduğunda geçerlidir.

KpiType

Olası temel performans göstergesi (TPG) türleri.

Sıralamalar
KPI_TYPE_UNSPECIFIED TPG türü bu sürümde belirtilmemiş veya bilinmiyor.
KPI_TYPE_CPM TPG, BGBM'dir (bin gösterim başına maliyet).
KPI_TYPE_CPC TPG, TBM'dir (tıklama başına maliyet).
KPI_TYPE_CPA TPG, EBM'dir (işlem başına maliyet).
KPI_TYPE_CTR TPG, TO (tıklama oranı) yüzdesidir.
KPI_TYPE_VIEWABILITY TPG, görüntülenebilirlik yüzdesidir.
KPI_TYPE_CPIAVC TPG, CPIAVC'dir (bitişte dinlenebilir ve görüntülenebilir gösterim başına maliyet).
KPI_TYPE_CPE TPG, ETBM'dir (etkileşim başına maliyet).
KPI_TYPE_CPV TPG, GBM (görüntüleme başına maliyet) olarak ayarlanır.
KPI_TYPE_CLICK_CVR TPG, tıklama dönüşüm oranı (tıklama başına dönüşüm sayısı) yüzdesidir.
KPI_TYPE_IMPRESSION_CVR TPG, gösterim dönüşüm oranı (gösterim başına dönüşüm sayısı) yüzdesidir.
KPI_TYPE_VCPM TPG, GBGBM'dir (bin görüntülenebilir gösterim başına maliyet).
KPI_TYPE_VTR TPG, YouTube görüntüleme oranı (gösterim başına YouTube görüntüleme sayısı) yüzdesidir.
KPI_TYPE_AUDIO_COMPLETION_RATE TPG, ses tamamlama oranı (gösterim başına tamamlanan ses dinleme sayısı) yüzdesidir.
KPI_TYPE_VIDEO_COMPLETION_RATE TPG, video tamamlanma oranı (gösterim başına tamamlanan video görüntüleme sayısı) yüzdesidir.
KPI_TYPE_CPCL TPG, TBML (tamamlanmış ses dinleme başına maliyet) olarak ayarlanır.
KPI_TYPE_CPCV KPI, TGBM (tamamlanmış video görüntüleme başına maliyet) olarak ayarlanır.
KPI_TYPE_TOS10 TPG, ekranda 10 saniyeden uzun süre gösterilme oranı olarak belirlenir (en az 10 saniye boyunca ekranda gösterilen ölçülebilir, atlanamayan gösterimlerin yüzdesi).
KPI_TYPE_MAXIMIZE_PACING TPG, tüm bütçenin harcanmasına öncelik verirken marka etkisini en üst düzeye çıkaracak şekilde ayarlanır.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST TPG, özel gösterim değerinin maliyete bölünmesiyle belirlenir.
KPI_TYPE_OTHER TPG ise başka bir değerdir.

InsertionOrderBudget

Kampanya siparişi bütçesinin nasıl ayrıldığını kontrol eden ayarlar.

JSON gösterimi 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Alanlar
budgetUnit

enum (BudgetUnit)

Zorunlu. Sabit. Bütçe birimi, bütçenin para birimi tabanlı mı yoksa gösterime dayalı mı olduğunu belirtir.
automationType

enum (InsertionOrderAutomationType)

Kampanya siparişi için teklifi ve bütçeyi yönetmek üzere kullanılan otomasyon türü.

Bu alan oluşturulurken belirtilmezse değer varsayılan olarak INSERTION_ORDER_AUTOMATION_TYPE_NONE olur.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Zorunlu. Bütçe segmentlerinin listesi. Kampanya siparişinin yayınlandığı süre için belirli bir bütçe belirtmek üzere bütçe segmenti kullanın.

InsertionOrderAutomationType

Kampanya siparişi teklifini ve bütçesini otomatikleştirmek için kullanılabilecek seçenekler.

Sıralamalar
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Kampanya siparişi otomasyonu seçeneği bu sürümde belirtilmemiş veya bilinmiyor.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Otomatik bütçe ayırma. kpi tarafından tanımlanan performansı optimize etmek için sistemin bütçeyi sahip satır öğelerine otomatik olarak kaydırmasına izin verin. Teklif ayarlarında otomasyon yoktur.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Kampanya siparişi seviyesinde teklif veya bütçe otomasyonu yoktur. Teklif ve bütçe, satır öğesi düzeyinde manuel olarak yapılandırılmalıdır.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET kpi tarafından tanımlanan performansı optimize etmek için sistemin teklifleri otomatik olarak ayarlamasına ve bütçeyi sahip satır öğelerine kaydırmasına izin verin.

InsertionOrderBudgetSegment

Tek bir bütçe segmentinin bütçesini kontrol eden ayarlar.

JSON gösterimi 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Alanlar
budgetAmountMicros

string (int64 format)

Zorunlu. Kampanya siparişinin belirli bir dateRange için harcayacağı bütçe tutarı. Miktar mikro cinsindendir. 0'dan büyük olmalıdır. Örneğin, 500000000, para biriminin 500 standart birimini temsil eder.
description

string

Bütçe segmenti açıklaması. Her bütçe segmenti için satın alma siparişi bilgilerini girmek ve bu bilgilerin faturalara basılmasını sağlamak amacıyla kullanılabilir.

UTF-8 kodlu olmalıdır.
dateRange

object (DateRange)

Zorunlu. Bütçe segmentinin başlangıç ve bitiş tarihi ayarları. Bunlar, üst reklamverenin saat dilimine göre çözülür.

  • Yeni bir bütçe segmenti oluştururken hem startDate hem de endDate gelecekte olmalıdır.
  • Geçmişte startDate içeren mevcut bir bütçe segmentinde, değiştirilebilir bir endDate ancak değiştirilemez bir startDate bulunur.
  • endDate, startDate veya daha yeni bir sürüm olmalı ve 2037'den önce yayınlanmış olmalıdır.
campaignBudgetId

string (int64 format)

Bu kampanya siparişi bütçe segmentinin parçası olduğu kampanya bütçesinin budgetId değeri.

OptimizationObjective

Olası optimizasyon hedefi türleri.

Sıralamalar
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Bu sürümde tür değeri belirtilmemiş veya bilinmiyor.
CONVERSION Satışları ve dönüşümleri artıran gösterimlere öncelik verin.
CLICK Web sitesi trafiğini, uygulamaları, uygulama mağazalarını artıran gösterimlere öncelik verin.
BRAND_AWARENESS Belirli kalitedeki gösterimlere öncelik verin.
CUSTOM Hedef, atanan özel teklif verme algoritması tarafından tanımlanır.
NO_OBJECTIVE Hedef tanımlanmadı. Herhangi bir TPG veya teklif stratejisi kullanılabilir.

Yöntemler

create

 Yeni bir kampanya siparişi oluşturur.

delete

 Kampanya siparişini siler.

get

 Kampanya siparişi alır.

list

 Bir reklamverendeki kampanya siparişlerini listeler.

listAssignedTargetingOptions

 Hedefleme türleri genelinde bir kampanya siparişinin atanan hedefleme seçeneklerini listeler.

patch

 Mevcut bir kampanya siparişini günceller.