Bermigrasi dari v2 ke v3

Terakhir diperbarui: 31-10-2023

Memigrasikan aplikasi Anda

Bermigrasi dari v2 ke v3 memerlukan pembaruan URL endpoint untuk memanggil v3 dan memperbarui aplikasi Anda untuk memperhitungkan perubahan yang menyebabkan gangguan.

Perbarui panggilan API Anda dari v2 ke v3

Untuk menggunakan v3, bukan v2, Anda harus memperbarui permintaan untuk menggunakan endpoint v3 baru.

Misalnya, untuk memanggil metode advertisers.get dengan v2, Anda harus menggunakan URL berikut:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

Untuk v3, perbarui URL ke berikut ini:

GET https://displayvideo.googleapis.com/v3/advertisers/advertiserId

Jika Anda menggunakan library klien untuk membuat permintaan ke API, gunakan library klien versi terbaru dan perbarui konfigurasi Anda untuk menggunakan v3.

Membuat perubahan yang diperlukan

Kami memperkenalkan sejumlah perubahan yang dapat menyebabkan gangguan di v3. Tinjau petunjuk berikut dan lakukan perubahan yang diperlukan yang relevan dengan penggunaan Display & Video 360 API yang ada.

Memperbarui panggilan yang mengambil resource YouTube dan penargetan terkaitnya

• Resource YoutubeAdGroup dan YoutubeAdGroupAd telah diganti dengan resource AdGroup dan AdGroupAd. Resource baru ini memberikan informasi yang hampir identik dengan resource v2, tetapi mungkin menggunakan nama kolom atau jenis enum yang diperbarui. Dalam integrasi Anda, ganti penggunaan resource YoutubeAdGroup atau YoutubeAdGroupAd dengan resource AdGroup dan AdGroupAd, lalu perbarui panggilan ke layanan v2 berikut ke layanan v3 yang sesuai:
  • advertisers.youtubeAdGroupAds hingga advertisers.adGroupAds
  • advertisers.youtubeAdGroups hingga advertisers.adGroups
  • advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions hingga advertisers.adGroups.targetingTypes.assignedTargetingOptions
• Referensi ke objek YoutubeAndPartnersBiddingStrategy telah dipindahkan ke kolom youtubeAndPartnersBid baru dalam objek BiddingStrategy umum. Kolom biddingStrategy telah dihapus dari objek YoutubeAndPartnersSettings. Perbarui integrasi Anda untuk mengambil strategi bidding untuk item baris atau grup iklan YouTube dari objek BiddingStrategy di kolom bidStrategy dalam resource LineItem atau AdGroup.
• Nama kolom thirdPartyMeasurementSettings telah diganti menjadi thirdPartyMeasurementConfigs di objek YoutubeAndPartnersSettings dan nama objek YoutubeAndPartnersThirdPartyMeasurementSettings telah diganti menjadi ThirdPartyMeasurementConfigs. Perbarui integrasi Anda untuk mengambil informasi konfigurasi pengukuran pihak ketiga menggunakan kolom dan objek baru.

Sertakan konfigurasi penagihan yang diperlukan saat membuat pengiklan

billingConfig kini menjadi kolom wajib diisi dalam resource Advertiser. Perbarui permintaan advertisers.create Anda untuk memverifikasi bahwa kolom ini telah ditetapkan. Informasi penagihan default dapat diambil untuk partner induk melalui kolom Partner resource billingConfig yang baru.

Menggunakan kolom baru untuk mengontrol penargetan yang dioptimalkan

Kolom boolean enableOptimizedTargeting baru telah menggantikan kolom targetingExpansionLevel dalam objek TargetingExpansionConfig.

Memperbarui integrasi pesanan pemasangan iklan untuk menggunakan kolom KPI baru

Kolom kpi baru telah menggantikan kolom performanceGoal di resource InsertionOrder. Kolom baru ini menggunakan objek Kpi sebagai pengganti objek PerformanceGoal dan menggunakan kolom serta enum baru.

Menghapus referensi ke layanan dan kolom yang tidak digunakan lagi

Berbagai entity telah dihapus di v3 agar selaras dengan penghentian penggunaan fitur sebelumnya:

• Layanan advertisers.manualTriggers telah dihapus karena pemicu manual tidak digunakan lagi.
• Kolom billableOutcome telah dihapus dari resource InsertionOrder karena pembelian berbasis hasil tidak digunakan lagi.

Perubahan lainnya

Selain perubahan yang tidak kompatibel yang tercantum di atas, v3 juga memperkenalkan fitur baru.

Fitur yang ditambahkan ke v3 setelah peluncuran awal dapat ditemukan dalam catatan rilis kami.

Pengelolaan daftar lokasi jarak

Di v3, Anda dapat mengelola daftar lokasi jarak sepenuhnya, sehingga Anda dapat menggunakan layanan advertisers.locationLists.assignedLocations untuk membuat dan menghapus lokasi yang ditetapkan ke resource TARGETING_LOCATION_TYPE_PROXIMITY LocationList. Lokasi diidentifikasi menggunakan ID resource TARGETING_TYPE_POI TargetingOption. Nilai ini dapat diambil menggunakan targetingTypes.targetingOptions.search.

Kemampuan untuk membuat algoritma bidding kustom berbasis aturan

Di v3, Anda dapat membuat dan mengambil algoritma bidding kustom berbasis aturan menggunakan layanan customBiddingAlgorithms, media, customBiddingAlgorithms.rules.

Fitur ini masih dalam versi beta dan hanya tersedia untuk partner yang masuk dalam daftar yang diizinkan. Jika partner Anda tidak masuk daftar yang diizinkan, permintaan Anda akan menampilkan error.