Configuration

La bibliothèque cliente de l'API Ads fournit plusieurs paramètres de configuration que vous pouvez utiliser pour personnaliser le comportement de la bibliothèque.

Fichier de configuration

Vous pouvez spécifier un googleads.properties fichier à utiliser lors de l'instanciation du client.

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

my $api_client = Google::Ads::GoogleAds::Client->new();

la bibliothèque recherche le fichier dans votre répertoire HOME.

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

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

dans ce cas, le client recherche le fichier à cet emplacement.

Pour générer ce fichier, le moyen le plus simple consiste à copier le fichier googleads.properties à partir du dépôt GitHub et à le modifier pour y inclure votre ID client, votre code secret client et votre jeton d'actualisation.

Configuration dynamique

Vous pouvez configurer la configuration de manière dynamique lors de l'instanciation de la bibliothèque, ou même après :

my $api_client = Google::Ads::GoogleAds::Client->new({
  login_customer_id => "INSERT_LOGIN_CUSTOMER_ID_HERE"
});

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

$api_client->set_login_customer_id("INSERT_LOGIN_CUSTOMER_ID_HERE");

Vous pouvez également obtenir un objet OAuth2ApplicationsHandler à partir du API Client, puis modifier l'ID client, le code secret client et le jeton d'actualisation au moment de l'exécution :

my $oauth2_applications_handler = $api_client->get_oauth2_applications_handler();
$oauth2_applications_handler->set_client_id("INSERT_CLIENT_ID");
$oauth2_applications_handler->set_client_secret("INSERT_CLIENT_SECRET");
$oauth2_applications_handler->set_refresh_token("INSERT_REFRESH_TOKEN");

Variables d'environnement de configuration

Vous pouvez définir certains paramètres de configuration à partir de variables d'environnement lors de l' instanciation des clients (consultez la liste exhaustive).

Le module Client fournit la fonction configure_from_environment_variables pour charger les valeurs à partir des variables d'environnement :

# Get the Google Ads Client. By default, any credentials will be read from
# ~/googleads.properties, or, if set, from the file specified in the
# GOOGLE_ADS_CONFIGURATION_FILE_PATH environment variable.
my $api_client = Google::Ads::GoogleAds::Client->new();

# Load the configuration from any set environment variables.
$api_client->configure_from_environment_variables();

Champs de configuration

Les propriétés de configuration acceptent les champs suivants :

Champs conservés dans OAuth2ApplicationsHandler :

  • client_id : votre ID client OAuth2.
  • client_secret : votre code secret client OAuth2.
  • refresh_token : votre jeton d'actualisation OAuth2.

Champs conservés dans le client API :