Penggunaan dasar library klien adalah sebagai berikut:
Penginstalan
Cara yang direkomendasikan untuk menginstal library adalah dengan menggunakan Bundler. Tambahkan baris
ke Gemfile (ganti x.y.z dengan nomor versi yang ingin Anda gunakan):
gem 'google-ads-googleads', '~> x.y.z'
Kemudian, jalankan:
bundle install
Perintah ini menggunakan Bundler untuk mengupdate Gemfile.lock Anda, mengunci ke versi
gem yang tepat dan semua dependensi gem yang diinstal. Operator versi pesimistis "~> x.y.z" memastikan bahwa bundle install atau bundle update hanya menginstal versi patch baru dalam seri x.y.*, sehingga Anda harus memilih versi minor atau mayor baru secara manual dengan mengupdate Gemfile.
Opsi penginstalan lainnya
Jika tidak menggunakan Bundler, Anda dapat menggunakan salah satu opsi berikut:
Instal library ini menggunakan RubyGems:
gem install google-ads-googleadsDownload gem dari halaman Rilis dan instal dari file lokal:
gem install google-ads-googleads-[version].gem
Menyiapkan autentikasi
Untuk mengautentikasi panggilan API, konfigurasikan file google_ads_config.rb dan
ikuti petunjuk di halaman
Autentikasi dan otorisasi.
Penggunaan
Mulai dari google-ads-googleads v41.1.0, gem mendukung autorequire Bundler (Bundler.require). Pada versi sebelum v41.1.0 (atau jika tidak menggunakan Bundler.require), gem harus secara eksplisit diperlukan dalam kode Anda:
require 'google/ads/google_ads'
Lakukan inisialisasi klien (yang memuat konfigurasi dari ~/google_ads_config.rb
secara default) dan ambil layanan tertentu, seperti CampaignService:
# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Fetch the CampaignService client.
campaign_service = client.service.campaign
Lihat contoh di GitHub untuk demonstrasi yang lebih mendetail tentang cara menggunakan library.
Setelah Anda memahami contohnya, pelajari factory, yang menyediakan serangkaian metode praktis tingkat tinggi untuk menggunakan Google Ads API.
Penanganan error
Tidak semua panggilan API berhasil. Server akan memunculkan pengecualian jika panggilan API Anda gagal. Penting untuk menangkap error API dan menanganinya dengan tepat.
Instance Google::Ads::GoogleAds::Errors::GoogleAdsError akan muncul saat terjadi error API. Objek ini berisi detail untuk membantu Anda menentukan masalahnya, dan
Anda dapat menyiapkan fungsi bantuan untuk menangani error. Lihat contoh
pengendali error di GitHub.