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

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

קובץ תצורה

אפשר לציין קובץ google_ads_config.rb לשימוש כשיוצרים מופע של הלקוח.

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

אפשרות אחרת היא לציין נתיב כשיוצרים מופע של אובייקט GoogleAdsClient באופן הבא. במקרה כזה, הלקוח יחפש את הקובץ בנתיב הזה.

  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.
• ‫login_customer_id: אפשר לעיין במסמכי התיעוד בנושא login-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.