הגדרות אישיות

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

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

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

# 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

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

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

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

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

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

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

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