Video: Lihat pembahasan penanganan error dari workshop 2019
Error dapat disebabkan oleh penyiapan lingkungan yang salah, bug pada software, atau input yang tidak valid dari pengguna. Apa pun sumbernya, Anda harus memecahkan masalah ini 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 untuk mengatasinya dengan hati-hati dan 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 dalam proses mendapatkan set yang benar yang Anda butuhkan. Misalnya, kegagalan respons berikut menunjukkan bahwa pengguna telah mengirim 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 tetapi masih mengalami masalah, saatnya untuk mempelajari lebih lanjut 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 alasan terjadinya. Ini adalah sinyal pertama Anda tentang apa masalahnya.
{
"errors": [
{
"errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
"message": "The field mask contained an invalid field: 'keyword/matchtype'.",
"location": { "operationIndex": "1" }
}
]
}
Semua library klien kami menampilkan pengecualian yang merangkum error dalam respons. Merekam pengecualian ini dan mencetak pesan di log atau layar pemecahan masalah adalah cara yang bagus untuk memulai. Mengintegrasikan informasi ini dengan peristiwa lain yang dicatat ke dalam log di aplikasi Anda akan memberikan ringkasan yang bagus tentang hal-hal yang mungkin memicu masalah. Setelah mengidentifikasi error di log, Anda harus mencari tahu apa artinya.
Meneliti error
Lihat dokumentasi Error Umum kami, yang mencakup error yang paling sering terjadi. Bagian ini menjelaskan pesan error, referensi API yang relevan, dan cara menghindari atau menangani error tersebut.
Jika dokumentasi error umum kami tidak secara khusus menyebutkan error, baca dokumentasi referensi kami dan cari string error.
Telusuri saluran dukungan kami untuk mendapatkan akses ke developer lain yang membagikan pengalaman mereka menggunakan API. Orang lain mungkin telah mengalami—dan memecahkan—masalah yang Anda alami.
Jika Anda menemukan error yang tidak terdokumentasi, 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 terkadang akan menjadi referensi yang baik saat memecahkan masalah aplikasi Anda.
Setelah meneliti kesalahan tersebut, saatnya untuk menentukan akar masalahnya.
Menemukan penyebabnya
Periksa pesan pengecualian untuk mengetahui penyebab error. Setelah melihat
responsnya, 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. Kami sangat menganjurkan penggunaan Interactive Development Environment (IDE) seperti Eclipse (IDE gratis dan open source yang terutama digunakan untuk mengembangkan Java, tetapi memiliki plugin untuk bahasa lain) guna membantu Anda dalam proses debug. Alat ini memungkinkan Anda menetapkan titik henti sementara dan menelusuri kode baris demi baris.
Periksa kembali untuk memastikan permintaan cocok dengan input aplikasi Anda (misalnya, nama Kampanye mungkin tidak mengarah ke permintaan). Pastikan Anda mengirim mask kolom yang cocok dengan pembaruan yang ingin dilakukan--Google Ads API mendukung pembaruan yang sedikit. Jika kolom tidak ada dari mask kolom dalam permintaan mutasi, berarti API harus membiarkannya. Jika aplikasi Anda mengambil objek, membuat perubahan, dan mengirimkannya kembali, Anda mungkin dapat menulis ke kolom yang tidak mendukung update. Periksa deskripsi kolom dalam dokumentasi referensi untuk melihat apakah ada batasan terkait waktu atau apakah Anda dapat memperbarui kolom.
Cara mendapatkan bantuan
Tidak selalu mungkin untuk mengidentifikasi dan memecahkan masalah sendiri. Proses bertanya di forum akan mengekspos pertanyaan Anda kepada ribuan developer yang mungkin harus menghadapi masalah yang sama.
Coba sertakan informasi sebanyak mungkin dalam kueri Anda. Item yang direkomendasikan mencakup:
- Permintaan dan respons JSON yang dibersihkan. Pastikan untuk menghapus informasi sensitif, seperti token developer atau AuthToken Anda.
- Cuplikan kode. Jika Anda mengalami masalah bahasa tertentu atau meminta bantuan terkait penggunaan API, sertakan cuplikan kode untuk membantu menjelaskan apa yang Anda lakukan.
- IDPermintaan. Hal ini memungkinkan anggota tim Google Developer Relations menemukan permintaan Anda jika dibuat terhadap lingkungan produksi. Sebaiknya daftar di log Anda, requestId yang disertakan sebagai properti dalam pengecualian yang merangkum error respons, serta lebih banyak konteks daripada requestId saja.
- Informasi tambahan, seperti versi runtime/penerjemah dan platform juga dapat berguna saat memecahkan masalah.
Memperbaiki masalah
Setelah Anda mengetahui masalahnya dan menemukan solusinya, sekarang saatnya membuat perubahan dan menguji perbaikan pada akun pengujian (lebih disukai) atau produksi (jika bug hanya berlaku untuk data dalam akun produksi tertentu).
Pertimbangkan Berbagi
Jika Anda telah memposting pertanyaan di forum terkait error yang belum pernah muncul di sana sebelumnya dan Anda menemukan solusinya, pertimbangkan untuk menambahkannya ke thread. Lain kali jika developer memiliki masalah yang sama, mereka akan dapat segera menyelesaikannya.
Langkah Berikutnya
Setelah memecahkan masalah ini, apakah Anda memperhatikan ada cara untuk meningkatkan kode untuk menghindari hal ini sejak awal?
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 memunculkan semua data yang diperlukan untuk pemecahan masalah.