REST Resource: advertisers.insertionOrders

Kaynak: Kampanya Siparişi

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)
}
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ı.

Maksimum 240 bayt boyutunda UTF-8 olarak kodlanmış olmalıdır.
insertionOrderType

enum (InsertionOrderType)

Kampanya siparişinin 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 envantere teklif verip veremeyeceğini kontrol eder.

  • insertionOrders.create yöntemi için yalnızca ENTITY_STATUS_DRAFT öğesine izin verilir. Kampanya siparişini etkinleştirmek için insertionOrders.patch yöntemini kullanın ve oluşturulduktan sonra durumu ENTITY_STATUS_ACTIVE olarak güncelleyin.
  • Kampanya siparişi, başka bir durumdan ENTITY_STATUS_DRAFT durumuna geri döndürülemez.
  • Üst kampanyası etkin olmayan 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ük ve en fazla dokuz kesir basamağı olan, 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 eksik 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ı.
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 temsil 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 ayarlıdır.
reservationType

enum (ReservationType)

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

InsertionOrderType

Olası Kampanya Siparişi türleri.

Kampanya Siparişi'nin türü, hangi ayar ve seçeneklerin (ör. reklamların biçimi veya hedefleme seçenekleri) 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

Kampanya siparişinin temel performans göstergesini veya TPG'sini 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'nin türü.
kpiAlgorithmId

string (int64 format)

İsteğe bağlı. KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST ile ilişkili Özel Teklif Algoritması Kimliği. Uygun KPI seçilmezse bu alan yoksayılır.
Birleştirme alanı kpi_value. Zorunlu. TPG'nin değeri. İlgili alan, kpi_type değerine karşılık gelir. kpi_value şunlardan yalnızca biri olabilir:
kpiAmountMicros

string (int64 format)

Reklamverenin para biriminin 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 şunlardan 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. Şifre, 100 karakteri aşmayacak şekilde UTF-8 biçiminde 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 Bu sürümde TPG türü 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 (gösterim başına maliyet tamamlandığında sesli ve görünür).
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) 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, sesin tamamını dinleme oranı (gösterim başına tamamlanmış ses dinleme sayısı) yüzdesidir.
KPI_TYPE_VIDEO_COMPLETION_RATE TPG, videonun tamamını izleme oranı (gösterim başına tamamlanmış 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 TPG, TGBM (tam video görüntüleme başına maliyet) olarak ayarlanır.
KPI_TYPE_TOS10 TPG, ekranda en az 10 saniye boyunca görünme süresi olarak ayarlanır (En az 10 saniye boyunca ekranda olan ö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 ayarlanır.
KPI_TYPE_OTHER TPG 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 birimine mi yoksa gösterime mi dayalı 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ş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 boyunca belirli bir bütçeyi belirtmek için bütçe segmenti kullanın.

InsertionOrderAutomationType

Kampanya siparişi teklifini ve bütçesini otomatik hale getirmek için olası seçenekler.

Sıralamalar
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Kampanya siparişi otomasyon seçeneği belirtilmemiş veya bu sürümde 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 otomatik olarak sahip satır öğelerine 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 yok. Teklif ve bütçe, satır öğesi seviyesinde 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 olunan 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 belirtilen dateRange için harcayacağı bütçe tutarı. Tutar, mikro cinsinden gösterilir. 0'dan büyük olmalıdır. Örneğin, 500000000, 500 standart para 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 yazdırılmasını sağlamak için 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ümlenir.

  • Yeni bütçe segmenti oluştururken hem startDate hem de endDate gelecekte olmalıdır.
  • Geçmişte startDate bulunan mevcut bütçe segmentinde değişken endDate, ancak sabit startDate var.
  • endDate, her ikisi de 2037 yılından önce startDate veya sonraki bir tarih olmalıdır.
campaignBudgetId

string (int64 format)

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

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ürlerinde bir kampanya siparişinin atanan hedefleme seçeneklerini listeler.

patch

 Mevcut bir kampanya siparişini günceller.