Video: Lihat diskusi praktik terbaik dari workshop 2019
Panduan ini membahas beberapa praktik terbaik yang dapat diterapkan untuk mengoptimalkan efisiensi dan performa aplikasi Anda.
Pemeliharaan berkelanjutan
Untuk memastikan aplikasi Anda berjalan tanpa gangguan:
Selalu perbarui email kontak developer Anda di Pusat API. Ini adalah alias yang kami gunakan untuk menghubungi Anda. Jika kami tidak dapat menghubungi Anda terkait kepatuhan terhadap Persyaratan dan Ketentuan API, akses API Anda dapat dicabut tanpa sepengetahuan Anda. Hindari penggunaan alamat email pribadi yang terkait dengan akun perorangan atau yang tidak terpantau.
Untuk mendapatkan informasi tentang masalah seperti perubahan produk, periode nonaktif pemeliharaan, tanggal penghentian, dan sebagainya, berlanggananlah
Forum ini dipantau secara rutin oleh tim Google Ads API, sehingga menjadikannya tempat yang ideal untuk memposting pertanyaan terkait API.
- Pastikan aplikasi Anda mematuhi Persyaratan dan Ketentuan (T&C) Google Ads API. Jika diperlukan, tim kepatuhan dan peninjauan token akan menghubungi Anda menggunakan email kontak Anda. Jika ada pertanyaan atau masalah tentang Persyaratan& Ketentuan, Anda dapat menghubungi tim peninjau dengan membalas email yang mereka kirimkan kepada Anda saat meninjau permohonan token developer.
Pengoptimalan
Operasi batch
Pembuatan permintaan ke API memerlukan sejumlah biaya tetap, seperti latensi jaringan dua arah, pemrosesan serialisasi dan deserialisasi, serta panggilan ke sistem back-end. Untuk mengurangi dampak biaya tetap ini dan meningkatkan performa secara keseluruhan, sebagian besar metode mutasi 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 bisa, hindari membuat permintaan dengan satu operasi saja.
Misalnya, Anda menambahkan 50.000 kata kunci ke kampanye di beberapa grup iklan. Daripada membuat 50.000 permintaan masing-masing dengan 1 kata kunci, buat 100 permintaan masing-masing dengan 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 tumpukan untuk mencapai performa yang optimal.
Mengirim objek sparse
Saat objek dikirim ke API, kolom harus dideserialisasi, divalidasi,
dan disimpan dalam database. Meneruskan objek penuh jika Anda hanya ingin memperbarui beberapa kolom dapat mengakibatkan waktu pemrosesan tambahan dan penurunan performa.
Untuk mengurangi hal ini, Google Ads API mendukung update renggang, sehingga Anda hanya dapat mengisi kolom dalam objek yang perlu diubah atau yang diperlukan. Proses update yang jarang akan lebih cepat dan cenderung tidak menghasilkan error.
Kolom yang tidak ada dalam update_mask (juga dikenal sebagai FieldMask) tidak berubah.
Misalnya, aplikasi yang memperbarui bid tingkat kata kunci dapat memperoleh manfaat dari penggunaan pembaruan ringan, karena hanya kolom ID grup iklan, ID kriteria, dan bid yang perlu diisi.
Penanganan dan pengelolaan error
Selama pengembangan, Anda kemungkinan menemukan error. Bagian ini menjelaskan pertimbangan dan strategi untuk menerapkan pengelolaan error ke dalam aplikasi Anda. Selain bagian ini, buka panduan Pemecahan masalah untuk informasi selengkapnya tentang cara mengelola error.
Membedakan sumber permintaan
Beberapa aplikasi pada dasarnya bersifat interaktif, yang melakukan panggilan API secara langsung sebagai respons terhadap tindakan yang dimulai pengguna di UI. Sebagian lainnya berfungsi terutama secara offline, melakukan panggilan API sebagai bagian dari proses back-end berkala. Banyak aplikasi menggabungkan keduanya. Ketika memikirkan pengelolaan error, sebaiknya bedakan berbagai jenis permintaan ini.
Untuk permintaan yang dimulai oleh 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 mudah yang dapat mereka lakukan untuk mengatasi error tersebut (lihat saran di bawah).
Untuk permintaan yang dimulai di backend, implementasikan pengendali untuk berbagai jenis error yang mungkin dialami aplikasi Anda. Selalu sertakan pengendali default untuk mengatasi error yang jarang terjadi atau yang sebelumnya tidak ditemukan. Pendekatan yang baik untuk pengendali default adalah menambahkan operasi yang gagal dan error ke antrean agar operator manusia dapat ditinjau dan menentukan resolusi yang sesuai.
Membedakan jenis error
Mengetahui perbedaan berbagai jenis error di Google Ads API sangat penting dalam membangun penanganan error yang andal. Beberapa jenis error yang paling umum adalah:
Lihat Jenis Error dan Error Umum untuk detail selengkapnya.
Sinkronkan backend
Jika pengguna aplikasi Anda memiliki akses manual ke akun Google Ads, mereka mungkin membuat perubahan yang tidak diketahui aplikasi Anda, yang menyebabkan database lokal aplikasi tidak sinkron. Seperti yang tercantum 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 setiap malam di semua akun Anda, mengambil objek Google Ads di akun Anda, dan membandingkannya dengan database lokal Anda.
Error log
Semua error harus dicatat untuk memfasilitasi proses debug dan pemantauan. Setidaknya, catat ID permintaan, operasi yang menyebabkan error, dan error itu sendiri ke dalam log. Informasi lain yang akan dicatat ke dalam log mencakup ID pelanggan, layanan API, latensi permintaan bolak-balik, jumlah percobaan ulang, serta permintaan dan respons mentah.
Pantau tren
Pastikan untuk memantau tren error API agar Anda dapat mendeteksi dan mengatasi masalah pada aplikasi. Pertimbangkan untuk membuat solusi Anda sendiri atau menggunakan salah satu dari banyak alat komersial yang tersedia yang dapat menggunakan log Anda untuk membuat dasbor interaktif dan mengirim pemberitahuan otomatis.
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. Token developer Anda tidak perlu disetujui untuk digunakan pada akun pengujian, sehingga Anda dapat mulai mengembangkan aplikasi dengan Google Ads API segera setelah meminta token developer, bahkan sebelum aplikasi Anda ditinjau.