השימוש הבסיסי בספריית הלקוח הוא כדלקמן:
התקנה
הדרך המומלצת להתקין את הספרייה היא באמצעות 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, אתם יכולים להשתמש באחת מהאפשרויות הבאות:
מתקינים את הספרייה הזו באמצעות RubyGems:
gem install google-ads-googleadsמורידים את ה-Gem מדף הגרסאות ומתקינים אותו מהקובץ המקומי:
gem install google-ads-googleads-[version].gem
מגדירים אימות
כדי לאמת את הקריאות ל-API, צריך להגדיר את הקובץ google_ads_config.rb ולפעול לפי ההוראות בדף אימות והרשאה.
שימוש
החל מגרסה google-ads-googleads 41.1.0, ה-gem תומך ב-Bundler autorequire (Bundler.require). בגרסאות קודמות לגרסה 41.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