שימוש בסיסי

כך משתמשים בספריית הלקוח:

התקנה

הדרך המומלצת להתקין את הספרייה היא באמצעות Bundler. מוסיפים שורה ל-Gemfile (מחליפים את x.y.z במספר הגרסה שבה רוצים להשתמש):

gem 'google-ads-googleads', '~> x.y.z'

ואז מריצים את הפקודה:

bundle install

הפקודה הזו משתמשת ב-Bundler כדי לעדכן את Gemfile.lock, ונועלת את הגרסה המדויקת של ה-gem וכל יחסי התלות של ה-gem שהותקנו. אופרטור הגרסה הפסימי "~> x.y.z" מבטיח ש-bundle install או bundle update יתקינו רק גרסאות תיקון חדשות בסדרה x.y.*, כך שצריך לבחור באופן ידני גרסאות משניות או ראשיות חדשות על ידי עדכון של Gemfile.

אפשרויות התקנה נוספות

אם אתם לא משתמשים ב-Bundler, אתם יכולים להשתמש באחת מהאפשרויות הבאות:

  1. מתקינים את הספרייה הזו באמצעות RubyGems:

    gem install google-ads-googleads
    
  2. מורידים את ה-gem מדף הגרסאות ומתקינים אותו מהקובץ המקומי:

    gem install google-ads-googleads-[version].gem
    

מגדירים אימות

כדי לאמת את הקריאות ל-API, צריך להגדיר את הקובץ google_ads_config.rb ולפעול לפי ההוראות בדף אימות והרשאה.

שימוש

החל מגרסה google-ads-googleads v41.1.0, ה-gem תומך ב-Bundler autorequire (Bundler.require). בגרסאות שקדמו ל-v41.1.0 (או כשלא משתמשים ב-Bundler.require), צריך לדרוש את ה-gem באופן מפורש בקוד:

require 'google/ads/google_ads'

מאתחלים את הלקוח (שטוען את ההגדרות מ-~/google_ads_config.rb כברירת מחדל) ומאחזרים שירות ספציפי, כמו CampaignService:

# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Fetch the CampaignService client.
campaign_service = client.service.campaign

בדוגמאות ב-GitHub מוסבר בפירוט איך להשתמש בספרייה.

אחרי שתכירו את הדוגמאות, תוכלו לעיין במפעלים, שמספקים קבוצה של שיטות נוחות ברמה גבוהה לעבודה עם Google Ads API.

טיפול בשגיאות

לא כל קריאה ל-API מצליחה. השרת מעלה חריגות אם הקריאות ל-API נכשלות. חשוב לתעד שגיאות ב-API ולטפל בהן בצורה מתאימה.

מופע של Google::Ads::GoogleAds::Errors::GoogleAdsError נוצר כשמתרחשת שגיאת API. הוא מכיל פרטים שיעזרו לכם להבין מה השתבש, ותוכלו להגדיר פונקציית עזר לטיפול בשגיאות. דוגמה לטיפול בשגיאות ב-GitHub