Video: Tonton diskusi praktik terbaik dari workshop 2019
Panduan ini membahas beberapa praktik terbaik yang dapat Anda terapkan untuk mengoptimalkan efisiensi dan performa aplikasi.
Pemeliharaan berkelanjutan
Untuk memastikan aplikasi Anda berjalan tanpa gangguan:
Pastikan email kontak developer Anda di pusat API selalu yang terbaru. 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 sebelumnya. Hindari penggunaan alamat email pribadi yang terkait dengan akun perorangan atau yang tidak dipantau. Untuk melihat pusat API, Anda harus login ke akun pengelola.
Untuk mendapatkan informasi tentang masalah seperti perubahan produk, periode nonaktif pemeliharaan, tanggal penghentian penggunaan, dan sebagainya, berlanggananlah ke
Forum ini dipantau secara rutin oleh tim Google Ads API, sehingga menjadi tempat yang ideal untuk memposting pertanyaan API.
- Pastikan aplikasi Anda mematuhi Persyaratan dan Ketentuan (T&C) Google Ads API. Jika diperlukan, tim peninjauan dan kepatuhan token akan menghubungi Anda menggunakan email kontak Anda. Jika ada pertanyaan atau masalah terkait persyaratan dan ketentuan, Anda dapat menghubungi tim peninjau dengan membalas email yang mereka kirimkan saat meninjau permohonan token developer 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 mutasi di API dirancang untuk menerima array operasi. Dengan mengelompokkan beberapa operasi ke dalam setiap permintaan, Anda dapat mengurangi jumlah permintaan yang dibuat dan biaya tetap terkait. Jika memungkinkan, hindari membuat permintaan hanya dengan 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. Meneruskan objek lengkap saat Anda hanya ingin memperbarui
beberapa kolom dapat mengakibatkan waktu pemrosesan tambahan dan penurunan performa.
Untuk mengurangi hal ini, Google Ads API mendukung pembaruan jarang, yang memungkinkan Anda
hanya mengisi kolom dalam objek yang perlu diubah atau yang
diperlukan. Update jarang diproses lebih cepat dan cenderung tidak menghasilkan error.
Kolom yang tidak ada dalam update_mask (juga dikenal sebagai FieldMask) tidak akan
berubah.
Misalnya, aplikasi yang memperbarui bid tingkat kata kunci dapat memanfaatkan update 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 membuat pengelolaan error ke dalam aplikasi Anda. Selain bagian ini, buka Panduan pemecahan masalah untuk mengetahui informasi selengkapnya tentang cara mengelola error.
Membedakan sumber permintaan
Beberapa aplikasi terutama bersifat interaktif, yang mengeluarkan panggilan API secara langsung sebagai respons terhadap tindakan yang dimulai pengguna di UI. Proses lainnya terutama berfungsi secara offline, yang mengeluarkan panggilan API sebagai bagian dari proses backend berkala. Banyak aplikasi yang menggabungkan keduanya. Saat memikirkan pengelolaan error, akan lebih baik jika Anda membedakan berbagai jenis permintaan ini.
Untuk permintaan yang dimulai pengguna, perhatian utama Anda harus 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 (lihat saran di bawah).
Untuk permintaan yang dimulai di backend, terapkan pengendali untuk berbagai jenis error yang mungkin dialami aplikasi Anda. Selalu sertakan pengendali default untuk menangani error yang jarang terjadi atau belum pernah terjadi sebelumnya. Pendekatan yang baik untuk pengendali default adalah menambahkan operasi dan error yang gagal ke antrean agar operator manusia dapat meninjau dan menentukan resolusi yang sesuai.
Membedakan jenis error
Mengetahui perbedaan antara jenis error di Google Ads API sangatlah penting saat mem-build penanganan error yang andal. Beberapa jenis error yang paling umum adalah:
Lihat Jenis Error dan Error Umum untuk mengetahui detail selengkapnya.
Menyinkronkan backend
Jika pengguna aplikasi Anda memiliki akses manual ke akun Google Ads, mereka dapat membuat perubahan yang tidak diketahui aplikasi Anda, sehingga database lokal aplikasi Anda menjadi tidak sinkron. Seperti yang disebutkan dalam panduan Jenis Error kami, 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 harian di semua akun, mengambil objek Google Ads di akun, dan membandingkannya dengan database lokal.
Error log
Semua error harus dicatat untuk memfasilitasi proses debug dan pemantauan. Minimal, catat ID permintaan, operasi yang menyebabkan error, dan error itu sendiri ke dalam log. Informasi lain yang akan dicatat dalam log mencakup ID pelanggan, layanan API, latensi permintaan bolak-balik, jumlah percobaan ulang, serta permintaan dan respons mentah.
Memantau tren
Pastikan untuk memantau tren error API sehingga 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
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. Token developer Anda tidak perlu disetujui untuk digunakan di akun pengujian, sehingga Anda dapat langsung mulai mengembangkan dengan Google Ads API setelah meminta token developer, bahkan sebelum aplikasi Anda ditinjau.