תצורה

הספרייה מחפשת קובץ תצורה ב-System.getProperty("user.home") + "/ads.properties". אפשר לשנות את הנתיב ואת שם הקובץ בזמן הריצה כשיוצרים את GoogleAdsClient באמצעות אחד מהמנגנונים הבאים:

• מפעילים את הפקודה fromPropertiesFile(PATH_TO_CONFIG_FILE), כאשר PATH_TO_CONFIG_FILE הוא הנתיב ושם הקובץ של קובץ התצורה.
• מגדירים את משתנה הסביבה GOOGLE_ADS_CONFIGURATION_FILE_PATH לנתיב ולשם הקובץ של קובץ התצורה, ואז קוראים ל-fromPropertiesFile().

הפורמט של קובץ ההגדרות הוא של קובץ Properties של Java שמכיל צמדי מפתח-ערך. המקשים הנתמכים משתנים בהתאם לתהליך האימות שנבחר.

מפתחות נתמכים לתהליכי עבודה של אפליקציות למחשב ולאינטרנט

אם אתם משתמשים בתהליך של אפליקציית דסקטופ או אינטרנט, המקשים הנתמכים הם:

# 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

מפתחות נתמכים לחשבונות שירות

אם אתם משתמשים בתהליך של חשבון שירות, המפתחות הנתמכים הם:

# 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

שימוש במשתני סביבה

הספרייה תומכת בכל משתני הסביבה שמשותפים לכל ספריות הלקוח של Google Ads API. בטבלה הבאה מוצג משתנה הסביבה שמתאים לכל מאפיין בקובץ ההגדרות.

מאפיין של קובץ תצורה	משתנה הסביבה
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

אחרי שמגדירים את משתני הסביבה המתאימים, קוראים ל-fromEnvironment() ב-builder כדי להגדיר את GoogleAdsClient.

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

שילוב של גישות להגדרות

ה-GoogleAdsClient והכלי לבניית שלו תומכים בשילוב של אסטרטגיות שונות להגדרה. לדוגמה, אפשר להשתמש במשתני סביבה כדי להגדיר את פרטי הכניסה של המופע ובקובץ מאפיינים כדי להגדיר מאפיינים אחרים באמצעות קטע הקוד הבא.

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

בדוגמה הזו, ספריית הלקוח תשתמש בערך מקובץ המאפיינים לכל מאפיין שמוגדר גם דרך משתנה הסביבה שלו וגם דרך רשומה בקובץ המאפיינים. כדי להגדיר את ההתנהגות ההפוכה, פשוט קוראים ל-fromPropertiesFile() לפני fromEnvironment().

אפשר לבצע שינויים נוספים בזמן הריצה באמצעות שיטות ההגדרה האחרות של ה-builder לפני שמפעילים את build().