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

ההגדרה בוצעה באמצעות מחלקה 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: ראו את מסמכי תיעוד של Login-customer-id.

רישום שדות ביומן. פרטים מלאים זמינים במדריך הרישום ביומן.

  • log_level: מספר ההודעות המינימליות ברמת היומן שאתם רוצים לתעד. לדוגמה, ציון 'DEBUG' יאפשר לך לראות את כל הודעות היומן הודעות DEBUG לא ייכללו ב-'INFO', אבל כל שאר ההודעות יוצגו.
  • 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.