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ış. Ekleme emrinin ait olduğu reklamverenin benzersiz kimliği.
campaignId

string (int64 format)

Zorunlu. Değiştirilemez. Ekleme emrinin 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ı.

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

enum (InsertionOrderType)

İsteğe bağlıdır. Kampanya siparişi türü.

Bu alan oluşturma sırasında 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şi, diğer durumlardan ENTITY_STATUS_DRAFT durumuna geri döndürülemez.
  • Üst kampanyası etkin olmayan bir kampanya siparişi ENTITY_STATUS_ACTIVE olarak ayarlanamaz.
updateTime

string (Timestamp format)

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

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılı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".
partnerCosts[]

object (PartnerCost)

İsteğe bağlıdır. Kampanya siparişiyle ilişkili iş ortağı maliyetleri.

insertionOrders.create yönteminde yoksa veya boşsa yeni oluşturulan kampanya siparişi, iş ortağı ayarlarındaki iş ortağı maliyetlerini 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ğil.
frequencyCap

object (FrequencyCap)

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

object (IntegrationDetails)

İsteğe bağlıdır. Kampanya siparişinin ek entegrasyon ayrıntıları.
kpi

object (Kpi)

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

Bu, Display & Video 360 arayüzünde"Hedef " olarak gösterilir.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

İsteğe bağlıdır. Kampanya siparişinin teklif stratejisi. Varsayılan olarak fixedBid ayarlanır.

budget alanı automationType, INSERTION_ORDER_AUTOMATION_TYPE_BUDGET veya INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET olarak ayarlanırsa kampanya siparişi, bu teklif stratejisini satır öğelerine uygular. Uygulanan bir teklif stratejisi, satır öğesinin enableOptimizedTargeting ayarıyla uyumlu değilse optimize hedefleme ayarı güncellenir.
reservationType

enum (ReservationType)

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

enum (OptimizationObjective)

Zorunlu. Kampanya siparişinin optimizasyon hedefi.

InsertionOrderType

Kampanya siparişinin olası türleri.

Kampanya siparişinin türü, reklamların biçimi veya hedefleme seçenekleri gibi hangi ayarların ve seçeneklerin geçerli olduğunu 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
Alanlar
kpiType

enum (KpiType)

Zorunlu. TPG'nin türü.
kpiAlgorithmId

string (int64 format)

İsteğe bağlıdır. 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.
Zorunlu. TPG'nin değeri. İlgili alan kpi_type ile eşleşir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
kpiAmountMicros

string (int64 format)

Hedef tutar, reklamverenin para biriminin mikro cinsinden.

kpiType aşağıdakilerden 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 mikrolar 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ş olabilen bir TPG dizesi. UTF-8 olarak kodlanmalı ve uzunluğu 100 karakteri aşmamalıdır.

kpiType, KPI_TYPE_OTHER olduğunda geçerlidir.
Birbirini dışlayan alanların sonu.

KpiType

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

Sıralamalar
KPI_TYPE_UNSPECIFIED KPI türü belirtilmemiş veya bu sürümde bilinmiyor.
KPI_TYPE_CPM Temel performans göstergesi BGBM'dir (bin gösterim başına maliyet).
KPI_TYPE_CPC Temel performans göstergesi TPG'dir (tıklama başına maliyet).
KPI_TYPE_CPA Temel performans göstergesi EBM'dir (işlem başına maliyet).
KPI_TYPE_CTR Temel performans göstergesi, TO (tıklama oranı) yüzdesidir.
KPI_TYPE_VIEWABILITY KPI, görüntülenebilirlik yüzdesidir.
KPI_TYPE_CPIAVC TPG, CPIAVC'dir (tamamlandığında 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 KPI, 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 Önemli performans göstergesi, gösterim dönüşüm oranı (gösterim başına dönüşüm sayısı) yüzdesidir.
KPI_TYPE_VCPM Temel performans göstergesi, GBGBM'dir (görüntülenebilir bin 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 tamamlanma oranı (gösterim başına tamamlanan ses dinleme sayısı) yüzdesidir.
KPI_TYPE_VIDEO_COMPLETION_RATE TPG, videonun tamamını izleme oranı (gösterim başına tamamlanan video görüntüleme sayısı) yüzdesidir.
KPI_TYPE_CPCL TPG, CPCL (tamamlanan sesli dinleme başına maliyet) olarak ayarlanır.
KPI_TYPE_CPCV KPI, TGBM (tamamlanan video görüntüleme başına maliyet) olarak ayarlanır.
KPI_TYPE_TOS10 KPI, ekranda 10 saniyeden uzun süre kalma oranı (ölçülebilir, atlanamayan gösterimlerin en az 10 saniye boyunca ekranda kalma yüzdesi) olarak belirlenir.
KPI_TYPE_MAXIMIZE_PACING TPG, bütçenin tamamının harcanmasına öncelik verirken marka etkisini en üst düzeye çıkaracak şekilde ayarlanır.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI, maliyete bölünmüş özel gösterim değeri olarak ayarlanır.
KPI_TYPE_OTHER KPI, başka bir değerdir.

InsertionOrderBudget

Kampanya siparişi bütçesinin nasıl tahsis edileceğini kontrol eden ayarlar.

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

enum (BudgetUnit)

Zorunlu. Değiştirilemez. Bütçe birimi, bütçenin para birimine mi yoksa gösterime mi dayalı olduğunu belirtir.
automationType

enum (InsertionOrderAutomationType)

İsteğe bağlıdır. Kampanya siparişinin teklifini ve bütçesini yönetmek için kullanılan otomasyon türü.

Bu alan oluşturma sırasında 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ştirme için olası seçenekler.

Sıralamalar
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Kampanya siparişi otomasyonu seçeneği belirtilmemiş veya bu sürümde bilinmiyor.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Otomatik bütçe ayırma Sistemin, kpi ile tanımlanan performansı optimize etmek için bütçeyi sahip olunan satır öğelerine otomatik olarak aktarmasına izin verin. Teklif ayarlarında otomasyon yoktur.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Kampanya siparişi düzeyinde 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 Sistemin, teklifleri otomatik olarak ayarlamasına ve bütçeyi sahip olunan satır öğelerine kaydırarak bidStrategy ile tanımlanan performansı optimize etmesine 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 belirtilen dateRange için harcayacağı bütçe tutarı. Tutar mikro cinsindendir. 0'dan büyük olmalıdır. Örneğin, 500000000 değeri, para biriminin 500 standart birimini ifade eder.
description

string

İsteğe bağlıdır. Bütçe segmenti açıklaması. Her bütçe segmenti için satın alma siparişi bilgilerini girmek ve bu bilgilerin faturalara yazdırılmasını sağlamak için kullanılabilir.

UTF-8 olarak kodlanmalıdır.
dateRange

object (DateRange)

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

  • Yeni bir bütçe segmenti oluştururken hem startDate hem de endDate gelecekte olmalıdır.
  • Geçmişte startDate olan mevcut bir bütçe segmentinin değiştirilebilir endDate'si ancak değiştirilemez startDate'si vardır.
  • endDate, 2037'den önce startDate veya sonraki bir tarih olmalıdır.
campaignBudgetId

string (int64 format)

İsteğe bağlıdır. Bu kampanya siparişi bütçe segmentinin parçası olduğu kampanya bütçesinin budgetId.

OptimizationObjective

Optimizasyon hedeflerinin olası türleri.

Sıralamalar
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Tür değeri belirtilmemiş veya bu sürümde bilinmiyor.
CONVERSION Satışları ve dönüşümleri artıran gösterimlere öncelik verin.
CLICK Web sitesi trafiğini, uygulamaları ve 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.

patch

 Mevcut bir kampanya siparişini günceller.