Terakhir diperbarui: 06-12-2022
Memigrasikan aplikasi Anda
Migrasi dari v1 ke v2 memerlukan update URL endpoint untuk memanggil v2 dan mengupdate aplikasi untuk memperhitungkan perubahan yang dapat menyebabkan gangguan.
Mengupdate panggilan API dari v1 ke v2
Untuk menggunakan v2, bukan v1, Anda harus memperbarui permintaan untuk menggunakan endpoint v2 yang baru.
Misalnya, untuk memanggil metode advertisers.get
dengan v1, gunakan URL berikut:
GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId
Untuk v2, perbarui URL menjadi berikut:
GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId
Jika Anda menggunakan library klien untuk membuat permintaan ke API, gunakan versi library klien terbaru dan update konfigurasi Anda untuk menggunakan v2.
Membuat perubahan yang diperlukan
Kami memperkenalkan sejumlah perubahan yang dapat menyebabkan gangguan di v2. Tinjau petunjuk berikut dan buat perubahan yang diperlukan sesuai dengan penggunaan Display & Video 360 API oleh Anda saat ini.
Memperbarui panggilan ke metode penargetan
Beberapa jenis penargetan kini ditetapkan menggunakan nilai enum, bukan ID opsi penargetan. Misalnya, perangkat tablet kini ditargetkan langsung dengan enum
DEVICE_TYPE_TABLET
DeviceType
, bukan ID opsi penargetan dari layanantargetingTypes.targetingOptions
. Versi string enum ini direpresentasikan dalam kolomassignedTargetingOptionIdAlias
baru dalam resourceAssignedTargetingOption
ini dan dapat digunakan saat mengambil atau menghapus penargetan yang ada. NilaiassignedTargetingOptionId
dari resourceAssignedTargetingOption
ini belum berubah.Update panggilan yang mengelola jenis penargetan berikut untuk menggunakan nilai enum:
TARGETING_TYPE_AGE_RANGE
TARGETING_TYPE_CONTENT_INSTREAM_POSITION
TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
TARGETING_TYPE_DEVICE_TYPE
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
TARGETING_TYPE_ENVIRONMENT
TARGETING_TYPE_EXCHANGE
TARGETING_TYPE_GENDER
TARGETING_TYPE_HOUSEHOLD_INCOME
TARGETING_TYPE_NATIVE_CONTENT_POSITION
TARGETING_TYPE_OMID
TARGETING_TYPE_PARENTAL_STATUS
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
TARGETING_TYPE_VIDEO_PLAYER_SIZE
TARGETING_TYPE_VIEWABILITY
Metode
advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions
telah diganti dengan metodeadvertisers.lineItems.bulkEditAssignedTargetingOptions
.Metode
advertisers.lineItems.bulkListLineItemAssignedTargetingOptions
telah diganti dengan metodeadvertisers.lineItems.bulkListAssignedTargetingOptions
.Update panggilan yang mengelola
TARGETING_TYPE_PROXIMITY_LOCATION_LIST
agar dapat menggunakan ukuran radius dan unit jarak yang telah ditetapkan, bukan nilai enumProximityRadiusRange
.Metode penargetan yang mengambil atau mengedit opsi penargetan di beberapa jenis penargetan di bawah satu resource induk telah diganti namanya.
Perbarui panggilan ke metode berikut agar dapat menggunakan nama barunya:
advertisers.bulkEditAdvertiserAssignedTargetingOptions
hinggaadvertisers.editAssignedTargetingOptions
advertisers.bulkListAdvertiserAssignedTargetingOptions
hinggaadvertisers.listAssignedTargetingOptions
advertisers.campaigns.bulkListCampaignAssignedTargetingOptions
hinggaadvertisers.campaigns.listAssignedTargetingOptions
advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions
hinggaadvertisers.insertionOrders.listAssignedTargetingOptions
partners.bulkEditPartnerAssignedTargetingOptions
hinggapartners.editAssignedTargetingOptions
Update panggilan ke layanan advertisers.lineItems
- Kolom
inventorySourceIds
telah dihapus. Kelola penetapan sumber inventaris menggunakan referensiAssignedTargetingOption
dariTARGETING_TYPE_INVENTORY_SOURCE
. Nilai enum
LineItemWarningMessage
berikut tidak digunakan lagi di v2 dan tidak akan ditampilkan lagi diLineItem.warningMessages
:NO_POSITIVE_AUDIENCE_LIST_TARGETED
APP_INSTALL_NO_CONVERSION_PIXEL
TARGETING_REVOKED_OR_CLOSED_USER_LIST
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
NO_CREATIVE_FOR_TARGETED_DEALS
TARGETING_DEPRECATED_GEO_TARGET
Kolom
triggerId
telah dihapus dari objekLineItemFlight
dan nilaiLINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER
telah dihapus dari jenis enumLineItemFlightDateType
. v2 tidak mendukung penetapan item baris untuk dibelanjakan berdasarkan aktivasi pemicu manual.
Update panggilan ke layanan customBiddingAlgorithms
Kolom customBiddingAlgorithmState
dan modelReadiness
telah diganti dengan kolom modelDetails
, yang memberikan status kesiapan
dan penangguhan dari model algoritme yang ada untuk setiap pengiklan yang memiliki akses melalui daftar objek
CustomBiddingModelDetails
.
Perubahan lainnya
Selain perubahan yang dapat menyebabkan gangguan yang tercantum di atas, v2 juga memperkenalkan fitur baru.
Fitur yang ditambahkan ke v2 setelah peluncuran awal dapat ditemukan di catatan rilis kami.
Akses hanya baca ke item baris YouTube
Di v2, item baris YouTube dan setelan penargetannya masing-masing dapat diambil menggunakan
layanan
advertisers.lineItems
dan
advertisers.lineItems.targetingTypes.assignedTargetingOptions
. API ini menyediakan akses hanya baca, yang berarti bahwa setiap
percobaan permintaan tulis yang dibuat ke item baris ini akan menampilkan error. Item baris YouTube akan menjadi salah satu nilai LineItemType
berikut:
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE
Metode baru yang memungkinkan performa yang lebih baik
Pada v2, layanan advertisers.lineItems
menyediakan metode
baru yang dapat digunakan sebagai pengganti batch permintaan untuk performa
yang lebih baik dan pengurangan pemakaian kuota:
- Anda dapat menggunakan
advertisers.lineItems.bulkUpdate
untuk menetapkan nilai kolom yang sama untuk beberapa item baris. Hanya update pada kolomentityStatus
yang saat ini didukung. - Anda dapat menggunakan
advertisers.lineItems.bulkEditAssignedTargetingOptions
untuk menambahkan atau menghapus opsi penargetan yang ditetapkan dan sama di beberapa item baris. - Anda dapat menggunakan
advertisers.lineItems.bulkListAssignedTargetingOptions
untuk mencantumkan opsi penargetan yang ditetapkan di beberapa item baris. - Anda dapat menggunakan
advertisers.lineItems.duplicate
untuk membuat duplikat item baris yang sudah ada dalam perjanjian pemasangan iklan yang sama, dengan menyalin semua konfigurasi dan setelan penargetan.
Akses tulis sebagian untuk penargetan perjanjian pemasangan iklan
Di v2, Anda dapat mengedit setelan penargetan subset untuk resource InsertionOrder
menggunakan metode create
dan
delete
baru di
layanan
advertisers.insertionOrders.targetingTypes.assignedTargetingOptions
. Jenis penargetan berikut dapat dikelola sepenuhnya di tingkat pesanan
penyisipan:
TARGETING_TYPE_AGE_RANGE
TARGETING_TYPE_BROWSER
TARGETING_TYPE_CATEGORY
TARGETING_TYPE_CHANNEL
TARGETING_TYPE_DEVICE_MAKE_MODEL
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
TARGETING_TYPE_ENVIRONMENT
TARGETING_TYPE_GENDER
TARGETING_TYPE_KEYWORD
TARGETING_TYPE_LANGUAGE
TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
TARGETING_TYPE_OPERATING_SYSTEM
TARGETING_TYPE_PARENTAL_STATUS
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
TARGETING_TYPE_VIEWABILITY