Yapılandırma

Yapılandırma, Config sınıfı kullanılarak yönetilir. İstemciyi yapılandırmak için yapılandırma dosyası kullanabilir, oluşturma sırasında değerleri dinamik olarak belirtebilir veya ortam değişkenlerinden değerleri yükleyebilirsiniz.

Yapılandırma dosyası

İstemciyi örneklendirirken kullanılacak bir google_ads_config.rb dosyası belirtebilirsiniz.

Bir GoogleAdsClient nesnesini örneklendirirken 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) google_ads_config.rb adlı bir dosya.

Alternatif olarak, GoogleAdsClient nesnesini örneklendirirken açık bir yol iletebilirsiniz:

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

Bu dosyayı oluşturmak için GitHub deposundan google_ads_config.rb dosyasını 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ığı örneklendirirken yapılandırmayı dinamik olarak ayarlayabilirsiniz:

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

Örneklendirmeden sonra da yapılandırmayı 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 yetki (GOOGLE_ADS_IMPERSONATED_EMAIL) ile bir hizmet hesabı kullanırken kimliğine bürünülecek e-posta adresi.
  • use_application_default_credentials: Uygulama Varsayılan Kimlik Bilgileri'ni (GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS) kullanarak kimlik doğrulaması yapmak için true olarak ayarlayın. google-ads-googleads 36.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'yi geçersiz kılar.
  • login_customer_id: login-customer-id belgelerine (GOOGLE_ADS_LOGIN_CUSTOMER_ID) göz atın.
  • linked_customer_id: Bağlı müşteri kimliği (GOOGLE_ADS_LINKED_CUSTOMER_ID).
  • ads_assistant: Google Ads API Assistant ü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: Desteği sonlandırılan kitaplık kodu çağrıldığında Warning#warn işlevini çağırmak yerine bir istisna oluşturun (varsayılan olarak false).
  • warn_on_all_deprecations: Her çağrı sitesi için bir kez yerine her çağrıda desteğin sonlandırılması uyarısı verilir (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 mesajları. Örneğin, 'DEBUG' belirtildiğinde tüm mesajlar günlüğe kaydedilir, 'INFO' belirtildiğinde ise DEBUG mesajları hariç tutulur ve diğer tüm mesajlar gösterilir.
  • log_target: Günlük kaydı yapmak istediğiniz yer (ör. STDERR veya bir yol).
  • logger: Kendi özel kaydedicinizi belirtin. Bu ayarın belirtilmesi hem log_level hem de log_target ayarını geçersiz kılar.

Ortam değişkenleri

İstemci kitaplığını ortam değişkenlerini kullanarak yapılandırabilirsiniz. Varsayılan olarak yüklenmezler ve yüklenmeleri için istemci örneklendirildikten sonra açık bir çağrı yapılması gerekir. Standart ortam değişkenlerinin tam listesini inceleyin.

Ortam değişkenlerini Config ortamınıza yüklemek için load_environment_config komutunu çağırın:

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

load_environment_config her çağrıldığında, tanımlanan tüm ortam değişkenleri Config içinde mevcut olan karşılık gelen değerlerin üzerine yazılır (ayarlanmamış ortam değişkenleri, mevcut yapılandırma değerlerini değiştirmez). Bu mekanizma sayesinde varsayılan bir yapılandırma dosyası kullanabilir ve ortam değişkenlerini kullanarak belirli değerleri geçersiz kılabilir ya da 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.