factories מספק ממשק ברמה גבוהה ליצירת פעולות ומשאבים באמצעות ספריית הלקוח.
שיטות Factory נוצרות באופן אוטומטי לכל המשאבים, הטיפוסים המוגדרים, הפעולות וסוגי השירותים ש-Google Ads API מספק. בדוגמאות שבדף הזה, אנחנו מניחים שהפעלתם מכונה של GoogleAdsClient ויעד של customer_id:
require 'google/ads/google_ads'
client = Google::Ads::GoogleAds::GoogleAdsClient.new
customer_id = '1234567890'
תפעול
הספרייה מספקת שיטות נוחות ב-client.operation.create_resource.<resource_type>, ב-client.operation.update_resource.<resource_type> וב-client.operation.remove_resource.<resource_type> כדי ליצור פעולות לעבודה עם Google Ads API.
בדוגמה הבאה נוצר משאב של תקציב קמפיין:
campaign_budget_operation =
client.operation.create_resource.campaign_budget do |budget|
budget.name = "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}"
budget.delivery_method = :STANDARD
budget.amount_micros = 500_000
end
return_budget = client.service.campaign_budget.mutate_campaign_budgets(
customer_id: customer_id,
operations: [campaign_budget_operation]
)
שימו לב שהאובייקט שמוחזר לבלוק (budget) הוא מופע חדש של CampaignBudget שאפשר לשנות, ומוחזרת פעולת היצירה המתאימה ל-CampaignBudgetService.
באופן דומה, הספרייה מספקת שיטות נוחות לעדכון משאבים:
campaign_service = client.service.campaign
# If you only have a resource name:
update_operation =
client.operation.update_resource.campaign(campaign_resource_name) do |camp|
camp.status = :PAUSED
end
campaign_service.mutate_campaigns(
customer_id: customer_id,
operations: [update_operation]
)
# If you have a full resource proto:
update_operation = client.operation.update_resource.campaign(campaign) do |camp|
camp.name = "A different Cruise #{(Time.new.to_f * 1000).to_i}"
end
campaign_service.mutate_campaigns(
customer_id: customer_id,
operations: [update_operation]
)
הקריאות האלה מחזירות פעולת עדכון תקינה עם מסכת שדות מאוכלסת מראש כדי לעדכן את המשאב ב-Google Ads API.
בדוגמה הבאה מוצגת הסרת משאב באמצעות נתיב משאב:
campaign_service = client.service.campaign
remove_operation =
client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(
customer_id: customer_id,
operations: [remove_operation]
)
אם אתם מעדיפים לעבוד עם הפעולה בעצמכם, אתם יכולים לקבל פעולה גולמית ואז לאכלס את השדות באופן ידני:
operation = client.operation.campaign
משאבים
הספרייה מספקת client.resource.<resource_type> כדי לאתחל אובייקטים של משאבים:
campaign.network_settings = client.resource.network_settings do |ns|
ns.target_google_search = true
ns.target_search_network = true
ns.target_content_network = false
ns.target_partner_search_network = false
end
מופע חדש של סוג המשאב המבוקש מועבר לבלוק שהועבר להגדרת שדות.
שירותים
הספרייה מספקת את client.service.<service_name> כדי לאחזר אובייקטים של לקוחות שירות:
campaign_service = client.service.campaign
טיפוסים בני מנייה (enum)
משתמשים בתחביר הסמל כדי להגדיר באופן סטטי שדות enum (לדוגמה, campaign.status = :PAUSED). כדי למנות את כל הערכים החוקיים של enum, משתמשים ב-factory של client.enum:
client.enum.ad_type.each { |ad_type| p ad_type }
# Output:
# :UNSPECIFIED
# :UNKNOWN
# :TEXT_AD
# :EXPANDED_TEXT_AD
# :EXPANDED_DYNAMIC_SEARCH_AD
# :HOTEL_AD
# :SHOPPING_SMART_AD
# :SHOPPING_PRODUCT_AD
# :VIDEO_AD
# :IMAGE_AD
# :RESPONSIVE_SEARCH_AD
# :LEGACY_RESPONSIVE_DISPLAY_AD
# :APP_AD
# :LEGACY_APP_INSTALL_AD
# :RESPONSIVE_DISPLAY_AD
# :LOCAL_AD
# :HTML5_UPLOAD_AD
# :DYNAMIC_HTML5_AD
# :APP_ENGAGEMENT_AD
# :SHOPPING_COMPARISON_LISTING_AD
# :VIDEO_BUMPER_AD
# :VIDEO_NON_SKIPPABLE_IN_STREAM_AD
# :VIDEO_TRUEVIEW_IN_STREAM_AD
# :VIDEO_RESPONSIVE_AD
# :SMART_CAMPAIGN_AD
# :CALL_AD
# :APP_PRE_REGISTRATION_AD
# :IN_FEED_VIDEO_AD
# :DEMAND_GEN_MULTI_ASSET_AD
# :DEMAND_GEN_CAROUSEL_AD
# :TRAVEL_AD
# :DEMAND_GEN_VIDEO_RESPONSIVE_AD
# :DEMAND_GEN_PRODUCT_AD
# :YOUTUBE_AUDIO_AD
הגדרה מפורשת של גרסאות Google Ads API
אפשר גם להגדיר באופן מפורש גרסת API ראשית בכל קריאה ל-factory (לדוגמה, v26; גרסאות API משניות כמו v25.1 משתמשות בשיטה של הגרסה הראשית v25):
client.resource.v26.[entity]
client.operation.v26.[operation]
client.service.v26.[service]
client.enum.v26.[enum]