ההגדרה מתבצעת באמצעות מחלקה Config
. אפשר לגשת למחלקה בכמה דרכים, כמו לכתוב קובץ תצורה, לציין ערכים בזמן היצירה או לטעון ערכים ממשתני סביבה.
קובץ תצורה
אתם יכולים לציין קובץ google_ads_config.rb
שישמש ליצירת אובייקט הלקוח.
אם לא משתמשים בארגומנטים ליצירת מופע:
client = Google::Ads::GoogleAds::GoogleAdsClient.new
הספרייה תחפש במיקום שצוין במשתנה הסביבה GOOGLE_ADS_CONFIGURATION_FILE_PATH
. אם המשתנה הזה לא מוגדר, הספרייה תחפש את הקובץ בספרייה HOME
.
לחלופין, ניתן לציין נתיב:
client = Google::Ads::GoogleAds::GoogleAdsClient.new("path/to/file.rb")
ובמקרה כזה הלקוח יחפש את הקובץ בנתיב הקובץ הזה.
הדרך הקלה ביותר ליצור את הקובץ הזה היא להעתיק את google_ads_config.rb
ממאגר GitHub ולשנות אותו כך שיכלול את אסימון הרענון, מזהה הלקוח וסוד הלקוח.
הגדרה דינמית
אפשר לקבוע את ההגדרה באופן דינמי כשיוצרים את הספרייה, או אפילו לאחר מכן:
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
config.client_id = 'INSERT_CLIENT_ID_HERE'
# ... more configuration
end
ניתן גם לשנות את התצורה אחרי יצירת מופע:
client.configure do |config|
config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
# ... more configuration
end
שדות הגדרה
האובייקט Config
תומך בשדות הבאים.
שדות כלליים:
refresh_token
: אסימון הרענון של OAuth.client_id
: מזהה הלקוח ב-OAuth.client_secret
: הסוד של לקוח OAuth שלך.developer_token
: קוד המפתח שלכם לגישה ל-API.login_customer_id
: עיינו במסמכי התיעוד של פרטי ההתחברות-customer-id.
שדות רישום ביומן. פרטים נוספים זמינים במדריך הרישום ביומן.
log_level
: המספר המינימלי של הודעות ברמת היומן שברצונך לתעד. לדוגמה, אם מציינים'DEBUG'
, כל הודעות היומן יופיעו. אם מציינים'INFO'
, הודעות DEBUG לא יוצגו אבל כל שאר ההודעות יוצגו.log_target
: המקום שאליו רוצים להתחבר, למשלSTDERR
.logger
: הגדרת יומן רישום מותאם אישית משלכם. ציון האפשרות הזו יבטל אתlog_level
וגם אתlog_target
.
משתני סביבה
אפשר להגדיר את ספריית הלקוח באמצעות משתני סביבה. כברירת מחדל, הקבצים האלה לא נטענים, וכדי לטעון אותם צריך לבצע קריאה נוספת אחרי יצירת מופע הלקוח. כאן אפשר לעיין ברשימה המלאה של משתני הסביבה שנתמכים בכל השפות.
כדי לטעון את משתני הסביבה אל Config
, צריך לקרוא ל-load_environment_config
:
client = Google::Ads::GoogleAds::GoogleAdsClient.new
client.load_environment_config
בכל קריאה לפעולה הזו, המצב הנוכחי של משתני הסביבה
יחליף את כל מה שכבר קיים ב-Config
. לדוגמה, עם המנגנון הזה תוכלו לקבוע הגדרת ברירת מחדל, אבל לשנות ערכים ספציפיים באמצעות משתני סביבה, או להגדיר לגמרי באמצעות משתני סביבה.
בנוסף למשתני הסביבה שנתמכים בכל הספריות, לספריית Ruby יש שני משתנים נוספים:
GOOGLE_ADS_RUBY_LOG_LEVEL
: כמוlog_level
למעלה.GOOGLE_ADS_RUBY_HTTP_PROXY
: ציון שרת Proxy מסוג HTTP.