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

ספריית הלקוח של 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().

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

# 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() ב-builder:

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

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

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

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

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

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