Bermigrasi dari V2 Alfa

Halaman ini ditujukan bagi pelanggan yang saat ini menggunakan Cloud Support API versi V2 Alfa dan ingin bermigrasi ke V2 Beta.

Memulai V2 Beta

Jika sudah menggunakan V2 Alfa, Anda tidak perlu melakukan penyiapan tambahan untuk mulai menggunakan V2 Beta. Anda dapat menggunakan akun/kredensial layanan yang sama dan API sudah diaktifkan untuk Anda.

Untuk memanggil endpoint V2 Beta, cukup ganti bagian /v2alpha/ dari URL permintaan menjadi /v2beta/. Misalnya, berikut adalah cara mengupgrade panggilan cases.get dari V2 Alfa ke V2 Beta:

V2 Alfa: GET https://cloudsupport.googleapis.com/v2alpha/projects/123/cases/abc

V2 Beta: GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc

Perubahan yang Dapat Menyebabkan Gangguan pada Klasifikasi Kasus

Penting: Ini adalah satu-satunya perubahan yang dapat menyebabkan gangguan antara V2 Alfa dan V2 Beta. Endpoint apa pun yang tidak disebutkan di bagian ini dapat dimigrasikan dengan aman ke V2 Beta tanpa perubahan apa pun pada logika bisnis atau format permintaan/respons.

Satu-satunya perilaku yang telah berubah dari V2 Alfa ke V2 Beta adalah jenis Klasifikasi Kasus.

Klasifikasi Kasus Alfa V2

Kolom	Diperlukan untuk pembuatan kasus	Deskripsi
productType	Ya	string Jenis produk yang terkait dengan klasifikasi.
value	Ya	string Klasifikasi yang akan digunakan saat membuat kasus, misalnya "Masalah Teknis > Compute > Compute Engine"

Klasifikasi Kasus Beta V2

Kolom	Diperlukan untuk pembuatan kasus	Deskripsi
id	Ya	string ID unik untuk klasifikasi. Harus ditentukan untuk pembuatan kasus.
displayName	Tidak	string Nama tampilan klasifikasi.

Mengapa kami melakukan perubahan ini?

• Menghapus kolom productType

  • Desain awal API mengharuskan kami menambahkan kolom ini, tetapi seiring dengan perkembangan API, kolom ini menjadi tidak terpakai lagi.
  • Kolom ini wajib diisi, tetapi satu-satunya nilai yang valid adalah GOOGLE_CLOUD. Tindakan ini menambahkan boilerplate ke setiap permintaan pembuatan kasus.

• Memisahkan value menjadi id dan displayName

  • Kolom value di V2 Alfa harus dapat dibaca manusia (sehingga manusia dapat memilih dari daftar opsi) dan dapat dibaca mesin (sehingga API kami dapat mengetahui jenis kasus yang sedang dibuat).
  • V2 Beta memisahkan masalah ini menjadi dua bidang. id adalah bagian klasifikasi yang dapat dibaca mesin, displayName adalah bagian yang dapat dibaca manusia.
  • Hal ini memberi kami fleksibilitas untuk membuat perubahan pada nama tampilan tanpa merusak integrasi API. Misalnya, kita mungkin ingin memiliki beberapa terjemahan displayName di masa mendatang, tetapi id akan tetap sama untuk semua terjemahan karena mewakili klasifikasi kasus yang sama.