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 olarak kodlanmış olmalıdır.
entityStatus

enum (EntityStatus)

Zorunlu. Bu kampanya kapsamındaki kampanya siparişlerinin bütçelerini harcayıp harcamayacağı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 kullanılamaz.
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ük ve en fazla dokuz kesir basamağı olan, 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. Kampanyanın planlanan harcaması ve 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 bir 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 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şimleri artırın.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Bir marka veya ürünün bilinirliğini artırın.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Çevrimdışı veya mağazadan satışları artırın.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION İnternet üzerinden yapılan işlem veya ziyaretleri artırın.

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ündeki harcamayı izlemek için kullanılır.

Tutar, mikro cinsinden gösterilir. En az "0" olmalıdır. Örneğin, 500000000, 500 standart para birimini temsil 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. Bunlar uyarı oluşturmak için kullanılır. Örneğin, herhangi bir alt kampanya siparişinin yayın tarihi bu tarih aralığının dışındaysa kullanıcı arayüzünde bir uyarı gösterilir.
  • startDate girilmesi zorunludur ve bu tarih geçerli tarih veya daha sonra olmalıdır.
  • endDate isteğe bağlıdır. Belirtilmişse startDate veya sonrası olmalıdır.
  • Belirtilen herhangi bir tarih 2037 yılından önce olmalıdır.

CampaignBudget

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

campaignBudgets adlı projeye bütçe güncellenirken veya bütçe 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 olarak kodlanmış olmalıdır.
budgetUnit

enum (BudgetUnit)

Zorunlu. Sabit. Bütçenin para birimi olarak mı yoksa gösterim olarak mı ölçüldüğünü belirtir.
budgetAmountMicros

string (int64 format)

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

Tutar, mikro cinsinden gösterilir. 0'dan büyük olmalıdır. Örneğin, 500000000, 500 standart para birimini temsil eder.
dateRange

object (DateRange)

Zorunlu. Kampanya bütçesi için tarih aralığı. Bağlı bütçe segmentleri farklı bir tarih aralığına sahip olabilir. Bunlar üst reklamverenin saat dilimine göre çözümlenir.

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

enum (ExternalBudgetSource)

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

string

Sabit. Bu bütçeyi harici kaynağa tanımlayan kimlik.

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

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

string

Sabit. 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 öğeleri aynı faturada gruplandırılır.
prismaConfig

object (PrismaConfig)

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

Mediaocean bütçeleri için gereklidir.

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

ExternalBudgetSource

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

Sıralamalar
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Bu sürümde harici bütçe kaynağı değeri 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 ö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 gelen alakalı müşteri, ürün ve tahmin kodları.
supplier

string

Zorunlu. Bu bütçeyi tüzel kişi tahsis etmiştir (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 Görüntüleme 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 Ödeme Merkezi, bu kodun bileşen alanlarında arama ve filtreleme yapılmasını 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 kampanya alır.

list

 Bir reklamverendeki kampanyaları listeler.

listAssignedTargetingOptions

 Hedefleme türlerinde bir kampanyanın atanan hedefleme seçeneklerini listeler.

patch

 Mevcut bir kampanyayı günceller.