Praktik Terbaik

Video: Lihat workshop praktik terbaik dari workshop 2019

Panduan ini mencakup beberapa praktik terbaik yang dapat diterapkan untuk mengoptimalkan efisiensi dan performa aplikasi.

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 sebelumnya. Hindari menggunakan alamat email pribadi yang terkait dengan akun perorangan atau yang tidak dipantau.

  • Untuk mendapatkan informasi tentang masalah seperti perubahan produk, periode nonaktif pemeliharaan, tanggal penghentian, dan sebagainya, berlangganan

Forum ini dipantau secara rutin oleh tim Google Ads API, menjadikannya 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. Jika ada pertanyaan atau kekhawatiran terkait T&C, Anda dapat menghubungi tim peninjau dengan menanggapi email yang mereka kirimkan saat meninjau permohonan token developer Anda.

Pengoptimalan

Operasi kelompok

Pembuatan permintaan ke API memerlukan sejumlah biaya tetap, seperti latensi jaringan bolak-balik, pemrosesan serialisasi dan deserialisasi, dan panggilan ke sistem back-end. Untuk mengurangi dampak biaya tetap ini dan meningkatkan performa secara keseluruhan, sebagian besar metode mutasi di API didesain 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 hanya dengan satu operasi.

Misalnya, Anda menambahkan 50.000 kata kunci ke kampanye di beberapa grup iklan. Buat 50.000 permintaan dengan masing-masing 1 kata kunci, buat 100 permintaan masing-masing dengan 500 kata kunci, atau bahkan 10 permintaan dengan masing-masing 5.000 kata kunci. Ada batas jumlah operasi yang diizinkan dalam permintaan, sehingga Anda mungkin perlu menyesuaikan ukuran batch untuk mencapai performa yang optimal.

Mengirim objek sparse

Ketika objek dikirim ke API, kolom harus dideserialisasi, divalidasi, dan disimpan dalam database. Meneruskan objek penuh saat Anda hanya ingin memperbarui beberapa kolom dapat mengakibatkan waktu pemrosesan tambahan dan penurunan performa. Untuk mengatasi hal ini, Google Ads API mendukung update renggang, sehingga Anda hanya dapat mengisi kolom dalam objek yang perlu diubah atau yang diperlukan. Update yang jarang akan diproses lebih cepat dan cenderung tidak menghasilkan error. Kolom yang tidak berada dalam update_mask (juga dikenal sebagai FieldMask) tidak diubah.

Misalnya, aplikasi yang memperbarui bid tingkat kata kunci dapat memanfaatkan penggunaan pembaruan jarang, karena hanya kolom ID iklan, ID kriteria, dan bid yang harus diisi.

Penanganan dan pengelolaan error

Selama pengembangan, Anda mungkin mengalami error. Bagian ini menjelaskan pertimbangan dan strategi untuk mem-build pengelolaan error ke dalam aplikasi Anda. Selain bagian ini, kunjungi Panduan pemecahan masalah untuk informasi selengkapnya tentang pengelolaan error.

Membedakan sumber permintaan

Beberapa aplikasi terutama interaktif, mengeluarkan panggilan API secara langsung sebagai respons terhadap tindakan yang dimulai pengguna di UI. Metode lainnya berfungsi terutama secara offline, dengan membuat panggilan API sebagai bagian dari proses back-end berkala. Banyak aplikasi menggabungkan keduanya. Saat memikirkan pengelolaan error, akan berguna untuk membedakan jenis permintaan yang berbeda.

Untuk permintaan yang dimulai pengguna, fokus utama Anda adalah memberikan pengalaman yang baik bagi pengguna. Gunakan error spesifik yang terjadi untuk memberikan konteks sebanyak mungkin kepada pengguna di UI. Menawarkan langkah-langkah mudah yang dapat mereka ambil untuk mengatasi error (lihat saran di bawah).

Untuk permintaan yang dimulai dari belakang, terapkan pengendali untuk berbagai jenis error yang mungkin dialami aplikasi Anda. Selalu sertakan pengendali default untuk mengatasi error yang jarang terjadi atau yang belum pernah terjadi sebelumnya. Pendekatan yang baik bagi pengendali default adalah menambahkan operasi yang gagal dan error ke antrean agar operator manusia dapat meninjau dan menentukan resolusi yang sesuai.

Membedakan jenis error

Mengetahui perbedaan antara berbagai jenis error di Google Ads API sangat 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 detail selengkapnya.

Backend sinkronisasi berakhir

Jika pengguna aplikasi Anda memiliki akses manual ke akun Google Ads, mereka dapat membuat perubahan yang tidak diketahui oleh aplikasi Anda, yang 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 per malam di semua akun, mengambil objek Google Ads di akun, dan membandingkan dengan database lokal Anda.

Error log

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

Pastikan untuk memantau tren dalam error API sehingga Anda dapat mendeteksi dan mengatasi masalah dengan 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 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 dengan Google Ads API segera setelah meminta token developer, bahkan sebelum aplikasi Anda ditinjau.