Video: Tonton diskusi penanganan error dari workshop 2019
Error dapat disebabkan oleh penyiapan lingkungan yang salah, bug dalam software Anda, atau input yang tidak valid dari pengguna. Apa pun sumbernya, Anda harus memecahkan masalah tersebut dan memperbaiki kode atau menambahkan logika untuk menangani error pengguna. Panduan ini membahas beberapa praktik terbaik saat memecahkan masalah error dari Google Ads API.
Memastikan konektivitas
Pastikan Anda memiliki akses ke Google Ads API dan penyiapan yang benar. Jika respons Anda menampilkan error HTTP, pastikan Anda menanganinya dengan cermat dan memastikan Anda menjangkau layanan yang ingin digunakan dari kode Anda.
Kredensial Anda disematkan dalam permintaan agar layanan dapat mengautentikasi Anda. Pahami struktur permintaan dan respons Google Ads API, terutama jika Anda akan menangani panggilan tanpa menggunakan library klien. Setiap library klien dikirimkan dengan petunjuk khusus tentang cara menyertakan kredensial Anda dalam file konfigurasi (lihat README library klien).
Pastikan Anda menggunakan kredensial yang benar. Panduan memulai kami akan memandu Anda melalui proses mendapatkan set yang benar yang Anda butuhkan. Misalnya, kegagalan respons berikut menunjukkan bahwa pengguna telah mengirimkan kredensial autentikasi yang tidak valid:
{ "error": { "code": 401, "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. Visit https://developers.google.com/identity/sign-in/web/devconsole-project.", "status": "UNAUTHENTICATED", "details": [ { "@type": "type.googleapis.com/google.rpc.DebugInfo", "detail": "Authentication error: 2" } ] } }
Jika Anda telah mengikuti langkah-langkah ini dan masih mengalami masalah, saatnya mempelajari cara memecahkan masalah error Google Ads API.
Menentukan masalah
Google Ads API umumnya melaporkan error sebagai objek kegagalan JSON, yang berisi daftar error dalam respons. Objek ini memberikan kode error serta pesan yang menjelaskan mengapa error terjadi. Hal ini adalah sinyal pertama Anda tentang kemungkinan penyebab masalah.
{
"errors": [
{
"errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
"message": "The field mask contained an invalid field: 'keyword/matchtype'.",
"location": { "operationIndex": "1" }
}
]
}
Semua library klien kami memunculkan pengecualian yang merangkum error dalam respons. Merekam pengecualian ini dan mencetak pesan dalam log atau layar pemecahan masalah adalah cara yang bagus untuk memulai. Mengintegrasikan informasi ini dengan peristiwa yang dicatat lainnya di aplikasi Anda akan memberikan ringkasan yang baik tentang apa yang mungkin memicu masalah tersebut. Setelah mengidentifikasi error dalam log, Anda harus mencari tahu artinya.
Meneliti error
Lihat dokumentasi Error Umum kami, yang mencakup error yang paling sering terjadi. Dokumen ini menjelaskan pesan error, referensi API yang relevan, dan cara menghindari atau menangani error.
Jika dokumentasi error umum kami tidak secara khusus menyebutkan error tersebut, baca dokumentasi referensi kami dan cari string error.
Telusuri saluran dukungan kami untuk mendapatkan akses ke developer lain yang membagikan pengalaman mereka dengan API. Orang lain mungkin pernah mengalami—dan memecahkan—masalah yang Anda alami.
Jika Anda mengalami error yang tidak didokumentasikan, sampaikan hal ini kepada kami di forum.
Buka Pusat Bantuan Google Ads untuk mendapatkan bantuan dalam memecahkan masalah validasi atau batas akun—Google Ads API mewarisi aturan dan batasan produk inti Google Ads.
Postingan blog kadang-kadang akan menjadi referensi yang baik saat memecahkan masalah aplikasi Anda.
Setelah meneliti error, kini saatnya menentukan akar masalah.
Menemukan penyebabnya
Periksa pesan pengecualian untuk mengetahui penyebab error. Setelah melihat respons, periksa permintaan untuk mengetahui kemungkinan penyebabnya. Beberapa pesan error Google Ads API menyertakan fieldPathElements
di kolom location pada
GoogleAdsError, yang menunjukkan lokasi
terjadinya error dalam permintaan. Contoh:
{
"errors": [
{
"errorCode": {"criterionError": "CANNOT_ADD_CRITERIA_TYPE"},
"message": "Criteria type can not be targeted.",
"trigger": { "stringValue": "" },
"location": {
"operationIndex": "0",
"fieldPathElements": [ { "fieldName": "keyword" } ]
}
}
]
}
Saat memecahkan masalah, mungkin aplikasi Anda memberikan informasi yang salah ke API. Sebaiknya gunakan Lingkungan Pengembangan Interaktif (IDE) seperti Eclipse (IDE gratis dan open source yang terutama digunakan untuk mengembangkan Java, tetapi memiliki plugin untuk bahasa lain) untuk membantu Anda melakukan proses debug. Fitur ini memungkinkan Anda menetapkan titik henti sementara dan menelusuri kode Anda baris demi baris.
Periksa kembali untuk memastikan permintaan cocok dengan input aplikasi Anda (misalnya, nama Kampanye mungkin tidak masuk ke permintaan). Pastikan Anda mengirim mask kolom yang cocok dengan pembaruan yang ingin Anda lakukan. Google Ads API mendukung pembaruan jarang. Menghilangkan kolom dari mask kolom dalam permintaan perubahan menunjukkan bahwa API tidak boleh mengubahnya. Jika aplikasi Anda mengambil objek, membuat perubahan, dan mengirimkannya kembali, Anda mungkin menulis ke kolom yang tidak mendukung pembaruan. Periksa deskripsi kolom di dokumentasi referensi untuk melihat apakah ada batasan tentang kapan atau apakah Anda dapat memperbarui kolom.
Cara mendapatkan bantuan
Anda tidak selalu dapat mengidentifikasi dan menyelesaikan masalah sendiri. Mengajukan pertanyaan di forum akan mengekspos pertanyaan Anda kepada ribuan developer yang mungkin pernah menghadapi masalah yang sama.
Coba sertakan informasi sebanyak mungkin dalam kueri Anda. Item yang direkomendasikan meliputi:
- Permintaan dan respons JSON yang telah disanitasi. Pastikan untuk menghapus informasi sensitif seperti token developer atau AuthToken Anda.
- Cuplikan kode. Jika Anda mengalami masalah khusus bahasa atau meminta bantuan terkait penggunaan API, sertakan cuplikan kode untuk membantu menjelaskan apa yang Anda lakukan.
- RequestId. Hal ini memungkinkan anggota tim Hubungan Developer Google menemukan permintaan Anda jika dibuat terhadap lingkungan produksi. Sebaiknya daftarkan requestId yang disertakan sebagai properti dalam pengecualian yang merangkum error respons, serta lebih banyak konteks daripada requestId saja, dalam log Anda.
- Informasi tambahan, seperti versi runtime/interpreter dan platform juga dapat berguna saat memecahkan masalah.
Memperbaiki masalah
Setelah Anda mengetahui masalahnya dan menemukan solusinya, saatnya melakukan perubahan dan menguji perbaikan terhadap akun pengujian (lebih disarankan) atau produksi (jika bug hanya berlaku untuk data di akun produksi tertentu).
Pertimbangkan Berbagi
Jika Anda telah memposting pertanyaan di forum terkait error yang belum pernah muncul di sana sebelumnya dan Anda telah menemukan solusinya, pertimbangkan untuk menambahkannya ke rangkaian pesan. Lain kali jika developer mengalami masalah yang sama, mereka akan dapat menyelesaikannya dengan segera.
Langkah Berikutnya
Setelah Anda menyelesaikan masalah ini, apakah Anda melihat cara untuk meningkatkan kualitas kode Anda agar masalah ini tidak terjadi lagi?
Membuat serangkaian pengujian unit yang baik akan membantu meningkatkan kualitas dan keandalan kode secara signifikan. Hal ini juga mempercepat proses pengujian perubahan baru untuk memastikan perubahan tersebut tidak merusak fungsi sebelumnya. Strategi penanganan error yang baik juga penting dalam menampilkan semua data yang diperlukan untuk pemecahan masalah.