REST Resource: advertisers.campaigns

Resource: Campaign

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

string (int64 format)

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

string

Wajib. Nama tampilan kampanye.

Harus berenkode 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 pada 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.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
campaignGoal

object (CampaignGoal)

Wajib. Sasaran kampanye.
campaignFlight

object (CampaignFlight)

Wajib. Pembelanjaan yang direncanakan dan durasi kampanye.
frequencyCap

object (FrequencyCap)

Wajib. Setelan batas frekuensi kampanye.
campaignBudgets[]

object (CampaignBudget)

Daftar anggaran yang tersedia untuk kampanye ini.

Jika kolom ini tidak disetel, 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 penginstalan atau engagement aplikasi.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Meningkatkan awareness terhadap merek atau produk.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Mendorong penjualan offline atau di toko.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Dorong tindakan atau kunjungan online.

PerformanceGoal

Setelan yang mengontrol sasaran performa kampanye.

Representasi JSON 
{
  "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.
}
Kolom
performanceGoalType

enum (PerformanceGoalType)

Wajib. Jenis sasaran performa.
Kolom union performance_goal_value. Wajib. Nilai sasaran performa yang sesuai dengan performance_goal_type tertentu. performance_goal_value hanya dapat berupa salah satu dari hal berikut:
performanceGoalAmountMicros

string (int64 format)

Jumlah sasaran, dalam mikro mata uang pengiklan.

Berlaku jika performanceGoalType adalah salah satu dari:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Misalnya, 1500000 mewakili 1,5 unit standar mata uang.
performanceGoalPercentageMicros

string (int64 format)

Representasi desimal persentase sasaran dalam mikro.

Berlaku jika performanceGoalType adalah salah satu dari:

  • 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

Misalnya, 70000 mewakili 7% (desimal 0,07).
performanceGoalString

string

String indikator performa utama (KPI), yang bisa kosong. Harus berenkode UTF-8 dengan panjang tidak lebih dari 100 karakter.

Berlaku jika performanceGoalType ditetapkan ke PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

Kemungkinan jenis sasaran performa.

Enum
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Jenis sasaran performa tidak ditentukan atau tidak diketahui dalam versi ini.
PERFORMANCE_GOAL_TYPE_CPM Sasaran performa ditetapkan dalam CPM (biaya per seribu tayangan).
PERFORMANCE_GOAL_TYPE_CPC Sasaran performa ditetapkan dalam CPC (biaya per klik).
PERFORMANCE_GOAL_TYPE_CPA Sasaran performa ditetapkan dalam CPA (biaya per tindakan).
PERFORMANCE_GOAL_TYPE_CTR Sasaran performa ditetapkan dalam persentase CTR (rasio klik-tayang).
PERFORMANCE_GOAL_TYPE_VIEWABILITY Sasaran performa ditetapkan dalam persentase Keterlihatan.
PERFORMANCE_GOAL_TYPE_CPIAVC Sasaran performa ditetapkan sebagai CPIAVC (biaya per tayangan yang terdengar dan terlihat saat penyelesaian).
PERFORMANCE_GOAL_TYPE_CPE Sasaran performa ditetapkan dalam CPE (biaya per engagement).
PERFORMANCE_GOAL_TYPE_CPV Sasaran performa ditetapkan dalam CPV (biaya per penayangan).
PERFORMANCE_GOAL_TYPE_CLICK_CVR Sasaran performa ditetapkan dalam persentase rasio konversi klik (konversi per klik).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Sasaran performa ditetapkan dalam persentase rasio konversi tayangan iklan (konversi per tayangan iklan).
PERFORMANCE_GOAL_TYPE_VCPM Sasaran performa ditetapkan dalam VCPM (biaya per seribu tayangan terlihat).
PERFORMANCE_GOAL_TYPE_VTR Sasaran performa ditetapkan dalam persentase rasio penayangan YouTube (penayangan YouTube per tayangan iklan).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Sasaran performa ditetapkan dalam persentase rasio penyelesaian audio (pemutaran audio lengkap per tayangan iklan).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Sasaran performa ditetapkan dalam persentase rasio penyelesaian video (penayangan video lengkap per tayangan iklan).
PERFORMANCE_GOAL_TYPE_OTHER Sasaran performa ditetapkan ke Lainnya.

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 tertentu. Tindakan ini tidak akan membatasi penayangan, tetapi akan digunakan untuk melacak pembelanjaan di UI DV360.

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

object (DateRange)

Wajib. Tanggal kampanye diperkirakan akan berjalan. Waktu tersebut diselesaikan relatif terhadap zona waktu pengiklan induk.

  • Tanggal yang ditentukan di sini tidak akan memengaruhi penayangan. Data ini digunakan untuk membuat pemberitahuan dan peringatan. Misalnya, jika tanggal penerbangan pesanan pemasangan materi iklan anak berada di luar rentang tanggal ini, antarmuka pengguna akan menampilkan peringatan.
  • startDate wajib diisi dan harus berupa tanggal saat ini atau setelahnya.
  • endDate bersifat opsional. Jika ditentukan, harus startDate atau setelahnya.
  • Tanggal yang ditentukan harus sebelum tahun 2037.

CampaignBudget

Setelan yang mengontrol cara alokasi anggaran kampanye.

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 ditetapkan 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 berenkode 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 perjanjian 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 tertaut mungkin memiliki rentang tanggal yang berbeda. Waktu tersebut diselesaikan relatif terhadap 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 disetel dan tingkat detail invoice dari profil penagihan yang sesuai disetel ke "PO tingkat anggaran", semua tayangan iklan yang ditayangkan terhadap anggaran ini akan menyertakan ID ini pada invoice.

Harus unik dalam kampanye.
invoiceGroupingId

string

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

Jika kolom ini disetel dan tingkat invoice profil penagihan yang sesuai disetel ke "ID pengelompokan invoice anggaran", semua externalBudgetId yang memiliki 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 yang mengalokasikan anggaran ini (DSP, situs, dll.).

PrismaType

Kemungkinan jenis 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 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

create

 Membuat kampanye baru.

delete

 Menghapus kampanye secara permanen.

get

 Mendapatkan kampanye.

list

 Mencantumkan kampanye di pengiklan.

listAssignedTargetingOptions

 Mencantumkan opsi penargetan yang ditetapkan dari kampanye di berbagai jenis penargetan.

patch

 Memperbarui kampanye yang ada.