پیکربندی

کتابخانه کارخواه Java به‌دنبال فایل پیکربندی‌ای به‌نام ads.properties در دایرکتوری اصلی شما (System.getProperty("user.home") + "/ads.properties" یا ~/ads.properties) می‌گردد. می‌توانید این مسیر و نام فایل را در زمان اجرا هنگام ساختن GoogleAdsClient بااستفاده از یکی از سازوکارهای زیر لغو کنید:

  • fromPropertiesFile(PATH_TO_CONFIG_FILE) را فراخوانی کنید، که در آن PATH_TO_CONFIG_FILE File مسیر و نام فایل پیکربندی شما است.
  • متغیر محیطی GOOGLE_ADS_CONFIGURATION_FILE_PATH را روی مسیر و نام فایل پیکربندی‌تان تنظیم کنید و سپس fromPropertiesFile() را فراخوانی کنید.

قالب فایل پیکربندی یک فایل استاندارد Java Properties از جفت‌های کلید-مقدار است. کلیدهای پشتیبانی‌شده بسته به جریان اصالت‌سنجی انتخاب‌شده متفاوت است.

کلیدهای پشتیبانی‌شده برای جریان‌های برنامه وب و رایانه

اگر از جریان برنامه تک‌کاربره یا چندکاربره استفاده می‌کنید، کلیدهای پشتیبانی‌شده به این شرح است:

# 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

کلیدهای پشتیبانی‌شده برای حساب‌های سرویس

اگر از جریان حساب سرویس استفاده می‌کنید، کلیدهای پشتیبانی‌شده به‌شرح زیر است:

# 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

استفاده از متغیرهای محیط

این کتابخانه از همه متغیرهای محیطی کتابخانه کارخواه Google Ads API استاندارد پشتیبانی می‌کند. جدول زیر متغیر محیطی را نشان می‌دهد که با هر ویژگی فایل پیکربندی مطابقت دارد:

دارایی فایل پیکربندی متغیر محیط
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

پس‌از تنظیم متغیرهای محیطی مناسب، GoogleAdsClient خود را با فراخوانی fromEnvironment() در سازنده پیکربندی کنید:

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

ترکیب کردن رویکردهای پیکربندی

‫GoogleAdsClient و سازنده آن از ترکیب استراتژی‌های پیکربندی مختلف پشتیبانی می‌کنند. برای مثال، می‌توانید از متغیرهای محیطی برای پیکربندی اعتبارنامه نمونه و از فایل ویژگی‌ها برای سایر مشخصه‌ها بااستفاده از قطعه کد زیر استفاده کنید:

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

می‌توانید قبل‌از فراخوانی build()، بااستفاده از دیگر روش‌های پیکربندی سازنده، تغییرات بیشتری در زمان اجرا ایجاد کنید.