Praktik terbaik

Panduan ini membahas 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 yang terbaru. Kami akan menghubungi pengguna ini jika terjadi keadaan darurat atau topik yang terkait dengan 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, periode nonaktif pemeliharaan, dan tanggal penghentian penggunaan, berlanggananlah ke blog API dan blog Produk kami.

  • Pastikan aplikasi Anda mematuhi Persyaratan dan Ketentuan (P&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 mereka kirimkan kepada Anda saat meninjau permohonan akses API Anda.

Pengoptimalan

Anda dapat mengoptimalkan aplikasi dengan menjalankan operasi batch dan, jika sesuai, mengirim objek sparse.

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 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, jadi Anda mungkin perlu menyesuaikan ukuran batch untuk mencapai performa yang optimal.

Mengirim objek sparse

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 update sparse, sehingga Anda dapat mengisi hanya kolom dalam objek yang perlu diubah atau yang diperlukan. Pembaruan sparse diproses lebih cepat dan cenderung tidak menghasilkan error. Kolom yang tidak ada dalam update_mask (juga dikenal sebagai FieldMask) tidak akan diubah.

Misalnya, aplikasi yang memperbarui bid tingkat kata kunci dapat memperoleh manfaat dari penggunaan pembaruan sparse, 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 cara mengelola error.

Membedakan sumber permintaan

Beberapa aplikasi utamanya bersifat interaktif, yang 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 yang menggabungkan keduanya. Saat memikirkan pengelolaan error, sebaiknya bedakan 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 dialami aplikasi Anda. Selalu sertakan pengendali default untuk menangani error yang jarang terjadi atau yang 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 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 melakukan perubahan yang tidak diketahui oleh aplikasi Anda, sehingga menyebabkan database lokal aplikasi Anda tidak sinkron. 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 merekonsiliasi database lokal Anda dengan objek Google Ads di akun Anda. Untuk hierarki akun yang besar, hindari menarik semua objek di setiap akun setiap malam untuk mencegah habisnya kuota harian; sebagai gantinya, buat kueri ChangeStatus atau filter untuk entitas yang baru diubah guna menyinkronkan perubahan secara bertahap.

Error log

Semua error harus dicatat untuk memfasilitasi proses debug dan pemantauan. Minimal, catat ID permintaan, operasi yang menyebabkan error, dan error itu sendiri. Informasi lain yang perlu dicatat mencakup ID pelanggan, layanan API, latensi permintaan bolak-balik, jumlah percobaan ulang, serta permintaan dan respons mentah yang telah dibersihkan (pastikan untuk menyamarkan kredensial sensitif seperti token OAuth dan PII apa pun).

Pastikan untuk memantau tren error API agar Anda dapat mendeteksi dan mengatasi masalah pada aplikasi. Pertimbangkan untuk membangun solusi Anda sendiri atau menggunakan salah satu dari banyak alat komersial yang tersedia yang dapat menggunakan log Anda untuk menghasilkan dasbor interaktif dan mengirim pemberitahuan otomatis.

Pengembangan

Gunakan akun pengujian selama pengembangan.

Menggunakan akun pengujian

Akun pengujian adalah akun Google Ads yang sebenarnya tidak 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, sembari menunggu Google meninjau permohonan Anda untuk tingkat akses API yang lebih tinggi.