Fabryki

factories udostępnia interfejs wysokiego poziomu do tworzenia operacji i zasobów za pomocą biblioteki klienta.

Metody fabryk są generowane automatycznie dla wszystkich zasobów, wyliczeń, operacji i typów usług udostępnianych przez interfejs Google Ads API. Przykłady na tej stronie zakładają, że masz zainicjowaną instancję GoogleAdsClient i element docelowy customer_id:

require 'google/ads/google_ads'

client = Google::Ads::GoogleAds::GoogleAdsClient.new
customer_id = '1234567890'

Operacje

Biblioteka udostępnia wygodne metody client.operation.create_resource.<resource_type>, client.operation.update_resource.<resource_type> i client.operation.remove_resource.<resource_type> do tworzenia operacji na potrzeby interfejsu Google Ads API.

Poniższy przykład tworzy zasób budżetu kampanii:

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]
)

Pamiętaj, że obiekt przekazany do bloku (budget) to nowa instancja CampaignBudget, którą możesz modyfikować, a odpowiednia operacja tworzenia dla CampaignBudgetService jest zwracana.

Biblioteka udostępnia też wygodne metody aktualizowania zasobów:

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]
)

Te wywołania zwracają prawidłowo sformułowaną operację aktualizacji z wstępnie wypełnioną maską pola, która służy do aktualizowania zasobu w interfejsie Google Ads API.

W tym przykładzie usuwamy zasób za pomocą ścieżki zasobu:

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]
)

Jeśli wolisz samodzielnie pracować z operacją, możesz pobrać surową operację i ręcznie wypełnić pola:

operation = client.operation.campaign

Zasoby

Biblioteka udostępnia funkcję client.resource.<resource_type> do inicjowania obiektów zasobów:

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

Nowa instancja żądanego typu zasobu jest przekazywana do przekazanego bloku w celu ustawienia pól.

Usługi

Biblioteka udostępnia client.service.<service_name> do pobierania obiektów klienta usługi:

campaign_service = client.service.campaign

Wartości w polu enum

Aby statycznie ustawić pola wyliczeniowe, użyj składni symboli (np. campaign.status = :PAUSED). Aby wyliczyć wszystkie prawidłowe wartości wyliczenia, użyj fabryki 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

Jawne ustawianie wersji interfejsu Google Ads API

Możesz też jawnie ustawić główną wersję interfejsu API w dowolnym wywołaniu fabrycznym (np. v25; mniejsze wersje interfejsu API, takie jak v25.1, używają metody głównej wersji v25):

client.resource.v25.[entity]
client.operation.v25.[operation]
client.service.v25.[service]
client.enum.v25.[enum]