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, tipos de enumeração, operações e serviços fornecidos pela API Google Ads.

Operações

A biblioteca oferece 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 facilmente operações que funcionam com a API Google Ads.

Confira um exemplo de como criar um recurso:

campaign_budget_operation = client.operation.create_resource.campaign_budget do |cb|
  cb.name = "Interplanetary Budget #{(Time.new.to_f * 1000).to_i}"

  cb.delivery_method = :STANDARD
  cb.amount_micros = 500000
end

return_budget = client.service.campaign_budget.mutate_campaign_budgets(
  customer_id,
  [campaign_budget_operation]
)

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

Da mesma forma, oferecemos métodos convenientes para atualização:

# 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, [update_operation])

# if you have a full resource proto
update_operation = client.operation.update_resource.campaign(campaign) do
  campaign.name = "A different interplanetary Cruise #{(Time.new.to_f * 1000).to_i}"
end

campaign_service.mutate_campaigns(customer_id, [update_operation])

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

Confira um exemplo de como remover um recurso usando um caminho de recurso:

remove_operation = client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(customer_id, [remove_operation])

Se preferir trabalhar com a operação, você pode receber uma operação bruta e preencher os campos manualmente.

operation = client.operation.campaign

Recursos

A biblioteca fornece client.resource.<resource_type> como uma maneira conveniente de inicializar objetos de recurso:

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> como uma maneira conveniente de receber objetos de serviço:

campaign_service = client.service.campaign

Enums

Recomendamos o uso da sintaxe de símbolo para definir campos de tipo enumerado de forma estática (por exemplo, campaign.status = :PAUSED). No entanto, se você quiser enumerar todos os valores válidos de um tipo enumerado, também oferecemos métodos para isso:

client.enum.ad_type.each { |x| p x }
    :SHOPPING_PRODUCT_AD
    :GMAIL_AD
    :UNKNOWN
    :UNSPECIFIED
    :CALL_ONLY_AD
    :VIDEO_AD
    :IMAGE_AD
    :EXPANDED_DYNAMIC_SEARCH_AD
    :RESPONSIVE_DISPLAY_AD
    :TEXT_AD
    :LEGACY_RESPONSIVE_DISPLAY_AD
    :LEGACY_APP_INSTALL_AD
    :APP_AD
    :SHOPPING_SMART_AD
    :EXPANDED_TEXT_AD
    :HOTEL_AD
    :RESPONSIVE_SEARCH_AD

Como definir explicitamente as versões da API Google Ads

Também é possível definir uma versão explicitamente:

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