REST Resource: advertisers.insertionOrders

{
  "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)
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (InsertionOrderType)

Kampanya siparişinin türü.

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

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. 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 döndürülemez.
• Üst kampanyası etkin değilse kampanya siparişi ENTITY_STATUS_ACTIVE olarak ayarlanamaz.

string (Timestamp format)

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

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

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.

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

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

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

object (InsertionOrderBudget)

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

object (BiddingStrategy)

Kampanya siparişinin teklif stratejisi. Varsayılan olarak fixedBid ayarlanmıştır.

enum (ReservationType)

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

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 boş olur ve alanı ayarlamaya çalışırsa hata verilir.

{
  "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.
}

enum (KpiType)

Zorunlu. TPG'nin türü.

string (int64 format)

İsteğe bağlı. KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST ile ilişkili Özel Teklif Algoritması Kimliği. Uygun TPG seçilmezse bu alan yoksayılır.

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.

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.

string

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

kpiType değeri KPI_TYPE_OTHER olduğunda geçerlidir.

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

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

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.

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.

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

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, para biriminin 500 standart birimini temsil eder.

string

Bütçe segmenti açıklaması. Her bütçe segmenti için Satın Alma Siparişi bilgilerini girmek ve bu bilgileri faturalara yazdırmak için kullanılabilir.

UTF-8 kodlu olmalıdır.

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 sonraki bir tarih olmalı ve her ikisi de 2037 yılından önce olmalıdır.

string (int64 format)

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