Bermigrasi dari v1 ke v2

Terakhir diperbarui: 06-12-2022

Memigrasikan aplikasi Anda

Migrasi dari v1 ke v2 memerlukan update URL endpoint untuk memanggil v2 dan memperbarui aplikasi untuk memperhitungkan perubahan yang dapat menyebabkan gangguan.

Mengupdate panggilan API dari v1 ke v2

Untuk menggunakan v2, bukan v1, Anda harus memperbarui permintaan agar menggunakan v2 baru endpoint.

Misalnya, untuk memanggil metode advertisers.get dengan v1, Anda akan 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 terbaru pustaka klien dan perbarui konfigurasi Anda untuk menggunakan v2.

Membuat perubahan yang diperlukan

Kami memperkenalkan sejumlah perubahan yang dapat menyebabkan gangguan di v2. Tinjau hal berikut dan membuat perubahan yang diperlukan relevan dengan penggunaan Anda atas Layar & Video 360 API.

Memperbarui panggilan ke metode penargetan

• Beberapa jenis penargetan kini ditetapkan menggunakan nilai enum, bukan penargetan ID opsi. Misalnya, perangkat tablet kini ditargetkan langsung dengan enum DEVICE_TYPE_TABLET DeviceType, bukan ID opsi penargetan dari Layanan targetingTypes.targetingOptions. Versi string dari enum ini diwakili dalam Kolom assignedTargetingOptionIdAlias di AssignedTargetingOption dan dapat digunakan saat mengambil atau menghapus penargetan yang ada. Nilai assignedTargetingOptionId dari resource AssignedTargetingOption ini tidak berubah.

  Perbarui 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 metode advertisers.lineItems.bulkEditAssignedTargetingOptions.

• Metode advertisers.lineItems.bulkListLineItemAssignedTargetingOptions telah diganti dengan metode advertisers.lineItems.bulkListAssignedTargetingOptions.

• Memperbarui panggilan yang mengelola TARGETING_TYPE_PROXIMITY_LOCATION_LIST untuk menggunakan ukuran radius yang disetel dan satuan jarak bukan Nilai enum ProximityRadiusRange.

• Metode penargetan yang mengambil atau mengedit opsi penargetan di beberapa jenis penargetan di satu resource induk telah diganti namanya.

  Perbarui panggilan ke metode berikut untuk menggunakan nama barunya:

  • advertisers.bulkEditAdvertiserAssignedTargetingOptions hingga advertisers.editAssignedTargetingOptions
  • advertisers.bulkListAdvertiserAssignedTargetingOptions hingga advertisers.listAssignedTargetingOptions
  • advertisers.campaigns.bulkListCampaignAssignedTargetingOptions hingga advertisers.campaigns.listAssignedTargetingOptions
  • advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions hingga advertisers.insertionOrders.listAssignedTargetingOptions
  • partners.bulkEditPartnerAssignedTargetingOptions ke partners.editAssignedTargetingOptions

Update panggilan ke layanan advertisers.lineItems

• Kolom inventorySourceIds telah dihapus. Mengelola penetapan sumber inventaris menggunakan resource AssignedTargetingOption dari TARGETING_TYPE_INVENTORY_SOURCE.

• Nilai enum LineItemWarningMessage berikut memiliki tidak digunakan lagi di v2 dan tidak akan muncul lagi di LineItem.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 objek LineItemFlight dan Nilai LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER telah dihapus dari Jenis enum LineItemFlightDateType. v2 tidak mendukung menyetel item baris yang akan dibelanjakan berdasarkan aktivasi pemicu manual.

Update panggilan ke layanan customBiddingAlgorithms

customBiddingAlgorithmState dan modelReadiness Kolom telah diganti dengan modelDetails , yang memberikan kesiapan dan status penangguhan dari algoritma yang ada khusus untuk setiap pengiklan yang memiliki akses melalui daftar CustomBiddingModelDetails objek.

Perubahan lainnya

Selain perubahan yang dapat menyebabkan gangguan yang tercantum di atas, v2 juga memperkenalkan baru.

Fitur yang ditambahkan ke v2 setelah peluncuran awal dapat ditemukan di catatan rilis.

Akses hanya baca ke item baris YouTube

Di v2, item baris YouTube dan setelan penargetannya dapat diambil menggunakan advertisers.lineItems dan advertisers.lineItems.targetingTypes.assignedTargetingOptions masing-masing layanan. API ini menyediakan akses hanya-baca, artinya setiap percobaan permintaan tulis yang dilakukan ke item baris ini akan menampilkan error. YouTube item baris akan menjadi salah satu dari LineItemType berikut nilai-nilai:

• 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

Di v2, layanan advertisers.lineItems menyediakan metode yang lebih baik untuk digunakan sebagai pengganti kumpulan permintaan agar lebih performa dan pengurangan konsumsi kuota:

• Anda dapat menggunakan advertisers.lineItems.bulkUpdate untuk menyetel nilai kolom yang sama untuk beberapa item baris. Hanya pembaruan pada Kolom entityStatus saat ini didukung.
• Anda dapat menggunakan advertisers.lineItems.bulkEditAssignedTargetingOptions untuk menambahkan atau menghapus opsi penargetan yang ditetapkan sama di beberapa baris item.
• 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 ada dalam pesanan pemasangan iklan yang sama, menyalin semua konfigurasi dan setelan penargetan.

Akses tulis sebagian untuk penargetan pesanan pemasangan iklan

Di v2, Anda dapat mengedit setelan penargetan subkumpulan untuk InsertionOrder resource menggunakan create baru dan Metode delete di advertisers.insertionOrders.targetingTypes.assignedTargetingOptions layanan. Jenis penargetan berikut dapat dikelola sepenuhnya di penyisipan tingkat pesanan:

• 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