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

Maksimum 240 baytlık bir boyutla kodlanmış UTF-8 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 herhangi bir durumdan ENTITY_STATUS_DRAFT durumuna geri döndürülemez.
  • Üst kampanyası etkin değilse kampanya siparişi ENTITY_STATUS_ACTIVE olarak ayarlanamaz.
updateTime

string (Timestamp format)

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

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, 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ğı ayarlarını 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. fixedBid varsayılan olarak ayarlıdır.

reservationType

enum (ReservationType)

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

billableOutcome

enum (BillableOutcome)

Sabit. Kampanya siparişinin faturalandırılabilir sonucu.

Sonuca dayalı satın alma için destek sonlandırılmıştır. 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 dağıtı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ü.

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ığı belirli bir süre için belirli bir bütçe belirtmek üzere bir 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. 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 belirtilen dateRange için harcayacağı bütçe tutarı. Tutar, mikrosaniye cinsindendir. 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 olarak kodlanmış 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 bütçe segmenti oluştururken hem startDate hem de endDate gelecekte olmalıdır.
  • Geçmişte startDate bulunan mevcut bir bütçe segmentinde değişken endDate ancak sabit startDate var.
  • endDate değeri 2037 yılından önce olmak üzere 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.

BillableOutcome

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

Sıralamalar
BILLABLE_OUTCOME_UNSPECIFIED Belirtilmemiş faturalandırılabilir sonuç.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Gösterim başına ödeme yapın.
BILLABLE_OUTCOME_PAY_PER_CLICK

Tıklama başına ödeme.

BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Aktif görüntüleme başına ödeme yapın.

Yöntemler

bulkListInsertionOrderAssignedTargetingOptions

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

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.