Configuration

La configuration est effectuée à l'aide d'une classe Config. Vous pouvez accéder à ce cours dans plusieurs de différentes manières, par exemple en rédigeant un fichier de configuration, en spécifiant des valeurs lors de la création, ou charger des valeurs à partir de variables d'environnement.

Fichier de configuration

Vous pouvez spécifier un google_ads_config.rb à utiliser lors de l'instanciation du client.

Si vous n'utilisez aucun argument lors de l'instanciation:

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

la bibliothèque recherche l'emplacement spécifié dans GOOGLE_ADS_CONFIGURATION_FILE_PATH. Si cette variable est n'est pas défini, la bibliothèque recherche le fichier dans votre répertoire HOME.

Vous pouvez également spécifier un chemin d'accès:

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

auquel cas le client recherchera le fichier à ce chemin de fichier.

Le moyen le plus simple de générer ce fichier consiste à copier google_ads_config.rb à partir de dans le dépôt GitHub et modifiez-le pour y inclure votre jeton d'actualisation, votre ID client et le code secret du client.

Configuration dynamique

Vous pouvez définir la configuration de manière dynamique lorsque vous instanciez la bibliothèque. ou après:

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

Vous pouvez même modifier la configuration après l'instanciation:

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

Champs de configuration

L'objet Config accepte les champs suivants.

Champs généraux:

  • refresh_token: votre jeton d'actualisation OAuth.
  • client_id: votre ID client OAuth.
  • client_secret: votre code secret du client OAuth.
  • developer_token: votre jeton de développeur pour accéder à l'API.
  • login_customer_id: consultez les documentation sur login-customer-id.

Champs de journalisation Pour en savoir plus, consultez le guide de journalisation.

  • log_level: messages de niveau de journalisation minimaux que vous souhaitez consigner. Par exemple : en spécifiant 'DEBUG' pour voir tous les messages de journal, et en spécifiant 'INFO' exclura les messages DEBUG, mais affichera tous les autres messages.
  • log_target: l'emplacement où vous souhaitez vous connecter, par exemple STDERR.
  • logger: spécifiez votre propre enregistreur personnalisé. Si vous spécifiez cette valeur, les deux log_level et log_target.

Variables d'environnement

Vous pouvez configurer la bibliothèque cliente à l'aide de variables d'environnement. Ce n'est pas le cas par défaut et nécessitent un appel supplémentaire après avoir instancié pour le chargement. Consultez la liste complète des variables d'environnement. pris en charge par tous langues.

Pour charger les variables d'environnement dans votre Config, appelez load_environment_config:

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

À chaque appel, l'état actuel des variables d'environnement écrasera tout ce qui est déjà présent dans Config. Grâce à cette par défaut, vous pouvez par exemple avoir une configuration par défaut à l'aide de variables d'environnement, ou vous pouvez configurer variables d'environnement.

Outre les variables d'environnement compatibles avec toutes les bibliothèques, bibliothèque contient deux variables supplémentaires:

  • GOOGLE_ADS_RUBY_LOG_LEVEL: comme log_level ci-dessus.
  • GOOGLE_ADS_RUBY_HTTP_PROXY: spécifiez un proxy HTTP.