REST Resource: advertisers.campaigns

Kaynak: Kampanya

Tek bir kampanya.

JSON gösterimi 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
Alanlar
name

string

Yalnızca çıkış. Kampanyanın kaynak adı.
advertiserId

string (int64 format)

Yalnızca çıkış. Kampanyanın ait olduğu reklamverenin benzersiz kimliği.
campaignId

string (int64 format)

Yalnızca çıkış. Kampanyanın benzersiz kimliği. Sistem tarafından atanır.
displayName

string

Zorunlu. Kampanyanın görünen adı.

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

enum (EntityStatus)

Zorunlu. Bu kampanya kapsamındaki kampanya siparişlerinin bütçelerini harcayıp harcayamayacağını ve envanter için teklif verip veremeyeceğini kontrol eder.

  • Kabul edilen değerler ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED ve ENTITY_STATUS_PAUSED'dir.
  • campaigns.create yöntemi için ENTITY_STATUS_ARCHIVED kullanılamaz.
updateTime

string (Timestamp format)

Yalnızca çıkış. Kampanyanın 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".
campaignGoal

object (CampaignGoal)

Zorunlu. Kampanyanın hedefi.
campaignFlight

object (CampaignFlight)

Zorunlu. Kampanyanın planlanan harcaması ve süresi.
frequencyCap

object (FrequencyCap)

Zorunlu. Kampanyanın sıklık sınırı ayarı.

.
campaignBudgets[]

object (CampaignBudget)

Bu kampanyada kullanılabilen bütçelerin listesi.

Bu alan ayarlanmazsa kampanya sınırsız bütçe kullanır.

CampaignGoal

Kampanyanın hedefini kontrol eden ayarlar.

JSON gösterimi 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Alanlar
campaignGoalType

enum (CampaignGoalType)

Zorunlu. Kampanya hedefinin türü.
performanceGoal

object (PerformanceGoal)

Zorunlu. Kampanyanın performans hedefi.

performanceGoalType için kabul edilebilir değerler şunlardır:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

Olası kampanya hedefi türleri.

Sıralamalar
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Bu sürümde hedef değeri belirtilmemiş veya bilinmiyor.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Uygulama yüklemelerini veya etkileşimlerini artırın.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Marka veya ürün bilinirliğini artırma
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Çevrimdışı veya mağazadan satışları artırmak
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Çevrimiçi işlemleri veya ziyaretleri artırmak

PerformanceGoal

Kampanyanın performans hedefini kontrol eden ayarlar.

JSON gösterimi 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
Alanlar
performanceGoalType

enum (PerformanceGoalType)

Zorunlu. Performans hedefinin türü.
Zorunlu. Belirli bir performance_goal_type ile ilişkili performans hedefi değeri. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
performanceGoalAmountMicros

string (int64 format)

Hedef tutar, reklamverenin para biriminin mikro cinsinden.

performanceGoalType aşağıdakilerden biri olduğunda geçerlidir:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Örneğin, 1500000 değeri, para biriminin 1,5 standart birimini ifade eder.
performanceGoalPercentageMicros

string (int64 format)

Hedef yüzdesinin mikrolar cinsinden ondalık gösterimi.

performanceGoalType aşağıdakilerden biri olduğunda geçerlidir:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

Örneğin, 70000 değeri %7'yi (ondalık 0,07) temsil eder.
performanceGoalString

string

Boş olabilen bir temel performans göstergesi (TPG) dizesi. UTF-8 olarak kodlanmalı ve uzunluğu 100 karakteri aşmamalıdır.

performanceGoalType, PERFORMANCE_GOAL_TYPE_OTHER olarak ayarlandığında geçerlidir.
Birbirini dışlayan alanların sonu.

PerformanceGoalType

Olası performans hedefi türleri.

Sıralamalar
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Performans hedefi türü belirtilmemiş veya bu sürümde bilinmiyor.
PERFORMANCE_GOAL_TYPE_CPM Performans hedefi BGBM (bin gösterim başına maliyet) olarak belirlenir.
PERFORMANCE_GOAL_TYPE_CPC Performans hedefi TBM (tıklama başına maliyet) olarak belirlenir.
PERFORMANCE_GOAL_TYPE_CPA Performans hedefi, EBM (işlem başına maliyet) olarak belirlenir.
PERFORMANCE_GOAL_TYPE_CTR Performans hedefi, TO (tıklama oranı) yüzdesi olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_VIEWABILITY Performans hedefi, görüntülenebilirlik yüzdesi olarak belirlenir.
PERFORMANCE_GOAL_TYPE_CPIAVC Performans hedefi, CPIAVC (tamamlandığında dinlenebilir ve görüntülenebilir gösterim başına maliyet) olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_CPE Performans hedefi ETBM (etkileşim başına maliyet) olarak belirlenir.
PERFORMANCE_GOAL_TYPE_CPV Performans hedefi GBM (görüntüleme başına maliyet) olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_CLICK_CVR Performans hedefi, tıklama dönüşümü oranı (tıklama başına dönüşüm sayısı) yüzdesi olarak belirlenir.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Performans hedefi, gösterim dönüşüm oranı (gösterim başına dönüşüm) yüzdesi olarak belirlenir.
PERFORMANCE_GOAL_TYPE_VCPM Performans hedefi, gBGBM (görüntülenebilir bin gösterim başına maliyet) olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_VTR Performans hedefi, YouTube görüntüleme oranı (gösterim başına YouTube görüntüleme sayısı) yüzdesi olarak belirlenir.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Performans hedefi, ses tamamlama oranı (gösterim başına tamamlanan ses dinleme sayısı) yüzdesi olarak belirlenir.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Performans hedefi, videonun tamamını izleme oranı (gösterim başına videonun tamamını izleme sayısı) yüzdesi olarak belirlenir.
PERFORMANCE_GOAL_TYPE_OTHER Performans hedefi "Diğer" olarak ayarlanmış.

CampaignFlight

Kampanyanın planlanan harcamasını ve süresini izleyen ayarlar.

JSON gösterimi 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Alanlar
plannedSpendAmountMicros

string (int64 format)

Kampanyanın belirli bir plannedDates için harcaması beklenen tutar. Bu, reklam yayınını sınırlamaz ancak DV360 kullanıcı arayüzünde harcamayı izlemek için kullanılır.

Tutar mikro cinsindendir. 0'dan büyük veya 0'a eşit olmalıdır. Örneğin, 500000000 değeri, para biriminin 500 standart birimini ifade eder.
plannedDates

object (DateRange)

Zorunlu. Kampanyanın yayınlanması beklenen tarihler. Bunlar, üst reklamverenin saat dilimine göre çözümlenir.

  • Burada belirtilen tarihler, yayını etkilemez. Uyarılar ve bildirimler oluşturmak için kullanılır. Örneğin, herhangi bir alt ekleme siparişinin yayın tarihi bu tarihler aralığının dışındaysa kullanıcı arayüzünde bir uyarı gösterilir.
  • startDate alanı zorunludur ve geçerli tarih veya daha sonraki bir tarih olmalıdır.
  • endDate isteğe bağlıdır. Belirtilmesi durumunda startDate veya daha sonrası olmalıdır.
  • Belirtilen tarihler 2037'den önce olmalıdır.

CampaignBudget

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

JSON gösterimi 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Alanlar
budgetId

string (int64 format)

Kampanya bütçesinin benzersiz kimliği. Sistem tarafından atanır. Yeni bütçeler için ayarlamayın.

campaignBudgets bütçeleri güncellenirken veya bu bütçelere yeni bütçeler eklenirken dahil edilmelidir. Aksi takdirde yeni bir kimlik oluşturulup atanır.
displayName

string

Zorunlu. Bütçenin görünen adı.

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

enum (BudgetUnit)

Zorunlu. Değiştirilemez. Bütçenin para birimi veya gösterim cinsinden mi ölçüleceğini belirtir.
budgetAmountMicros

string (int64 format)

Zorunlu. Bağlı kampanya siparişi segmentlerinin bütçe ayırabileceği toplam tutar.

Tutar mikro cinsindendir. 0'dan büyük olmalıdır. Örneğin, 500000000 değeri, para biriminin 500 standart birimini ifade eder.
dateRange

object (DateRange)

Zorunlu. Kampanya bütçesinin tarih aralığı. Bağlı bütçe segmentlerinin farklı bir tarih aralığı olabilir. Bunlar, üst reklamverenin saat dilimine göre çözümlenir.

Hem startDate hem de endDate, 2037'den önce olmalıdır.
externalBudgetSource

enum (ExternalBudgetSource)

Zorunlu. Bütçenin harici kaynağı.
externalBudgetId

string

Değiştirilemez. Bu bütçeyi harici kaynakta tanımlayan kimlik.

Bu alan ayarlanırsa ve ilgili faturalandırma profilinin fatura ayrıntı düzeyi "Bütçe düzeyi satın alma siparişi" olarak ayarlanırsa bu bütçeye göre yayınlanan tüm gösterimler faturada bu kimliği içerir.

Kampanya kapsamında benzersiz olmalıdır.
invoiceGroupingId

string

Değiştirilemez. Aynı faturaya dahil edilecek bütçeleri gruplandırmak için kullanılan kimlik.

Bu alan ayarlanırsa ve ilgili faturalandırma profilinin fatura düzeyi "Bütçe faturası gruplandırma kimliği" olarak ayarlanırsa aynı invoiceGroupingId'yi paylaşan tüm externalBudgetId aynı faturada gruplandırılır.
prismaConfig

object (PrismaConfig)

Mediaocean Prisma aracı tarafından kullanılacak ek meta veriler.

Mediaocean bütçeleri için gereklidir.

Yalnızca prismaEnabled reklamverenleri için geçerlidir.

ExternalBudgetSource

Kampanya bütçesi segmenti için harici kaynak.

Sıralamalar
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Harici bütçe kaynağı değeri bu sürümde belirtilmemiş veya bilinmiyor.
EXTERNAL_BUDGET_SOURCE_NONE Bütçenin harici kaynağı yok.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Bütçe kaynağı Mediaocean'dır.

PrismaConfig

Mediaocean Prisma aracına özel ayarlar.

JSON gösterimi 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Alanlar
prismaType

enum (PrismaType)

Zorunlu. Prizma türü.
prismaCpeCode

object (PrismaCpeCode)

Zorunlu. Mediaocean Prisma aracındaki alakalı müşteri, ürün ve tahmin kodları.
supplier

string

Zorunlu. Bu bütçeyi ayıran tüzel kişi (TTP, site vb.).

PrismaType

Prisma bütçesi için olası türler.

Sıralamalar
PRISMA_TYPE_UNSPECIFIED Bu sürümde tür belirtilmemiş veya bilinmiyor.
PRISMA_TYPE_DISPLAY Ekran türü.
PRISMA_TYPE_VIDEO Video türü.
PRISMA_TYPE_AUDIO Ses türü.
PRISMA_TYPE_SOCIAL Sosyal tür.
PRISMA_TYPE_FEE Ücret türü.

PrismaCpeCode

Google ödeme merkezi, bu kodun bileşen alanlarında arama ve filtreleme yapmayı destekler.

JSON gösterimi 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Alanlar
prismaClientCode

string

Prizma müşteri kodu.
prismaProductCode

string

Prizma ürün kodu.
prismaEstimateCode

string

Prizma tahmin kodu.

Yöntemler

create

 Yeni bir kampanya oluşturur.

delete

 Kampanyayı kalıcı olarak siler.

get

 Bir kampanya alır.

list

 Bir reklamverendeki kampanyaları listeler.

patch

 Mevcut bir kampanyayı günceller.