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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
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ü.

Oluşturma sırasında bu alan belirtilmemişse değer varsayılan olarak RTB olur.
entityStatus

enum (EntityStatus)

Zorunlu. Kampanya siparişinin, bütçesini ve envanter teklifini harcayıp harcamayacağını 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, diğer durumlardan 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.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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ı.
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ı.
performanceGoal

object (PerformanceGoal)

Zorunlu. Kampanya siparişinin performans hedefi.
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ü.
billableOutcome

enum (BillableOutcome)

Değişmez. Kampanya siparişinin faturalandırılabilir sonucu.

Sonuca dayalı satın alma için destek sonlandırıldı. BILLABLE_OUTCOME_PAY_PER_IMPRESSION, geçerli tek değerdir.

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.

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şinin teklifini ve bütçesini yönetmek için kullanılan otomasyon türü.

Oluşturma sırasında bu alan belirtilmemişse 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 olası 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. performanceGoal 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 performanceGoal 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ı. Tutar, 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ı. Üst reklamverenin saat dilimine göre çözümlenirler.

  • 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şken endDate ancak sabit startDate var.
  • 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.

BillableOutcome

Kampanya siparişi için olası faturalandırılabilir sonuçlar.

Sıralamalar
BILLABLE_OUTCOME_UNSPECIFIED Faturalandırılabilir sonuç belirtilmedi.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Gösterim başına ödeme.
BILLABLE_OUTCOME_PAY_PER_CLICK

Tıklama başına ödeme.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Etkin görüntüleme başına ödeme.

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.