Konfigurasi

Konfigurasi dilakukan menggunakan class Config. Anda dapat mengakses class ini dengan beberapa cara, seperti menulis file konfigurasi, menentukan nilai saat pembuatan, atau memuat nilai dari variabel lingkungan.

File konfigurasi

Anda dapat menentukan file google_ads_config.rb yang akan digunakan saat membuat instance klien.

Jika Anda tidak menggunakan argumen saat membuat instance:

client = Google::Ads::GoogleAds::GoogleAdsClient.new

library akan terlihat di lokasi yang ditentukan dalam variabel lingkungan GOOGLE_ADS_CONFIGURATION_FILE_PATH. Jika variabel tersebut tidak ditetapkan, library akan mencari file tersebut di direktori HOME Anda.

Atau, Anda dapat menentukan jalur:

client = Google::Ads::GoogleAds::GoogleAdsClient.new("path/to/file.rb")

dalam hal ini klien akan mencari file pada jalur file tersebut.

Cara termudah untuk membuat file ini adalah dengan menyalin google_ads_config.rb dari repositori GitHub dan mengubahnya agar menyertakan token refresh, client ID, dan rahasia klien Anda.

Konfigurasi dinamis

Anda dapat menyiapkan konfigurasi secara dinamis saat membuat instance library, atau bahkan setelahnya:

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  # ... more configuration
end

Anda bahkan dapat memodifikasi konfigurasi setelah pembuatan instance:

client.configure do |config|
  config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
  # ... more configuration
end

Kolom konfigurasi

Objek Config mendukung kolom berikut.

Kolom umum:

  • refresh_token: Token refresh OAuth Anda.
  • client_id: Client ID OAuth Anda.
  • client_secret: Rahasia klien OAuth Anda.
  • developer_token: Token developer Anda untuk mengakses API.
  • login_customer_id: Lihat dokumentasi login-customer-id.

Kolom logging. Lihat panduan pembuatan log untuk detail selengkapnya.

  • log_level: Pesan level log minimum yang ingin Anda catat. Misalnya, menentukan 'DEBUG' akan memastikan Anda melihat semua pesan log, dan menentukan 'INFO' akan mengecualikan pesan DEBUG, tetapi menampilkan semua pesan lainnya.
  • log_target: Tempat Anda ingin login, seperti STDERR.
  • logger: Menentukan pencatat log kustom Anda sendiri. Menentukan hal ini akan mengganti log_level dan log_target.

Variabel lingkungan

Anda dapat mengonfigurasi library klien menggunakan variabel lingkungan. Pengujian ini tidak dimuat secara default, dan memerlukan panggilan tambahan setelah membuat instance klien agar dapat dimuat. Lihat daftar lengkap variabel lingkungan yang didukung oleh semua bahasa.

Untuk memuat variabel lingkungan ke dalam Config, panggil load_environment_config:

client = Google::Ads::GoogleAds::GoogleAdsClient.new
client.load_environment_config

Setiap kali metode ini dipanggil, status variabel lingkungan saat ini akan menimpa apa pun yang sudah ada dalam Config. Dengan mekanisme ini, misalnya Anda dapat memiliki konfigurasi default, tetapi mengganti nilai tertentu menggunakan variabel lingkungan, atau Anda dapat sepenuhnya mengonfigurasi dengan variabel lingkungan.

Selain variabel lingkungan yang didukung oleh semua library, library Ruby memiliki dua variabel tambahan:

  • GOOGLE_ADS_RUBY_LOG_LEVEL: Seperti log_level di atas.
  • GOOGLE_ADS_RUBY_HTTP_PROXY: Menentukan proxy HTTP.