כלי חיפוש

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

ProtoLookupUtil

שיטות השירות של כלי החיפוש ב-GoogleAdsClient (שמגובות על ידי Factories ו-ServiceLookup, ומחליפות את המחלקה ProtoLookupUtil מדור קודם) מאפשרות לחפש וליצור מופעים של שירותים, פעולות, ספירות ומשאבים בלי שתצטרכו לעקוב אחרי מספרי הגרסאות של ממשקי ה-API ומרחבי השמות של המודולים. כברירת מחדל, השיטות האלה משתמשות בגרסת ה-API הכי גבוהה שנתמכת על ידי ה-gem המותקן (‫V26 בגרסה האחרונה, כשגרסאות משניות של ה-API כמו v25.1 משתמשות במודול הגרסה הראשית שלהן V25), או שאפשר לציין קידומת גרסה מפורשת (כמו v26) בקריאה של החיפוש.

בלי כלי החיפוש, יוצרים מופע של משאב קמפיין ישירות ממרחב השמות שלו עם גרסה:

campaign =
  Google::Ads::GoogleAds::V26::Resources::Campaign.new

בעזרת שיטות החיפוש של הלקוח, אפשר ליצור מופע של המשאב ישירות מהלקוח:

campaign = client.resource.campaign

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

# Instantiate an operation
operation = client.operation.campaign

חיפוש שירות

משתמשים בשיטה client.service כדי לאחזר לקוחות שירות, גם אם לא משתמשים בכלי הזה עבור ישויות אחרות. ‫client.service מגדיר באופן אוטומטי את פרטי הכניסה לאימות ואת הגדרות ההעברה בלקוח השירות שמוחזר:

campaign_service = client.service.campaign

חיפוש ערכי ספירה

בשדות enum בהודעות protobuf, מקצים סמל Ruby ישירות במקום לחפש את מודול ה-enumeration:

campaign.status = :PAUSED

כדי לבדוק את כל הסמלים החוקיים של טיפוס מנייה בזמן הריצה או לעבור עליהם, משתמשים ב-client.enum, שמחזיר את ה-Google::Protobuf::EnumDescriptor של טיפוס המנייה הזה:

status_enum = client.enum.campaign_status
status_enum.each { |status| p status }