REST Resource: advertisers.lineItems

Resource: LineItem

Item baris tunggal.

Representasi JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}
Kolom
name

string

Hanya output. Nama resource item baris.
advertiserId

string (int64 format)

Hanya output. ID unik pengiklan yang memiliki item baris.
campaignId

string (int64 format)

Hanya output. ID unik kampanye tempat item baris berada.
insertionOrderId

string (int64 format)

Wajib diisi. Tidak dapat diubah. ID unik pesanan pemasangan iklan yang mencakup item baris.
lineItemId

string (int64 format)

Hanya output. ID unik item baris. Ditetapkan oleh sistem.
displayName

string

Wajib diisi. Nama tampilan item baris.

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

enum (LineItemType)

Wajib diisi. Tidak dapat diubah. Jenis item baris.
entityStatus

enum (EntityStatus)

Wajib diisi. Mengontrol apakah item baris dapat membelanjakan anggarannya dan mengajukan bid pada inventaris.

  • Untuk metode lineItems.create, hanya ENTITY_STATUS_DRAFT yang diizinkan. Untuk mengaktifkan item baris, gunakan metode lineItems.patch dan perbarui status menjadi ENTITY_STATUS_ACTIVE setelah pembuatan.
  • Item baris tidak dapat diubah kembali ke status ENTITY_STATUS_DRAFT dari status lainnya.
  • Jika pesanan pemasangan iklan induk item baris tidak aktif, item baris tidak dapat membelanjakan anggarannya meskipun statusnya sendiri adalah ENTITY_STATUS_ACTIVE.
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat item baris terakhir diperbarui. Ditetapkan oleh sistem.

Stempel waktu dalam 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 item baris.

Jika tidak ada atau kosong dalam metode lineItems.create, item baris yang baru dibuat akan mewarisi biaya partner dari pesanan pemasangan iklan induknya.
flight

object (LineItemFlight)

Wajib diisi. Waktu mulai dan berakhir penayangan item baris.
budget

object (LineItemBudget)

Wajib diisi. Setelan alokasi anggaran item baris.
pacing

object (Pacing)

Wajib diisi. Setelan kecepatan pembelanjaan anggaran item baris.
frequencyCap

object (FrequencyCap)

Wajib diisi. Setelan batas frekuensi tayangan item baris.

Kolom maxImpressions di objek setelan ini harus digunakan jika menetapkan batas terbatas.
partnerRevenueModel

object (PartnerRevenueModel)

Wajib diisi. Setelan model pendapatan partner untuk item baris.
conversionCounting

object (ConversionCountingConfig)

Setelan tracking konversi item baris.
creativeIds[]

string (int64 format)

ID materi iklan yang dikaitkan dengan item baris.
bidStrategy

object (BiddingStrategy)

Wajib diisi. Strategi bidding item baris.
integrationDetails

object (IntegrationDetails)

Detail integrasi item baris.
inventorySourceIds[]

string (int64 format)

ID sumber inventaris pribadi yang ditetapkan ke item baris.
targetingExpansion

object (TargetingExpansionConfig)

Setelan penargetan yang dioptimalkan untuk item baris.

Konfigurasi ini hanya berlaku untuk item baris display, video, atau audio yang menggunakan bidding otomatis dan secara positif menargetkan daftar audiens yang memenuhi syarat.
warningMessages[]

enum (LineItemWarningMessage)

Hanya output. Pesan peringatan yang dibuat oleh item baris. Peringatan ini tidak akan memblokir penyimpanan item baris, tetapi sebagian peringatan dapat mencegah dijalankannya item baris tersebut.
mobileApp

object (MobileApp)

Aplikasi seluler yang dipromosikan oleh item baris.

Ini hanya berlaku jika lineItemType adalah LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL atau LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.
reservationType

enum (ReservationType)

Hanya output. Jenis reservasi item baris.
excludeNewExchanges

boolean

Apakah akan mengecualikan bursa baru agar tidak otomatis ditargetkan oleh item baris. Kolom ini bernilai salah (false) secara default.

LineItemType

Kemungkinan jenis item baris.

Jenis item baris menentukan setelan dan opsi yang berlaku, seperti format iklan atau opsi penargetan.

Enum
LINE_ITEM_TYPE_UNSPECIFIED

Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.

Item baris jenis ini dan penargetannya tidak dapat dibuat atau diperbarui menggunakan API.
LINE_ITEM_TYPE_DISPLAY_DEFAULT Iklan gambar, HTML5, native, atau multimedia.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL Iklan Display yang mendorong penginstalan aplikasi.
LINE_ITEM_TYPE_VIDEO_DEFAULT Iklan video yang dijual berdasarkan CPM untuk berbagai lingkungan.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL Iklan video yang mendorong penginstalan aplikasi.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

Iklan Display yang ditayangkan di inventaris aplikasi seluler.

Item baris jenis ini dan penargetannya tidak dapat dibuat atau diperbarui menggunakan API.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

Iklan video yang ditayangkan di inventaris aplikasi seluler.

Item baris jenis ini dan penargetannya tidak dapat dibuat atau diperbarui menggunakan API.
LINE_ITEM_TYPE_AUDIO_DEFAULT Iklan Audio RTB yang dijual untuk berbagai lingkungan.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Iklan di atas yang ada di pesanan pemasangan iklan OTT. Jenis ini hanya berlaku untuk item baris dengan pesanan pemasangan iklan sebesar insertionOrderType OVER_THE_TOP.

LineItemFlight

Setelan yang mengontrol durasi aktif item baris.

Representasi JSON 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}
Kolom
flightDateType

enum (LineItemFlightDateType)

Wajib diisi. Jenis tanggal penayangan item baris.
dateRange

object (DateRange)

Tanggal mulai dan akhir penayangan item baris. Masalah tersebut diselesaikan sesuai dengan zona waktu pengiklan induk.

  • Wajib jika flightDateType adalah LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. Hanya output jika sebaliknya.
  • Saat membuat penerbangan baru, startDate dan endDate harus berada di masa mendatang.
  • Penerbangan yang sudah ada dengan startDate sebelumnya memiliki endDate yang dapat diubah, tetapi startDate yang tidak dapat diubah.
  • endDate harus berupa startDate atau yang lebih baru, keduanya sebelum tahun 2037.
triggerId

string (int64 format)

ID pemicu manual yang dikaitkan dengan item baris.

  • Wajib jika flightDateType adalah LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER. Tidak boleh ditetapkan sebaliknya.
  • Jika ditetapkan, tanggal penayangan item baris akan diwariskan dari pesanan pemasangan iklan induknya.
  • Item baris aktif akan dibelanjakan saat pemicu yang dipilih diaktifkan dalam tanggal penayangan pesanan pemasangan iklan induk.

Peringatan: Item Baris yang menggunakan pemicu manual tidak lagi ditayangkan di kampanye Display & Video 360 Kolom ini akan dihentikan mulai 1 Agustus 2023. Baca pengumuman penghentian fitur kami untuk informasi selengkapnya.

LineItemFlightDateType

Kemungkinan jenis tanggal penayangan item baris.

Enum
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED Tanggal penayangan item baris diwariskan dari pesanan pemasangan iklan induknya.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM Item baris menggunakan tanggal penayangan kustomnya sendiri.
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

Item baris menggunakan pemicu.

Peringatan: Item Baris yang menggunakan pemicu manual tidak lagi ditayangkan di kampanye Display & Video 360 Nilai ini akan dihentikan pada 1 Agustus 2023. Baca pengumuman penghentian fitur kami untuk informasi selengkapnya.

LineItemBudget

Setelan yang mengontrol cara anggaran dialokasikan.

Representasi JSON 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
Kolom
budgetAllocationType

enum (LineItemBudgetAllocationType)

Wajib diisi. Jenis alokasi anggaran.

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC hanya berlaku saat alokasi anggaran otomatis diaktifkan untuk pesanan pemasangan iklan induk.
budgetUnit

enum (BudgetUnit)

Hanya output. Unit anggaran menentukan apakah anggaran berbasis mata uang atau tayangan. Nilai ini diwarisi dari pesanan pemasangan iklan induk.
maxAmount

string (int64 format)

Jumlah anggaran maksimum yang akan dibelanjakan item baris. Harus lebih besar dari 0.

Jika budgetAllocationType adalah:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC, kolom ini tidak dapat diubah dan ditetapkan oleh sistem.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, jika budgetUnit adalah:
    • BUDGET_UNIT_CURRENCY, kolom ini menunjukkan jumlah anggaran maksimum yang akan dibelanjakan, dalam mikro mata uang pengiklan. Misalnya, 1500000 mewakili 1,5 unit standar mata uang.
    • BUDGET_UNIT_IMPRESSIONS, kolom ini menunjukkan jumlah maksimum tayangan yang ditampilkan.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED, kolom ini tidak berlaku dan akan diabaikan oleh sistem.

LineItemBudgetAllocationType

Kemungkinan jenis alokasi anggaran.

Enum
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC Alokasi anggaran otomatis diaktifkan untuk item baris.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED Jumlah anggaran maksimum tetap dialokasikan untuk item baris.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED Tidak ada batas anggaran yang diterapkan ke item baris.

PartnerRevenueModel

Setelan yang mengontrol cara penghitungan pendapatan partner.

Representasi JSON 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
Kolom
markupType

enum (PartnerRevenueModelMarkupType)

Wajib diisi. Jenis markup model pendapatan partner.
markupAmount

string (int64 format)

Wajib diisi. Jumlah markup model pendapatan partner. Harus lebih besar atau sama dengan 0.

  • Jika markupType ditetapkan ke PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, kolom ini mewakili markup CPM dalam mikro mata uang pengiklan. Misalnya, 1500000 mewakili 1,5 unit standar mata uang.
  • Jika markupType ditetapkan ke PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, kolom ini akan mewakili markup persen biaya media dalam milidetik. Misalnya, 100 mewakili 0,1% (desimal 0,001).
  • Jika markupType ditetapkan ke PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, kolom ini akan mewakili total markup persen biaya media dalam milidetik. Misalnya, 100 mewakili 0,1% (desimal 0,001).

PartnerRevenueModelMarkupType

Kemungkinan jenis markup model pendapatan partner.

Enum
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM Hitung pendapatan partner berdasarkan CPM tetap.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

Hitung pendapatan partner berdasarkan persentase tambahan biaya medianya.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Hitung pendapatan partner berdasarkan persentase biaya tambahan dari total biaya medianya, yang mencakup semua biaya partner dan biaya data.

ConversionCountingConfig

Setelan yang mengontrol cara penghitungan konversi.

Semua konversi pascaklik akan dihitung. Nilai persentase dapat ditetapkan untuk penghitungan konversi pascatayang.

Representasi JSON 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
Kolom
postViewCountPercentageMillis

string (int64 format)

Persentase konversi pasca-penayangan yang akan dihitung, dalam milidetik (1/1.000 persen). Harus antara 0 dan 100.000 inklusif.

Misalnya, untuk melacak 50% konversi pascaklik, tetapkan nilai 50.000.
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

Konfigurasi aktivitas Floodlight yang digunakan untuk melacak konversi.

Jumlah konversi yang dihitung adalah jumlah semua konversi yang dihitung oleh semua ID aktivitas Floodlight yang ditentukan dalam kolom ini.

TrackingFloodlightActivityConfig

Setelan yang mengontrol perilaku satu konfigurasi aktivitas Floodlight.

Representasi JSON 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
Kolom
floodlightActivityId

string (int64 format)

Wajib diisi. ID aktivitas Floodlight.
postClickLookbackWindowDays

integer

Wajib diisi. Jumlah hari yang memungkinkan penghitungan konversi setelah iklan diklik. Harus antara 0 dan 90 inklusif.
postViewLookbackWindowDays

integer

Wajib diisi. Jumlah hari setelah iklan dilihat saat konversi dapat dihitung. Harus antara 0 dan 90 inklusif.

TargetingExpansionConfig

Setelan yang mengontrol setelan penargetan yang dioptimalkan untuk item baris.

Representasi JSON 
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
Kolom
targetingExpansionLevel

enum (TargetingExpansionLevel)

Wajib diisi. Apakah penargetan yang dioptimalkan diaktifkan.

Kolom ini mendukung nilai berikut:

  • NO_EXPANSION: penargetan yang dioptimalkan dinonaktifkan
  • LEAST_EXPANSION: penargetan yang dioptimalkan diaktifkan

Jika kolom ini ditetapkan ke nilai lain, maka secara otomatis akan ditetapkan ke LEAST_EXPANSION.

NO_EXPANSION akan menjadi nilai default untuk kolom dan akan ditetapkan secara otomatis jika Anda tidak menetapkan kolom tersebut.
excludeFirstPartyAudience
(deprecated)

boolean

Apakah akan mengecualikan audiens pihak pertama agar tidak digunakan dalam perluasan penargetan.

Kolom ini tidak digunakan lagi dengan peluncuran penargetan yang dioptimalkan.

Kolom ini akan ditetapkan ke false. Jika kolom ini disetel ke true saat tidak digunakan lagi, semua penargetan audiens pihak pertama positif yang ditetapkan ke item baris ini akan diganti dengan penargetan negatif dari audiens pihak pertama yang sama untuk memastikan audiens tersebut tetap dikecualikan.

TargetingExpansionLevel

Setelan Penargetan yang dioptimalkan.

Enum
TARGETING_EXPANSION_LEVEL_UNSPECIFIED Setelan penargetan yang dioptimalkan tidak ditentukan atau tidak diketahui dalam versi ini.
NO_EXPANSION Penargetan yang dioptimalkan nonaktif.
LEAST_EXPANSION Penargetan yang dioptimalkan aktif.
SOME_EXPANSION

Jika digunakan, akan otomatis ditetapkan ke LEAST_EXPANSION.
BALANCED_EXPANSION

Jika digunakan, akan otomatis ditetapkan ke LEAST_EXPANSION.
MORE_EXPANSION

Jika digunakan, akan otomatis ditetapkan ke LEAST_EXPANSION.
MOST_EXPANSION

Jika digunakan, akan otomatis ditetapkan ke LEAST_EXPANSION.

LineItemWarningMessage

Pesan peringatan yang dibuat oleh item baris. Jenis peringatan ini tidak memblokir penyimpanan item baris, tetapi dapat memblokir item baris agar tidak dijalankan.

Enum
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED Tidak ditentukan atau tidak diketahui.
INVALID_FLIGHT_DATES Item baris ini memiliki tanggal periode tayang yang tidak valid. Item baris tidak akan dijalankan.
EXPIRED Tanggal akhir item baris ini sudah lewat.
PENDING_FLIGHT Item baris ini akan mulai berjalan di masa mendatang.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED Semua bursa yang diaktifkan partner ditargetkan secara negatif. Item baris tidak akan dijalankan.
INVALID_INVENTORY_SOURCE Sumber inventaris aktif tidak ditargetkan. Item baris tidak akan dijalankan.
APP_INVENTORY_INVALID_SITE_TARGETING Penargetan Aplikasi & URL item baris ini tidak menyertakan aplikasi seluler mana pun. Jenis item baris ini mengharuskan Anda menyertakan aplikasi seluler di penargetan saluran, daftar situs, atau aplikasi. Item baris tidak akan dijalankan.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Item baris ini tidak menargetkan pengguna seluler mana pun. Jenis item baris ini mengharuskan Anda menargetkan daftar pengguna dengan pengguna seluler. Item baris tidak akan dijalankan.
NO_VALID_CREATIVE Item baris ini tidak berisi materi iklan yang valid. Item baris tidak akan dijalankan.
PARENT_INSERTION_ORDER_PAUSED Perjanjian pemasangan iklan untuk item baris ini dijeda. Item baris tidak akan dijalankan.
PARENT_INSERTION_ORDER_EXPIRED Tanggal akhir pesanan pemasangan iklan item baris ini ditetapkan ke tanggal yang sudah berlalu. Item baris tidak akan dijalankan.
NO_POSITIVE_AUDIENCE_LIST_TARGETED Item baris ini tidak menargetkan daftar audiens, yang dapat menyebabkan anggaran Anda dibelanjakan terlalu cepat.
APP_INSTALL_NO_CONVERSION_PIXEL Item baris penginstalan aplikasi belum memiliki penyiapan piksel konversi.
TARGETING_REVOKED_OR_CLOSED_USER_LIST Item baris ini menargetkan satu atau beberapa daftar pengguna yang tidak lagi tersedia. Di masa mendatang, hal ini akan mencegah item baris ditayangkan, jadi pertimbangkan untuk menghapus daftar ini dari penargetan Anda.
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY Item baris penginstalan aplikasi tidak memiliki strategi bidding yang optimal.
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS Transaksi yang ditargetkan oleh item baris ini menyetujui ukuran materi iklan yang tidak sedang digunakan. Ini dapat membatasi penayangan atau performa item baris.
NO_CREATIVE_FOR_TARGETED_DEALS Item baris ini tidak berisi materi iklan apa pun untuk transaksi yang ditargetkan.
TARGETING_DEPRECATED_GEO_TARGET Item baris ini menargetkan target geografis yang tidak digunakan lagi.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

Item baris ini menggunakan setelan excludeFirstPartyAudience, yang tidak digunakan lagi dan dijadwalkan untuk dihentikan setelah 25 Maret 2023.

Perbarui integrasi API Anda untuk langsung mengecualikan audiens pihak pertama yang menggunakan penargetan audiens sebelum 25 Maret 2023 untuk memperhitungkan penghentian kolom excludeFirstPartyAudience.

MobileApp

Aplikasi seluler yang dipromosikan oleh item baris instal aplikasi seluler.

Representasi JSON 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
Kolom
appId

string

Wajib diisi. ID aplikasi yang disediakan oleh platform store.

Aplikasi Android diidentifikasi berdasarkan ID paket yang digunakan oleh Play Store Android, seperti com.google.android.gm.

Aplikasi iOS diidentifikasi dengan ID aplikasi sembilan digit yang digunakan oleh App Store Apple, seperti 422689480.
platform

enum (Platform)

Hanya output. Platform aplikasi.
displayName

string

Hanya output. Nama aplikasi.
publisher

string

Hanya output. Penerbit aplikasi.

Platform

Kemungkinan platform aplikasi seluler.

Enum
PLATFORM_UNSPECIFIED Platform tidak ditentukan.
IOS di platform iOS.
ANDROID di platform Android.

Metode

bulkEditLineItemAssignedTargetingOptions

 Opsi penargetan pengeditan massal pada satu item baris.

bulkListLineItemAssignedTargetingOptions

 Mencantumkan opsi penargetan yang ditetapkan untuk item baris di seluruh jenis penargetan.

create

 Membuat item baris baru.

delete

 Menghapus item baris.

generateDefault

 Membuat item baris baru dengan setelan (termasuk penargetan) yang diwarisi dari pesanan pemasangan iklan dan ENTITY_STATUS_DRAFT entity_status.

get

 Mendapatkan item baris.

list

 Mencantumkan item baris dalam pengiklan.

patch

 Memperbarui item baris yang sudah ada.