Panduan ini mencakup beberapa praktik terbaik yang dapat Anda terapkan untuk mengoptimalkan efisiensi dan performa aplikasi Anda.
Memelihara aplikasi Anda
Untuk memastikan aplikasi Anda berjalan tanpa gangguan, lakukan hal berikut:
Pastikan daftar pemilik dan editor project Google Cloud Anda sudah terbaru. Kami akan menghubungi pengguna ini jika ada keadaan darurat atau topik terkait kepatuhan terhadap Persyaratan dan Ketentuan API. Jika kami tidak dapat menghubungi Anda terkait kepatuhan terhadap Persyaratan dan Ketentuan API, akses API Anda dapat diturunkan atau dicabut.
Untuk mendapatkan informasi tentang masalah seperti perubahan produk, waktu nonaktif pemeliharaan, dan tanggal penghentian penggunaan, subscribe ke blog API dan blog Produk kami.
Pastikan aplikasi Anda mematuhi Persyaratan dan Ketentuan (T&K) Google Ads API. Jika diperlukan, tim kepatuhan API akan menghubungi pemilik dan editor project Google Cloud Anda yang memiliki akses API. Jika ada pertanyaan atau masalah terkait Persyaratan dan Ketentuan, Anda dapat menghubungi tim kepatuhan dengan membalas email yang dikirimkan kepada Anda saat meninjau aplikasi akses API Anda.
Pengoptimalan
Anda dapat mengoptimalkan aplikasi dengan menjalankan operasi batch dan, jika sesuai, mengirim objek jarang.
Operasi batch
Membuat permintaan ke API memerlukan sejumlah biaya tetap, seperti latensi jaringan dua arah, pemrosesan serialisasi dan deserialisasi, serta panggilan ke sistem backend. Untuk mengurangi dampak biaya tetap ini dan meningkatkan performa secara keseluruhan, sebagian besar metode mutate di API dirancang untuk menerima array operasi. Dengan mengelompokkan beberapa operasi ke dalam setiap permintaan, Anda dapat mengurangi jumlah permintaan yang Anda buat dan biaya tetap terkait. Jika memungkinkan, hindari membuat permintaan dengan hanya satu operasi.
Misalnya, Anda menambahkan 50.000 kata kunci ke kampanye di beberapa grup iklan. Daripada membuat 50.000 permintaan dengan masing-masing 1 kata kunci, buat 100 permintaan dengan masing-masing 500 kata kunci, atau bahkan 10 permintaan dengan masing-masing 5.000 kata kunci. Ada batasan jumlah operasi yang diizinkan dalam permintaan, sehingga Anda mungkin perlu menyesuaikan ukuran batch untuk mencapai performa yang optimal.
Mengirim objek jarang
Saat objek dikirim ke API, kolom harus dideserialisasi, divalidasi, dan
disimpan dalam database. Mengirimkan objek lengkap saat Anda hanya ingin memperbarui beberapa kolom dapat menyebabkan waktu pemrosesan tambahan dan penurunan performa. Untuk
mengurangi masalah ini, Google Ads API mendukung pembaruan jarang, sehingga Anda dapat mengisi
hanya kolom dalam objek yang perlu diubah atau yang diperlukan.
Pembaruan jarang diproses lebih cepat dan cenderung tidak menimbulkan error. Kolom yang tidak ada di update_mask (juga dikenal sebagai FieldMask) tidak akan diubah.
Misalnya, aplikasi yang memperbarui bid tingkat kata kunci dapat memanfaatkan penggunaan pembaruan jarang, karena hanya kolom ID grup iklan, ID kriteria, dan bid yang perlu diisi.
Penanganan dan pengelolaan error
Selama pengembangan, Anda mungkin akan mengalami error. Bagian ini menjelaskan pertimbangan dan strategi untuk membangun pengelolaan error ke dalam aplikasi Anda. Selain bagian ini, buka Panduan pemecahan masalah untuk mengetahui informasi selengkapnya tentang pengelolaan error.
Membedakan sumber permintaan
Beberapa aplikasi bersifat interaktif, mengeluarkan panggilan API secara langsung sebagai respons terhadap tindakan yang dimulai pengguna di UI. Yang lain bekerja terutama secara offline, mengeluarkan panggilan API sebagai bagian dari proses backend berkala. Banyak aplikasi menggabungkan keduanya. Saat memikirkan pengelolaan error, akan berguna untuk membedakan berbagai jenis permintaan ini.
Untuk permintaan yang dimulai pengguna, perhatian utama Anda adalah memberikan pengalaman yang baik bagi pengguna. Gunakan error spesifik yang terjadi untuk memberikan konteks sebanyak mungkin kepada pengguna di UI. Tawarkan langkah-langkah jelas yang dapat mereka lakukan untuk mengatasi error (lihat saran berikut).
Untuk permintaan yang dimulai di backend, terapkan pengendali untuk berbagai jenis error yang mungkin terjadi di aplikasi Anda. Selalu sertakan pengendali default untuk mengatasi error langka atau yang belum pernah terjadi sebelumnya. Pendekatan yang baik untuk handler default adalah menambahkan operasi yang gagal dan error ke antrean agar ditinjau oleh operator manusia dan menentukan penyelesaian yang tepat.
Membedakan jenis error
Mengetahui perbedaan antara jenis error di Google Ads API sangat penting saat membangun penanganan error yang andal. Beberapa jenis error yang paling umum adalah:
Lihat Jenis error dan Error umum untuk mengetahui detail selengkapnya.
Backend sinkronisasi
Jika pengguna aplikasi Anda memiliki akses manual ke akun Google Ads, mereka dapat membuat perubahan yang tidak diketahui aplikasi Anda, sehingga menyebabkan database lokal aplikasi Anda tidak disinkronkan. Seperti yang disebutkan dalam panduan Jenis error, Anda dapat mengatasi error terkait sinkronisasi secara reaktif saat terjadi, tetapi Anda juga dapat mencoba mencegahnya secara proaktif. Salah satu strategi proaktif adalah menjalankan tugas sinkronisasi berkala untuk menyelaraskan database lokal Anda dengan objek Google Ads di akun Anda. Untuk
hierarki akun besar, hindari menarik semua objek di setiap akun setiap
malam untuk mencegah kuota harian habis; sebagai gantinya, kueri
ChangeStatus atau filter untuk entitas yang baru diubah guna menyinkronkan
perubahan secara inkremental.
Error log
Semua error harus dicatat untuk mempermudah proses debug dan pemantauan. Setidaknya, catat ID permintaan, operasi yang menyebabkan error, dan error itu sendiri. Informasi lain yang perlu dicatat mencakup ID pelanggan, layanan API, latensi permintaan round-trip, jumlah percobaan ulang, serta permintaan dan respons mentah yang telah disanitasi (pastikan untuk menyamarkan kredensial sensitif seperti token OAuth, token developer jika masih disertakan dalam header permintaan lama, dan PII apa pun).
Memantau tren
Pastikan untuk memantau tren error API sehingga Anda dapat mendeteksi dan mengatasi masalah pada aplikasi Anda. Pertimbangkan untuk membuat solusi Anda sendiri atau menggunakan salah satu dari banyak alat komersial yang tersedia yang dapat menggunakan log Anda untuk menghasilkan dasbor interaktif dan mengirimkan pemberitahuan otomatis.
Pengembangan
Gunakan akun pengujian selama pengembangan.
Menggunakan akun pengujian
Akun pengujian adalah akun Google Ads yang tidak benar-benar menayangkan iklan. Anda dapat menggunakan akun pengujian untuk bereksperimen dengan Google Ads API dan menguji apakah konektivitas aplikasi, logika pengelolaan kampanye, atau pemrosesan lainnya berfungsi seperti yang diharapkan. Project Google Cloud Anda hanya memerlukan akses Pengujian untuk digunakan di akun pengujian, sehingga Anda dapat segera mulai mengembangkan dengan Google Ads API, sambil menunggu Google meninjau aplikasi Anda untuk tingkat akses API yang lebih tinggi.