Configuration

La bibliothèque cliente Java recherche un fichier de configuration nommé ads.properties dans votre répertoire d'accueil (System.getProperty("user.home") + "/ads.properties" ou ~/ads.properties). Vous pouvez remplacer ce chemin d'accès et ce nom de fichier au moment de l'exécution lors de la construction de GoogleAdsClient à l'aide de l'un des mécanismes suivants :

  • Appelez fromPropertiesFile(PATH_TO_CONFIG_FILE), où PATH_TO_CONFIG_FILE correspond au chemin d'accès et au nom de fichier File de votre fichier de configuration.
  • Définissez la variable d'environnement GOOGLE_ADS_CONFIGURATION_FILE_PATH sur le chemin d'accès et le nom de fichier de votre fichier de configuration, puis appelez fromPropertiesFile().

Le format du fichier de configuration est un fichier Properties Java standard de paires clé/valeur. Les clés compatibles varient en fonction du flux d'authentification choisi.

Clés compatibles pour les flux d'applications de bureau et Web

Si vous utilisez le flux d'application à un seul utilisateur ou à plusieurs utilisateurs, les clés compatibles sont les suivantes :

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
api.googleads.clientId=INSERT_CLIENT_ID_HERE

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE

# Renewable OAuth credential associated with 1 or more Google Ads accounts.
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

# Only required if explicitly instructed by the service documentation.
# api.googleads.linkedCustomerId=INSERT_LINKED_CUSTOMER_ID_HERE

# Maximum allowed response payload size, in bytes.
# Customize this to allow response sizes for GoogleAdsService.search and
# GoogleAdsService.searchStream API calls to exceed the default limit of 64MB.
# api.googleads.maxInboundMessageBytes=INSERT_MAX_INBOUND_MESSAGE_BYTES_HERE

# Specifies whether to use Application Default Credentials.
api.googleads.useApplicationDefaultCredentials=false

Clés acceptées pour les comptes de service

Si vous utilisez le flux de compte de service, les clés compatibles sont les suivantes :

# Path to the service account secrets file in JSON format.
# Provided by console.cloud.google.com.
api.googleads.serviceAccountSecretsPath=INSERT_PATH_TO_JSON_HERE

# Optional: Email address of the user to impersonate when using Google Workspace
# domain-wide delegation. This should be a user who has access to your Google Ads
# account and is in the same Google Workspace domain as the service account.
# api.googleads.serviceAccountUser=INSERT_USER_EMAIL_ADDRESS_HERE

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Utiliser des variables d'environnement

La bibliothèque est compatible avec toutes les variables d'environnement standards des bibliothèques clientes de l'API Google Ads. Le tableau suivant indique la variable d'environnement qui correspond à chaque propriété du fichier de configuration :

Propriété du fichier de configuration Variable d'environnement
api.googleads.clientId GOOGLE_ADS_CLIENT_ID
api.googleads.clientSecret GOOGLE_ADS_CLIENT_SECRET
api.googleads.refreshToken GOOGLE_ADS_REFRESH_TOKEN
api.googleads.serviceAccountSecretsPath GOOGLE_ADS_JSON_KEY_FILE_PATH
api.googleads.serviceAccountUser GOOGLE_ADS_IMPERSONATED_EMAIL
api.googleads.loginCustomerId GOOGLE_ADS_LOGIN_CUSTOMER_ID
api.googleads.linkedCustomerId GOOGLE_ADS_LINKED_CUSTOMER_ID
api.googleads.maxInboundMessageBytes GOOGLE_ADS_MAX_INBOUND_MESSAGE_BYTES
api.googleads.useApplicationDefaultCredentials GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS

Une fois que vous avez défini les variables d'environnement appropriées, configurez votre GoogleAdsClient en appelant fromEnvironment() sur le générateur :

GoogleAdsClient googleAdsClient =
    GoogleAdsClient.newBuilder()
        .fromEnvironment()
        .build();

Combiner les approches de configuration

GoogleAdsClient et son générateur permettent de combiner différentes stratégies de configuration. Par exemple, vous pouvez utiliser des variables d'environnement pour configurer les identifiants de l'instance et un fichier de propriétés pour d'autres attributs à l'aide de l'extrait de code suivant :

GoogleAdsClient googleAdsClient =
    GoogleAdsClient.newBuilder()
        .fromEnvironment()
        .fromPropertiesFile()
        .build();

Vous pouvez apporter d'autres modifications au moment de l'exécution à l'aide des autres méthodes de configuration du compilateur avant d'appeler build().