REST Resource: advertisers.insertionOrders

Resource: InsertionOrder

Satu pesanan pemasangan iklan.

Representasi JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
Kolom
name

string

Hanya output. Nama resource perintah penyisipan.
advertiserId

string (int64 format)

Hanya output. ID unik pengiklan yang memiliki perintah penyisipan.
campaignId

string (int64 format)

Wajib. Tidak dapat diubah. ID unik kampanye yang memiliki perintah penyisipan.
insertionOrderId

string (int64 format)

Hanya output. ID unik perintah penyisipan. Ditetapkan oleh sistem.
displayName

string

Wajib. Nama tampilan pesanan pemasangan iklan.

Harus berenkode UTF-8 dengan ukuran maksimum 240 byte.
insertionOrderType

enum (InsertionOrderType)

Opsional. Jenis pesanan pemasangan iklan.

Jika kolom ini tidak ditentukan saat pembuatan, nilai defaultnya adalah RTB.
entityStatus

enum (EntityStatus)

Wajib. Mengontrol apakah perjanjian pemasangan iklan dapat membelanjakan anggarannya dan mengajukan bid pada inventaris.

  • Untuk metode insertionOrders.create, hanya ENTITY_STATUS_DRAFT yang diizinkan. Untuk mengaktifkan pesanan pemasangan iklan, gunakan metode insertionOrders.patch dan perbarui status ke ENTITY_STATUS_ACTIVE setelah pembuatan.
  • Pesanan pemasangan iklan tidak dapat diubah kembali ke status ENTITY_STATUS_DRAFT dari status lainnya.
  • Perintah penyisipan tidak dapat ditetapkan ke ENTITY_STATUS_ACTIVE jika kampanye induknya tidak aktif.
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat pesanan pemasangan terakhir diperbarui. Ditetapkan oleh sistem.

Menggunakan RFC 3339 yang outputnya 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".
partnerCosts[]

object (PartnerCost)

Opsional. Biaya partner yang terkait dengan perjanjian pemasangan iklan.

Jika tidak ada atau kosong dalam metode insertionOrders.create, perjanjian pemasangan iklan yang baru dibuat akan mewarisi biaya partner dari setelan partner.
pacing

object (Pacing)

Wajib. Setelan kecepatan pembelanjaan anggaran perjanjian pemasangan iklan.

pacingType PACING_TYPE_ASAP tidak kompatibel dengan pacingPeriod PACING_PERIOD_FLIGHT.
frequencyCap

object (FrequencyCap)

Wajib. Setelan pembatasan frekuensi pesanan pemasangan iklan.
integrationDetails

object (IntegrationDetails)

Opsional. Detail integrasi tambahan perjanjian pemasangan iklan.
kpi

object (Kpi)

Wajib. Indikator kinerja utama (KPI) perjanjian pemasangan iklan.

Hal ini ditampilkan sebagai "Sasaran" dalam antarmuka Display & Video 360.
budget

object (InsertionOrderBudget)

Wajib. Setelan alokasi anggaran pesanan pemasangan iklan.
bidStrategy

object (BiddingStrategy)

Opsional. Strategi bidding perintah penyisipan. Secara default, fixedBid disetel.
reservationType

enum (ReservationType)

Hanya output. Jenis reservasi pesanan pemasangan iklan.
optimizationObjective

enum (OptimizationObjective)

Opsional. Tujuan pengoptimalan perjanjian pemasangan iklan.

InsertionOrderType

Kemungkinan jenis Perjanjian Pemasangan Iklan.

Jenis Perintah Pemasangan menentukan setelan dan opsi yang berlaku, seperti format iklan atau opsi penargetan.

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED Jenis perjanjian pemasangan iklan tidak ditentukan atau tidak diketahui.
RTB Bidding real-time.
OVER_THE_TOP Berlebihan.

KPI

Setelan yang mengontrol indikator performa utama (KPI) pesanan pemasangan.

Representasi JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
Kolom
kpiType

enum (KpiType)

Wajib. Jenis KPI.
kpiAlgorithmId

string (int64 format)

Opsional. ID Algoritma Bidding Kustom yang terkait dengan KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Kolom ini diabaikan jika KPI yang tepat tidak dipilih.
Kolom union kpi_value. Wajib. Nilai KPI. Kolom yang relevan sesuai dengan kpi_type. kpi_value hanya dapat berupa salah satu dari hal berikut:
kpiAmountMicros

string (int64 format)

Jumlah sasaran, dalam mikro mata uang pengiklan.

Berlaku jika kpiType adalah salah satu dari:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Misalnya: 1500000 mewakili 1,5 unit standar mata uang.
kpiPercentageMicros

string (int64 format)

Representasi desimal persentase sasaran dalam mikro.

Berlaku jika kpiType adalah salah satu dari:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

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

string

String KPI, yang dapat berupa string kosong. Harus berenkode UTF-8 dengan panjang tidak lebih dari 100 karakter.

Berlaku jika kpiType adalah KPI_TYPE_OTHER.

KpiType

Kemungkinan jenis indikator performa utama (KPI).

Enum
KPI_TYPE_UNSPECIFIED Jenis KPI tidak ditentukan atau tidak diketahui dalam versi ini.
KPI_TYPE_CPM KPI-nya adalah CPM (biaya per seribu tayangan).
KPI_TYPE_CPC KPI-nya adalah CPC (biaya per klik).
KPI_TYPE_CPA KPI-nya adalah CPA (biaya per tindakan).
KPI_TYPE_CTR KPI-nya adalah persentase CTR (rasio klik-tayang).
KPI_TYPE_VIEWABILITY KPI-nya adalah Persentase visibilitas.
KPI_TYPE_CPIAVC KPI-nya adalah CPIAVC (biaya per tayangan yang terdengar dan terlihat saat penyelesaian).
KPI_TYPE_CPE KPI-nya adalah CPE (biaya per engagement).
KPI_TYPE_CPV KPI ditetapkan dalam CPV (biaya per tampilan).
KPI_TYPE_CLICK_CVR KPI-nya adalah persentase rasio konversi klik (konversi per klik).
KPI_TYPE_IMPRESSION_CVR KPI-nya adalah persentase rasio konversi tayangan iklan (konversi per tayangan iklan).
KPI_TYPE_VCPM KPI-nya adalah VCPM (biaya per seribu tayangan iklan terlihat).
KPI_TYPE_VTR KPI-nya adalah persentase rasio tontonan YouTube (penayangan YouTube per tayangan).
KPI_TYPE_AUDIO_COMPLETION_RATE KPI-nya adalah persentase rasio penyelesaian audio (pemutaran penuh audio per tayangan iklan).
KPI_TYPE_VIDEO_COMPLETION_RATE KPI-nya adalah persentase rasio penyelesaian video (penayangan video lengkap per tayangan iklan).
KPI_TYPE_CPCL KPI ditetapkan dalam CPCL (biaya per penyelesaian pemutaran audio).
KPI_TYPE_CPCV KPI ditetapkan dalam CPCV (biaya per penyelesaian tampilan video).
KPI_TYPE_TOS10 KPI ditetapkan dalam rasio waktu di layar 10+ detik (Persentase tayangan iklan yang dapat diukur dan tidak dapat dilewati yang ditampilkan di layar selama minimal 10 detik).
KPI_TYPE_MAXIMIZE_PACING KPI ditetapkan untuk memaksimalkan dampak merek sekaligus memprioritaskan pembelanjaan seluruh anggaran.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI ditetapkan dalam nilai tayangan kustom dibagi dengan biaya.
KPI_TYPE_OTHER KPI adalah nilai lain.

InsertionOrderBudget

Setelan yang mengontrol cara anggaran pesanan pemasangan dialokasikan.

Representasi JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Kolom
budgetUnit

enum (BudgetUnit)

Wajib. Tidak dapat diubah. Unit anggaran menentukan apakah anggaran berbasis mata uang atau tayangan.
automationType

enum (InsertionOrderAutomationType)

Opsional. Jenis otomatisasi yang digunakan untuk mengelola bid dan anggaran untuk perintah penyisipan.

Jika kolom ini tidak ditentukan saat pembuatan, nilai defaultnya adalah INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Wajib. Daftar segmen anggaran. Gunakan segmen anggaran untuk menentukan anggaran tertentu selama jangka waktu tertentu pesanan pemasangan iklan berjalan.

InsertionOrderAutomationType

Kemungkinan opsi untuk mengotomatiskan bid dan anggaran pesanan pemasangan.

Enum
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Opsi otomatisasi pesanan pemasangan tidak ditentukan atau tidak diketahui dalam versi ini.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Alokasi anggaran otomatis. Izinkan sistem mengalihkan anggaran secara otomatis ke item baris pemilik untuk mengoptimalkan performa yang ditentukan oleh kpi. Tidak ada otomatisasi pada setelan bid.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Tidak ada otomatisasi bid atau anggaran di tingkat pesanan pemasangan iklan. Bid dan anggaran harus dikonfigurasi secara manual di tingkat item baris.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Izinkan sistem menyesuaikan bid dan mengalihkan anggaran secara otomatis ke item baris pemilik untuk mengoptimalkan performa yang ditentukan oleh kpi.

InsertionOrderBudgetSegment

Setelan yang mengontrol anggaran satu segmen anggaran.

Representasi JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Kolom
budgetAmountMicros

string (int64 format)

Wajib. Jumlah anggaran yang akan dibelanjakan perjanjian pemasangan iklan untuk dateRange tertentu. Jumlahnya dalam mikro. Harus lebih besar dari 0. Misalnya, 500000000 mewakili 500 unit standar mata uang.
description

string

Opsional. Deskripsi segmen anggaran. Kolom ini dapat digunakan untuk memasukkan informasi Pesanan Pembelian untuk setiap segmen anggaran dan mencetak informasi tersebut pada invoice.

Harus berenkode UTF-8.
dateRange

object (DateRange)

Wajib. Setelan tanggal mulai dan akhir segmen anggaran. Waktu tersebut diselesaikan relatif terhadap zona waktu pengiklan induk.

  • Saat membuat segmen anggaran baru, startDate dan endDate harus berada di masa mendatang.
  • Segmen anggaran yang sudah ada dengan startDate di masa lalu memiliki endDate yang dapat diubah, tetapi startDate yang tidak dapat diubah.
  • endDate harus startDate atau yang lebih baru, keduanya sebelum tahun 2037.
campaignBudgetId

string (int64 format)

Opsional. budgetId anggaran kampanye yang menjadi bagian dari segmen anggaran perjanjian pemasangan iklan ini.

OptimizationObjective

Kemungkinan jenis tujuan pengoptimalan.

Enum
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
CONVERSION Prioritaskan tayangan yang meningkatkan penjualan dan konversi.
CLICK Memprioritaskan tayangan yang meningkatkan traffic situs, aplikasi, app store.
BRAND_AWARENESS Memprioritaskan tayangan dengan kualitas tertentu.
CUSTOM Tujuan ditentukan oleh algoritma bidding kustom yang ditetapkan.
NO_OBJECTIVE Tujuan tidak ditentukan. KPI atau strategi bidding apa pun dapat digunakan.

Metode

create

 Membuat perjanjian pemasangan iklan baru.

delete

 Menghapus perjanjian pemasangan iklan.

get

 Mendapatkan pesanan pemasangan iklan.

list

 Mencantumkan perintah penyisipan di pengiklan.

listAssignedTargetingOptions

 Mencantumkan opsi penargetan yang ditetapkan dari perjanjian pemasangan iklan di seluruh jenis penargetan.

patch

 Memperbarui pesanan penayangan yang ada.