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 fichier googleads.properties à 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 alors 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 recherchera le fichier à ce chemin d'accès.

Le moyen le plus simple de générer ce fichier consiste à copier googleads.properties à partir du dépôt GitHub et à le modifier pour inclure votre ID client, votre 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 par la suite:

my $api_client = Google::Ads::GoogleAds::Client->new({
  developer_token   => "INSERT_DEVELOPER_TOKEN_HERE",
  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 de API Client et modifier l'ID client, le 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 des paramètres de configuration à partir de variables d'environnement lors de l'instanciation de clients (voir la liste exhaustive).

Le module Client fournit la fonction configure_from_environment_variables pour charger des valeurs à partir de 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 persistants dans OAuth2ApplicationsHandler:

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

Champs persistants dans le client API:

  • developer_token: votre jeton de développeur pour accéder à l'API.
  • login_customer_id: consultez la documentation sur login-customer-id.
  • proxy: URL du serveur proxy utilisé pour la connectivité Internet.