REST Resource: advertisers.campaigns

Referensi: Kampanye

Satu kampanye.

Representasi JSON 
{
  "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)
    }
  ]
}
Kolom
name

string

Hanya output. Nama resource kampanye.
advertiserId

string (int64 format)

Hanya output. ID unik pengiklan yang memiliki kampanye tersebut.
campaignId

string (int64 format)

Hanya output. ID unik kampanye. Ditetapkan oleh sistem.
displayName

string

Wajib. Nama tampilan kampanye.

Harus dienkode UTF-8 dengan ukuran maksimum 240 byte.
entityStatus

enum (EntityStatus)

Wajib. Mengontrol apakah perjanjian pemasangan iklan dalam kampanye ini dapat membelanjakan anggaran dan mengajukan bid untuk inventaris.

  • Nilai yang diterima adalah ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, dan ENTITY_STATUS_PAUSED.
  • Untuk metode campaigns.create, ENTITY_STATUS_ARCHIVED tidak diizinkan.
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat kampanye terakhir diperbarui. Ditetapkan oleh sistem.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
campaignGoal

object (CampaignGoal)

Wajib. Sasaran kampanye.
campaignFlight

object (CampaignFlight)

Wajib. Pembelanjaan dan durasi kampanye yang direncanakan.
frequencyCap

object (FrequencyCap)

Wajib. Setelan batas frekuensi kampanye.
campaignBudgets[]

object (CampaignBudget)

Daftar anggaran yang tersedia untuk kampanye ini.

Jika kolom ini tidak ditetapkan, kampanye akan menggunakan anggaran tak terbatas.

CampaignGoal

Setelan yang mengontrol sasaran kampanye.

Representasi JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Kolom
campaignGoalType

enum (CampaignGoalType)

Wajib. Jenis sasaran kampanye.
performanceGoal

object (PerformanceGoal)

Wajib. Sasaran performa kampanye.

Nilai yang dapat diterima untuk performanceGoalType adalah:

  • 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

Kemungkinan jenis sasaran kampanye.

Enum
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Nilai sasaran tidak ditentukan atau tidak diketahui dalam versi ini.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Mendorong engagement atau penginstalan aplikasi.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Meningkatkan awareness terhadap suatu merek atau produk.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Mendorong penjualan offline atau di toko.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Mendorong tindakan atau kunjungan online.

CampaignFlight

Setelan yang melacak pembelanjaan dan durasi kampanye yang direncanakan.

Representasi JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Kolom
plannedSpendAmountMicros

string (int64 format)

Jumlah yang diperkirakan akan dibelanjakan kampanye untuk plannedDates yang ditentukan. Penetapan ini tidak akan membatasi penayangan, tetapi akan digunakan untuk melacak pembelanjaan di UI DV360.

Jumlahnya dalam mikro. Harus lebih besar atau sama dengan 0. Misalnya, 500000000 mewakili 500 unit standar mata uang.
plannedDates

object (DateRange)

Wajib. Tanggal kampanye diperkirakan akan berjalan. Penyesuaian ini diselesaikan sesuai dengan zona waktu pengiklan induk.

  • Tanggal yang ditentukan di sini tidak akan memengaruhi penayangan. Mereka digunakan untuk menghasilkan pemberitahuan dan peringatan. Misalnya, jika tanggal penayangan perjanjian pemasangan iklan turunan berada di luar rentang tanggal tersebut, antarmuka pengguna akan menampilkan peringatan.
  • startDate wajib ada dan harus berupa tanggal saat ini atau setelahnya.
  • endDate bersifat opsional. Jika ditentukan, ID harus berupa startDate atau yang lebih baru.
  • Setiap tanggal yang ditentukan harus sebelum tahun 2037.

CampaignBudget

Setelan yang mengontrol cara anggaran kampanye dialokasikan.

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

string (int64 format)

ID unik anggaran kampanye. Ditetapkan oleh sistem. Jangan tetapkan untuk anggaran baru.

Harus disertakan saat memperbarui atau menambahkan anggaran ke campaignBudgets. Jika tidak, ID baru akan dibuat dan ditetapkan.
displayName

string

Wajib. Nama tampilan anggaran.

Harus dienkode UTF-8 dengan ukuran maksimum 240 byte.
budgetUnit

enum (BudgetUnit)

Wajib. Tidak dapat diubah. Menentukan apakah anggaran diukur dalam mata uang atau tayangan.
budgetAmountMicros

string (int64 format)

Wajib. Jumlah total yang dapat dianggarkan oleh segmen pesanan pemasangan iklan tertaut.

Jumlahnya dalam mikro. Harus lebih besar dari 0. Misalnya, 500000000 mewakili 500 unit standar mata uang.
dateRange

object (DateRange)

Wajib. Rentang tanggal untuk anggaran kampanye. Segmen anggaran yang ditautkan mungkin memiliki rentang tanggal yang berbeda. Penyesuaian ini diselesaikan sesuai dengan zona waktu pengiklan induk.

startDate dan endDate harus sebelum tahun 2037.
externalBudgetSource

enum (ExternalBudgetSource)

Wajib. Sumber eksternal anggaran.
externalBudgetId

string

Tidak dapat diubah. ID yang mengidentifikasi anggaran ini ke sumber eksternal.

Jika kolom ini ditetapkan dan tingkat detail invoice profil penagihan terkait disetel ke "PO tingkat anggaran", semua tayangan yang ditayangkan berdasarkan anggaran ini akan menyertakan ID ini di invoice.

Harus unik dalam kampanye.
invoiceGroupingId

string

Tidak dapat diubah. ID yang digunakan untuk mengelompokkan anggaran agar disertakan dalam invoice yang sama.

Jika kolom ini ditetapkan dan tingkat invoice profil penagihan yang sesuai disetel ke "ID pengelompokan invoice anggaran", semua externalBudgetId dengan invoiceGroupingId yang sama akan dikelompokkan dalam invoice yang sama.
prismaConfig

object (PrismaConfig)

Metadata tambahan untuk digunakan oleh alat Mediaocean Prisma.

Diperlukan untuk anggaran Mediaocean.

Hanya berlaku untuk pengiklan prismaEnabled.

ExternalBudgetSource

Sumber eksternal untuk segmen anggaran kampanye.

Enum
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Nilai sumber anggaran eksternal tidak ditentukan atau tidak diketahui dalam versi ini.
EXTERNAL_BUDGET_SOURCE_NONE Anggaran tidak memiliki sumber eksternal.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Sumber anggaran adalah Mediaocean.

PrismaConfig

Setelan khusus untuk alat Mediaocean Prisma.

Representasi JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Kolom
prismaType

enum (PrismaType)

Wajib. Jenis Prisma.
prismaCpeCode

object (PrismaCpeCode)

Wajib. Kode klien, produk, dan estimasi yang relevan dari alat Mediaocean Prisma.
supplier

string

Wajib. Entitas mengalokasikan anggaran ini (DSP, situs, dll.).

PrismaType

Jenis yang memungkinkan untuk anggaran Prisma.

Enum
PRISMA_TYPE_UNSPECIFIED Jenis tidak ditentukan atau tidak diketahui dalam versi ini.
PRISMA_TYPE_DISPLAY Jenis tampilan.
PRISMA_TYPE_VIDEO Jenis video.
PRISMA_TYPE_AUDIO Jenis audio.
PRISMA_TYPE_SOCIAL Jenis sosial.
PRISMA_TYPE_FEE Jenis biaya.

PrismaCpeCode

Pusat Pembayaran Google mendukung penelusuran dan pemfilteran pada kolom komponen dalam kode ini.

Representasi JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Kolom
prismaClientCode

string

Kode klien Prisma.
prismaProductCode

string

Kode produk Prisma.
prismaEstimateCode

string

Kode estimasi Prisma.

Metode

bulkListCampaignAssignedTargetingOptions

 Mencantumkan opsi penargetan kampanye yang ditetapkan di seluruh jenis penargetan.

create

 Membuat kampanye baru.

delete

 Menghapus kampanye secara permanen.

get

 Mendapatkan kampanye.

list

 Mencantumkan kampanye di pengiklan.

patch

 Memperbarui kampanye yang ada.