Bermigrasi dari V2 Beta

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

Memulai V2

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

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

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

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

Perubahan yang dapat menyebabkan gangguan pada SearchCases, Case.severity, dan Comment.plainTextBody

Penting: Ini adalah satu-satunya perubahan yang dapat menyebabkan gangguan antara V2 Beta dan V2. Setiap kolom/endpoint yang tidak disebutkan di bagian ini sama persis. Jika saat ini Anda tidak menggunakan endpoint SearchCases, kolom Case.severity, atau kolom Comment.plainTextBody, Anda dapat bermigrasi dengan aman ke V2 tanpa mengubah logika bisnis atau format permintaan-respons.

SearchCases Perubahan Endpoint

Endpoint SearchCases telah berubah dengan cara berikut:

• Jalurnya telah berubah dari:

  GET https://cloudsupport.googleapis.com/v2/cases:search

  to:

  GET https://cloudsupport.googleapis.com/v2beta/{parent=*/*}/cases:search

• Parameter filter tidak lagi menerima filter project atau organization. Sebagai gantinya, project/organisasi dari URL akan digunakan sebagai cakupan penelusuran.

Perubahan Kolom

Kolom telah berubah dengan cara berikut:

• Kolom severity pada cases telah dihapus dan diganti dengan kolom priority.

• Kolom plainTextBody pada komentar kasus telah dihapus dan diganti dengan kolom body.

Mengapa kami melakukan perubahan ini?

• Mengubah jalur SearchCases

  • Cara lama untuk menentukan cakupan penelusuran membingungkan dan tidak sejalan dengan praktik desain API Google Cloud Platform standar.
  • Cara baru membuat SearchCases lebih konsisten dengan endpoint lain di API, seperti ListCases.

• Menghapus kolom Case.severity

  • Tingkat keparahan memiliki fungsi yang sama dengan prioritas, sehingga menghapusnya akan menyederhanakan API.

• Menghapus kolom Comment.plainTextBody

  • Comment.body hanya berisi teks biasa, sehingga merupakan duplikat dari kolom ini, jadi kami menghapus plainTextBody untuk menyederhanakan API.

Cara beradaptasi dengan perubahan

• Hapus filter project dan organization dari permintaan SearchCase dan deklarasikan dalam URL permintaan.

• Gunakan kolom priority di tempat Anda sebelumnya menggunakan kolom severity. Mereka sangat mirip dalam makna semantik, jadi Anda biasanya dapat menukar referensi ini.

• Gunakan kolom body, bukan kolom plainTextBody. Keduanya berisi informasi yang sama. Jadi, kemungkinan besar, seharusnya tidak masalah untuk mengganti semua referensi ke plainTextBody dengan body.