Tips

Video: Lihat pembahasan praktik terbaik dari workshop 2019

Panduan ini membahas beberapa praktik terbaik yang dapat Anda terapkan untuk mengoptimalkan efisiensi dan performa aplikasi Anda.

Pemeliharaan berkelanjutan

Untuk memastikan aplikasi Anda berjalan tanpa gangguan:

  • Pastikan email kontak developer Anda di Pusat API selalu 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. 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 penggunaan, dan sebagainya, berlanggananlah

Forum ini dipantau secara rutin oleh tim Google Ads API, sehingga menjadikannya tempat yang ideal untuk memposting pertanyaan API.

  • Pastikan aplikasi Anda mematuhi Persyaratan dan Ketentuan (S&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 saat meninjau permohonan token developer Anda.

Pengoptimalan

Operasi batch

Pembuatan permintaan ke API memerlukan sejumlah biaya tetap, seperti latensi jaringan bolak-balik, 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 Anda buat dan biaya tetap terkait. Jika bisa, hindari membuat permintaan dengan satu operasi saja.

Misalnya, Anda menambahkan 50.000 kata kunci ke sebuah 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 mengupdate beberapa kolom dapat mengakibatkan waktu pemrosesan tambahan dan penurunan performa. Untuk mengurangi hal ini, Google Ads API mendukung update sparse, sehingga Anda dapat mengisi kolom pada objek yang perlu diubah atau yang diperlukan saja. Update yang 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 pembaruan singkat karena hanya ID grup iklan, ID kriteria, dan kolom bid yang perlu diisi.

Penanganan dan pengelolaan error

Selama pengembangan, Anda mungkin mengalami error. Bagian ini menjelaskan pertimbangan dan strategi untuk membangun 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 umumnya bersifat interaktif, yang mengeluarkan panggilan API secara langsung sebagai respons terhadap tindakan yang dimulai pengguna di UI. Yang lainnya berfungsi terutama secara offline, melakukan panggilan API sebagai bagian dari proses back-end berkala. Banyak aplikasi menggabungkan keduanya. Ketika memikirkan pengelolaan error, sebaiknya Anda membedakan berbagai jenis permintaan ini.

Untuk permintaan yang dimulai pengguna, perhatian utama Anda adalah harus menyediakan 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 mengatasi error yang jarang terjadi atau tidak pernah terjadi. 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 berbagai jenis error di Google Ads API sangatlah penting saat membuat penanganan error yang andal. Beberapa jenis error yang paling umum adalah:

  1. Error autentikasi
  2. Error yang dapat dicoba lagi
  3. Error validasi
  4. Error terkait sinkronisasi

Lihat Jenis Error dan Error Umum untuk mengetahui detail selengkapnya.

Sinkronisasi backend

Jika pengguna aplikasi Anda memiliki akses manual ke akun Google Ads, mereka dapat 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 malam di semua akun Anda, mengambil objek Google Ads di akun dan membandingkannya dengan database lokal.

Error log

Semua error harus dicatat untuk memfasilitasi proses debug dan pemantauan. Minimalnya, catat ID permintaan, operasi yang menyebabkan error, dan error itu sendiri ke dalam log. Informasi lain yang perlu dicatat meliputi ID pelanggan, layanan API, latensi permintaan bolak-balik, jumlah percobaan ulang, serta permintaan dan respons mentah.

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

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. Token developer 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 ditinjau.