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 boyutta UTF-8 olarak kodlanmış 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önteminde ENTITY_STATUS_ARCHIVED'e izin verilmez.
updateTime

string (Timestamp format)

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

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

object (CampaignGoal)

Zorunlu. Kampanyanın hedefi.
campaignFlight

object (CampaignFlight)

Zorunlu. Planlanan harcama ve kampanyanın süresi.
frequencyCap

object (FrequencyCap)

Zorunlu. Kampanyanın sıklık sınırı ayarı.
campaignBudgets[]

object (CampaignBudget)

Bu kampanya için 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

Olası kampanya hedefi 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ırma
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Bir marka veya ürünün bilinirliğini artırma.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Çevrimdışı veya mağazadan satışları artırın.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Çevrimiçi işlemleri veya ziyaretleri artırmak

PerformanceGoal

Bir kampanyanın performans hedefini kontrol eden ayarlar.

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

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
Alanlar
performanceGoalType

enum (PerformanceGoalType)

Zorunlu. Performans hedefinin türü.
Birlik alanı performance_goal_value. Zorunlu. Belirli bir performance_goal_type değerine karşılık gelen performans hedefi değeri. performance_goal_value yalnızca aşağıdakilerden biri olabilir:
performanceGoalAmountMicros

string (int64 format)

Reklamverenin para biriminin mikro 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, %7'yi (ondalık 0,07) temsil eder.
performanceGoalString

string

Boş olabilecek bir temel performans göstergesi (KPI) dizesi. UTF-8 kodlu olmalı ve en fazla 100 karakter uzunluğunda olmalıdır.

performanceGoalType PERFORMANCE_GOAL_TYPE_OTHER olarak ayarlandığında geçerlidir.

PerformanceGoalType

Olası performans hedefi türleri.

Sıralamalar
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Performans hedefi türü bu sürümde belirtilmemiş veya 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) cinsinden 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 sesli ve görünür gösterim başına maliyet) olarak ayarlanmıştı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 belirlenir.
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 (bin görüntülenebilir 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ülemesi) 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 tamamlanan video görüntüleme sayısı) yüzdesi olarak belirlenir.
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 belirtilen 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.

Miktar 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. Bunlar, üst reklamverenin saat dilimine göre çözülür.

  • Burada belirtilen tarihler yayını etkilemez. Bunlar, uyarı ve uyarı oluşturmak için kullanılır. Örneğin, herhangi bir alt kampanya siparişinin uçuş tarihi bu tarih aralığının dışındaysa kullanıcı arayüzünde bir uyarı gösterilir.
  • startDate gereklidir ve geçerli tarih veya daha sonraki bir tarih olmalıdır.
  • endDate isteğe bağlıdır. Belirtilmişse startDate veya sonraki bir sürüm olmalıdır.
  • Belirtilen tarih 2037'den önce olmalıdır.

CampaignBudget

Kampanya bütçesinin nasıl ayrıldığını 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 ayarlanamaz.

campaignBudgets adlı kampanyaya bütçe güncellerken veya bütçe eklerken dahil edilmelidir. Aksi takdirde yeni bir kimlik oluşturulur ve atanır.
displayName

string

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

UTF-8 kodlu olmalı ve en fazla 240 bayt boyutunda olmalıdır.
budgetUnit

enum (BudgetUnit)

Zorunlu. Değişmez. Bütçenin para birimi cinsinden mi yoksa gösterim cinsinden mi ölçüldüğünü belirtir.
budgetAmountMicros

string (int64 format)

Zorunlu. Bağlı kampanya siparişi segmentlerinin bütçelendirebileceğ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 farklı bir tarih aralığı olabilir. Bunlar, üst reklamverenin saat dilimine göre çözülür.

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

enum (ExternalBudgetSource)

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

string

Sabit. Bu bütçeyi harici kaynakta tanımlayan kimlik.

Bu alan ayarlanır ve ilgili faturalandırma profilinin fatura ayrıntı düzeyi "Bütçe düzeyi PO" olarak ayarlanırsa bu bütçeyle sunulan tüm gösterimler faturada bu kimliği içerir.

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

string

Değişmez. Bütçeleri aynı faturaya dahil edilecek şekilde gruplandırmak için kullanılan kimlik.

Bu alan ayarlanmışsa ve ilgili faturalandırma profilinin fatura seviyesi "Bütçe faturası gruplandırma kimliği" olarak ayarlanmışsa aynı invoiceGroupingId'yi paylaşan tüm externalBudgetId'ler 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 reklamveren için geçerlidir.

ExternalBudgetSource

Kampanya bütçesi segmentinin harici kaynağı.

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.

PrismaConfig

Mediaocean Prisma aracına özgü 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 Tür bu sürümde belirtilmemiş veya bilinmiyor.
PRISMA_TYPE_DISPLAY Gösterim türü.
PRISMA_TYPE_VIDEO Video türü.
PRISMA_TYPE_AUDIO Ses türü.
PRISMA_TYPE_SOCIAL Sosyal medya türü.
PRISMA_TYPE_FEE Ücret türü.

PrismaCpeCode

Google Payments Center, bu kodun bileşen alanlarında arama ve filtreleme yapmayı destekler.

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

string

Prisma istemci 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 reklamverenin kampanyalarını listeler.

listAssignedTargetingOptions

 Hedefleme türleri genelinde bir kampanyaya atanan hedefleme seçeneklerini listeler.

patch

 Mevcut bir kampanyayı günceller.