Yapılandırma

Yapılandırma, Config sınıfı kullanılarak yönetilir. İstemciyi yapılandırma dosyası kullanarak, oluşturma sırasında değerleri dinamik olarak belirterek veya değerleri ortam değişkenlerinden yükleyerek yapılandırabilirsiniz.

Yapılandırma dosyası

İstemciyi oluştururken kullanılacak bir google_ads_config.rb dosyası belirtebilirsiniz.

Bir GoogleAdsClient nesnesini oluştururken herhangi bir bağımsız değişken iletmezseniz kitaplık, yapılandırma dosyasını aşağıdaki sırayla arar:

  1. GOOGLE_ADS_CONFIGURATION_FILE_PATH ortam değişkeninde belirtilen yol.
  2. HOME dizininizde google_ads_config.rb adlı bir dosya (~/google_ads_config.rb).

Alternatif olarak, GoogleAdsClient nesnesini oluştururken açık bir yol da iletebilirsiniz:

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

Bu dosyayı oluşturmak için GitHub deposundan google_ads_config.rb öğesini kopyalayın ve yenileme jetonunuzu, istemci kimliğinizi ve istemci gizli anahtarınızı içerecek şekilde değiştirin.

Dinamik yapılandırma

Kitaplığı oluştururken yapılandırmayı dinamik olarak ayarlayabilirsiniz:

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

Ayrıca, yapılandırmayı örnek oluşturma işleminden sonra da değiştirebilirsiniz (bu işlem, başlatma sırasında yüklenen ayarları geçersiz kılar):

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

Yapılandırma alanları

Config nesnesi aşağıdaki alanları destekler.

Genel alanlar:

  • refresh_token: OAuth yenileme jetonunuz (GOOGLE_ADS_REFRESH_TOKEN).
  • client_id: OAuth istemci kimliğiniz (GOOGLE_ADS_CLIENT_ID).
  • client_secret: OAuth istemci gizli anahtarınız (GOOGLE_ADS_CLIENT_SECRET).
  • keyfile: Hizmet hesabı JSON anahtar dosyasının yolu (GOOGLE_ADS_JSON_KEY_FILE_PATH).
  • impersonate: Alan genelinde yetkiyle (GOOGLE_ADS_IMPERSONATED_EMAIL) hizmet hesabı kullanırken kimliğine bürünülecek e-posta adresi.
  • use_application_default_credentials: Uygulama Varsayılan Kimlik Bilgileri (GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS) kullanılarak kimlik doğrulama için true olarak ayarlayın. google-ads-googleads v36.1.0 ve sonraki sürümlerde desteklenir.
  • authentication: Proc (updater_proc), anahtar dosyası yolu veya Hash ya da GRPC::Core::Channel / GRPC::Core::ChannelCredentials gibi özel kimlik doğrulama nesnesi. client_id, client_secret, refresh_token ve keyfile'ü geçersiz kılar.
  • login_customer_id: login-customer-id dokümanlarına (GOOGLE_ADS_LOGIN_CUSTOMER_ID) bakın.
  • linked_customer_id: Bağlı müşteri kimliği (GOOGLE_ADS_LINKED_CUSTOMER_ID).
  • ads_assistant: Google Ads API Yardımcısı üstbilgisi için isteğe bağlı tanımlayıcı (GOOGLE_ADS_ASSISTANT; v37.0.0'da gaada olarak eklendi ve v39.0.0'da ads_assistant olarak yeniden adlandırıldı).
  • http_proxy: İsteğe bağlı HTTP veya HTTPS proxy URI'si (GOOGLE_ADS_RUBY_HTTP_PROXY).
  • api_endpoint: İsteğe bağlı API uç noktası geçersiz kılma (GOOGLE_ADS_ENDPOINT).
  • treat_deprecation_warnings_as_errors: Kullanımdan kaldırılan kitaplık kodu çağrıldığında Warning#warn işlevini çağırmak yerine istisna oluşturur (varsayılan olarak false).
  • warn_on_all_deprecations: Her çağrıda bir kez yerine her çağrı sitesinde bir kez kullanımdan kaldırma uyarısı yayınlayın (varsayılan olarak false).

Günlük alanları (tüm ayrıntılar için günlük kaydı kılavuzuna bakın):

  • log_level: Günlüğe kaydedilmesini istediğiniz minimum günlük düzeyi iletileri. Örneğin, 'DEBUG' belirtildiğinde tüm iletiler kaydedilir ve 'INFO' belirtildiğinde DEBUG iletileri hariç tutulur ve diğer tüm iletiler gösterilir.
  • log_target: STDERR veya bir yol gibi, günlük oluşturmak istediğiniz yer.
  • logger: Kendi özel kaydedicinizi belirtin. Bu özelliğin belirtilmesi hem log_level hem de log_target özelliğini geçersiz kılar.

Ortam değişkenleri

Ortam değişkenlerini kullanarak istemci kitaplığını yapılandırabilirsiniz. Varsayılan olarak yüklenmezler ve yüklenmeleri için istemci oluşturulduktan sonra açıkça çağrılmaları gerekir. Standart ortam değişkenlerinin tam listesini inceleyin.

Ortam değişkenlerini Config'nize yüklemek için load_environment_config'i çağırın:

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

load_environment_config her çağrıldığında, tanımlanan ortam değişkenleri Config içinde bulunan ilgili değerlerin üzerine yazar (ayarlanmamış ortam değişkenleri mevcut yapılandırma değerlerini değiştirmeden bırakır). Bu mekanizma sayesinde, varsayılan bir yapılandırma dosyasını koruyabilir ve ortam değişkenlerini kullanarak belirli değerleri geçersiz kılabilir veya istemciyi tamamen ortam değişkenleriyle yapılandırabilirsiniz.

Ruby kitaplığı, standart ortam değişkenlerine ek olarak iki değişkeni daha destekler:

  • GOOGLE_ADS_RUBY_LOG_LEVEL: Daha önce açıklandığı gibi log_level ile eşdeğerdir.
  • GOOGLE_ADS_RUBY_HTTP_PROXY: Bir HTTP proxy URL'si belirtin.