Konfigurasi

{i>Library<i} ini mencari file konfigurasi di System.getProperty("user.home") + "/ads.properties". Anda dapat menggantinya jalur dan nama file saat runtime ketika membuat GoogleAdsClient menggunakan salah satu dari mekanisme berikut:

  • Panggil fromPropertiesFile(PATH_TO_CONFIG_FILE), dengan PATH_TO_CONFIG_FILE adalah jalur dan nama file dari file konfigurasi Anda.
  • Tetapkan variabel lingkungan GOOGLE_ADS_CONFIGURATION_FILE_PATH ke jalur dan nama file dari file konfigurasi Anda, dan kemudian panggil fromPropertiesFile().

Format file konfigurasi adalah file Java Properti file pasangan nilai kunci. Kunci yang didukung bervariasi, bergantung pada kunci yang dipilih alur otentikasi.

Kunci yang didukung untuk alur aplikasi web dan desktop

Jika Anda menggunakan desktop atau alur aplikasi web, kunci yang didukung adalah sebagai berikut:

# 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

# Token which provides access to the Google Ads API in general. It does not
# grant access to any particular ad account (OAuth is used for this purpose).
api.googleads.developerToken=INSERT_DEVELOPER_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

Kunci yang didukung untuk akun layanan

Jika Anda menggunakan akun layanan , kunci yang didukung adalah sebagai berikut:

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

# Email address of the user to impersonate.
# This should be a user who has access to your Google Ads account and is in the same
# Google Apps Domain as the service account.
api.googleads.serviceAccountUser=INSERT_USER_EMAIL_ADDRESS_HERE

# Token which provides access to the Google Ads API in general. It does not
# grant access to any particular ad account (OAuth is used for this purpose).
api.googleads.developerToken=INSERT_DEVELOPER_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

Menggunakan variabel lingkungan

Pustaka ini mendukung semua variabel lingkungan yang umum untuk semua Google Ads API library klien. Tabel di bawah menunjukkan yang sesuai dengan setiap properti file konfigurasi.

Properti file konfigurasi Variabel lingkungan
api.googleads.developerToken GOOGLE_ADS_DEVELOPER_TOKEN
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

Setelah Anda menetapkan variabel lingkungan yang sesuai, konfigurasikan GoogleAdsClient dengan memanggil fromEnvironment() pada builder.

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

Menggabungkan pendekatan konfigurasi

GoogleAdsClient dan builder-nya mendukung penggabungan berbagai konfigurasi dan strategi. Misalnya, Anda dapat menggunakan variabel lingkungan untuk mengonfigurasi kredensial instance dan file properti untuk atribut lain yang menggunakan cuplikan berikut.

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

Dalam contoh ini, library klien akan menggunakan nilai dari file properti untuk setiap atribut yang didefinisikan baik melalui variabel lingkungannya maupun entri di file properti. Untuk kebalikannya, cukup panggil fromPropertiesFile() sebelum fromEnvironment().

Anda dapat membuat perubahan lebih lanjut pada saat runtime menggunakan konfigurasi lain dari builder sebelum memanggil build().