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

UTF-8 olarak kodlanmış ve maksimum 240 bayt boyutunda 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.
  • campaigns.create yöntemi için ENTITY_STATUS_ARCHIVED değerine izin verilmez.
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

Bir 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 edilen 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

Kampanya hedeflerinin olası türleri.

Sıralamalar
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Hedef değeri bu sürümde belirtilmemiş veya bilinmiyor.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Uygulama yüklemelerini veya etkileşimleri artırmak
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Bir markanın veya ürünün bilinirliğini artırma
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Çevrimdışı veya mağazadan satışları artırmak
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Online işlemleri veya ziyaretleri artırmak

PerformanceGoal

Bir 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 için performans hedefi değeri. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
performanceGoalAmountMicros

string (int64 format)

Reklamverenin para biriminin mikro değeri cinsinden hedef tutar.

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

string (int64 format)

Hedef yüzdesinin mikro 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 olarak 0,07) temsil eder.
performanceGoalString

string

Boş bırakılabilen bir temel performans göstergesi (TPG) dizesi. UTF-8 olarak kodlanmış ve en fazla 100 karakter uzunluğunda olmalıdır.

performanceGoalType, PERFORMANCE_GOAL_TYPE_OTHER olarak ayarlandığında geçerlidir.
Birbirini hariç tutan 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) cinsinden belirlenir.
PERFORMANCE_GOAL_TYPE_CPC Performans hedefi, TBM (tıklama başına maliyet) olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_CPA Performans hedefi, EBM (işlem başına maliyet) olarak ayarlanır.
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 ayarlanır.
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 ayarlanır.
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) yüzdesi olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Performans hedefi, gösterim dönüşüm oranı (gösterim başına dönüşüm) yüzdesi olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_VCPM Performans hedefi, GBGBM (görüntülenebilir bin gösterim başına maliyet) cinsinden belirlenir.
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 ayarlanır.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Performans hedefi, ses tamamlanma oranı (gösterim başına tamamlanan ses dinleme sayısı) yüzdesi olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Performans hedefi, videonun tamamını izleme oranı (gösterim başına tamamlanan video görüntüleme sayısı) yüzdesi olarak ayarlanır.
PERFORMANCE_GOAL_TYPE_OTHER Performans hedefi Diğer olarak ayarlanmıştır.

CampaignFlight

Bir 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, yayınlamayı 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, para biriminin 500 standart birimini temsil eder.
plannedDates

object (DateRange)

Zorunlu. Kampanyanın yayınlanmasının beklendiği tarihler. Üst reklamverenin saat dilimine göre çözümlenirler.

  • Burada belirtilen tarihler yayını etkilemez. Uyarılar ve ikazlar oluşturmak için kullanılır. Örneğin, herhangi bir alt kampanya siparişinin yayın tarihi bu tarihlerin aralığı dışındaysa kullanıcı arayüzünde bir uyarı gösterilir.
  • startDate zorunludur ve geçerli tarih veya daha sonraki bir tarih olmalıdır.
  • endDate isteğe bağlıdır. Belirtilirse startDate veya daha sonraki bir tarih olmalıdır.
  • Belirtilen tarih 2037 yılından ö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 için reklam bütçeleri güncellenirken veya eklenirken dahil edilmelidir. Aksi takdirde yeni bir kimlik oluşturulur ve atanır.
displayName

string

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

UTF-8 olarak kodlanmış ve maksimum 240 bayt boyutunda olmalıdır.
budgetUnit

enum (BudgetUnit)

Zorunlu. Değiştirilemez. Bütçenin para birimiyle mi yoksa gösterim sayısıyla mı ö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, para biriminin 500 standart birimini temsil eder.
dateRange

object (DateRange)

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

Hem startDate hem de endDate, 2037 yılından önce olmalıdır.
externalBudgetSource

enum (ExternalBudgetSource)

Zorunlu. Bütçenin harici kaynağıdır.
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üzeyinde satın alma siparişi" olarak ayarlanırsa bu bütçe için 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 değerini 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çe 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ından alınan alakalı müşteri, ürün ve tahmin kodları.
supplier

string

Zorunlu. Bu bütçenin tahsis edildiği varlık (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

Prisma müşteri kodu.
prismaProductCode

string

Prisma ürün kodu.
prismaEstimateCode

string

Prizma tahmin kodu.

Yöntemler

create

 Yeni bir kampanya oluşturur.

delete

 Bir kampanyayı kalıcı olarak siler.

get

 Bir kampanyayı alır.

list

 Bir reklamverendeki kampanyaları listeler.

patch

 Mevcut bir kampanyayı günceller.