REST Resource: advertisers.insertionOrders

Resource: LinkingOrder

Satu perjanjian 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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
Kolom
name

string

Hanya output. Nama resource perjanjian pemasangan iklan.

advertiserId

string (int64 format)

Hanya output. ID unik pengiklan yang memiliki perjanjian pemasangan iklan.

campaignId

string (int64 format)

Wajib. Tidak dapat diubah. ID unik kampanye tempat perjanjian pemasangan iklan berada.

insertionOrderId

string (int64 format)

Hanya output. ID unik pesanan pemasangan iklan. Ditetapkan oleh sistem.

displayName

string

Wajib. Nama tampilan pesanan pemasangan iklan.

Harus dienkode UTF-8 dengan ukuran maksimum 240 byte.

insertionOrderType

enum (InsertionOrderType)

Jenis pesanan pemasangan iklan.

Jika kolom ini tidak ditentukan dalam pembuatan, nilainya akan ditetapkan secara default ke RTB.

entityStatus

enum (EntityStatus)

Wajib. Mengontrol apakah perjanjian pemasangan iklan dapat membelanjakan anggaran dan mengajukan bid untuk inventaris atau tidak.

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

string (Timestamp format)

Hanya output. Stempel waktu saat perjanjian pemasangan iklan 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".

partnerCosts[]

object (PartnerCost)

Biaya partner yang terkait dengan perjanjian pemasangan iklan.

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

pacing

object (Pacing)

Wajib. Setelan kecepatan pembelanjaan anggaran untuk perjanjian pemasangan iklan.

frequencyCap

object (FrequencyCap)

Wajib. Setelan pembatasan frekuensi pesanan pemasangan iklan.

integrationDetails

object (IntegrationDetails)

Detail integrasi tambahan perjanjian pemasangan iklan.

performanceGoal

object (PerformanceGoal)

Wajib. Sasaran performa perjanjian pemasangan iklan.

budget

object (InsertionOrderBudget)

Wajib. Setelan alokasi anggaran perjanjian pemasangan iklan.

bidStrategy

object (BiddingStrategy)

Strategi bidding perjanjian pemasangan iklan. Secara default, fixedBid telah ditetapkan.

reservationType

enum (ReservationType)

Hanya output. Jenis reservasi pesanan pemasangan iklan.

billableOutcome

enum (BillableOutcome)

Tidak dapat diubah. Hasil perjanjian pemasangan iklan yang dapat ditagih.

Pembelian berbasis hasil tidak digunakan lagi. BILLABLE_OUTCOME_PAY_PER_IMPRESSION adalah satu-satunya nilai yang valid.

InsertionOrderType

Kemungkinan jenis Pesanan Pemasangan Iklan.

Jenis Perjanjian Pemasangan Iklan menentukan setelan dan opsi mana yang berlaku, seperti format iklan atau opsi penargetan.

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED Jenis pesanan pemasangan iklan tidak ditentukan atau tidak diketahui.
RTB Bidding real-time.
OVER_THE_TOP Over-the-top.

InsertionOrderBudget

Setelan yang mengontrol cara anggaran pesanan pemasangan iklan 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)

Jenis otomatisasi yang digunakan untuk mengelola bid dan anggaran untuk perjanjian pemasangan iklan.

Jika kolom ini tidak ditentukan dalam pembuatan, nilainya akan ditetapkan secara default ke INSERTION_ORDER_AUTOMATION_TYPE_NONE.

budgetSegments[]

object (InsertionOrderBudgetSegment)

Wajib. Daftar segmen anggaran. Menggunakan segmen anggaran untuk menentukan anggaran tertentu selama jangka waktu tertentu saat perjanjian pemasangan iklan dijalankan.

InsertionOrderAutomationType

Kemungkinan opsi untuk mengotomatiskan bid dan anggaran perjanjian pemasangan iklan.

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

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 pesanan pemasangan iklan untuk dateRange tertentu. Jumlahnya dalam mikro. Harus lebih besar dari 0. Misalnya, 500000000 mewakili 500 unit standar mata uang.

description

string

Deskripsi segmen anggaran. Kolom ini dapat digunakan untuk memasukkan informasi Pesanan Pembelian (PO) untuk setiap segmen anggaran dan mencetak informasi tersebut di invoice.

Harus berenkode UTF-8.

dateRange

object (DateRange)

Wajib. Setelan tanggal mulai dan akhir segmen anggaran. Penyesuaian ini diselesaikan sesuai dengan zona waktu pengiklan induk.

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

string (int64 format)

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

BillableOutcome

Kemungkinan hasil yang dapat ditagih untuk perjanjian pemasangan iklan.

Enum
BILLABLE_OUTCOME_UNSPECIFIED Hasil yang dapat ditagih tidak ditentukan.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Bayar per tayangan.
BILLABLE_OUTCOME_PAY_PER_CLICK

Bayar per klik.

BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Bayar per tampilan aktif.

Metode

bulkListInsertionOrderAssignedTargetingOptions

Mencantumkan opsi penargetan pesanan pemasangan iklan yang ditetapkan di seluruh jenis penargetan.

create

Membuat pesanan pemasangan iklan baru.

delete

Menghapus pesanan pemasangan iklan.

get

Mendapatkan pesanan pemasangan iklan.

list

Mencantumkan pesanan pemasangan iklan di pengiklan.

patch

Memperbarui pesanan pemasangan iklan yang ada.