Fábricas

O factories fornece uma interface de alto nível para criar operações e recursos com a biblioteca de cliente.

Os métodos de fábrica são gerados automaticamente para todos os recursos, enums, operações e tipos de serviço fornecidos pela API Google Ads. Os exemplos nesta página pressupõem que você inicializou uma instância GoogleAdsClient e um destino customer_id:

require 'google/ads/google_ads'

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

Operações

A biblioteca fornece métodos de conveniência client.operation.create_resource.<resource_type>, client.operation.update_resource.<resource_type> e client.operation.remove_resource.<resource_type> para criar operações de trabalho com a API Google Ads.

O exemplo a seguir cria um recurso de orçamento da campanha:

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

O objeto gerado para o bloco (budget) é uma nova instância de CampaignBudget que pode ser modificada, e a operação de criação apropriada para CampaignBudgetService é retornada.

Da mesma forma, a biblioteca oferece métodos convenientes para atualizar recursos:

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

Essas chamadas retornam uma operação de atualização bem formada com uma máscara de campo pré-preenchida para atualizar o recurso na API Google Ads.

O exemplo a seguir remove um recurso usando um caminho de recurso:

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

Se você preferir trabalhar com a operação por conta própria, poderá receber uma operação bruta e preencher os campos manualmente:

operation = client.operation.campaign

Recursos

A biblioteca fornece client.resource.<resource_type> para inicializar objetos de recursos:

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

Uma nova instância do tipo de recurso solicitado é gerada para o bloco transmitido para definir campos.

Serviços

A biblioteca fornece client.service.<service_name> para recuperar objetos de cliente de serviço:

campaign_service = client.service.campaign

Tipos enumerados

Use a sintaxe de símbolo para definir campos de enumeração de forma estática (por exemplo, campaign.status = :PAUSED). Para enumerar todos os valores válidos de uma enumeração, use a fábrica 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

Definir explicitamente as versões da API Google Ads

Também é possível definir explicitamente uma versão principal da API em qualquer chamada de fábrica (por exemplo, v25. Versões secundárias da API, como v25.1, usam o método da versão principal v25):

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