factories fornece uma interface de alto nível para criar operações e recursos com a biblioteca de cliente.
Os métodos das fábricas são gerados automaticamente para todos os recursos, tipos enumerados, operações e tipos de serviço fornecidos pela API Google Ads.
Operações
A biblioteca oferece os 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 com a API Google Ads.
Aqui está um exemplo de como criar um recurso:
campaign_budget_operation = client.operation.create_resource.campaign_budget do |cb|
cb.name = client.wrapper.string(
"Interplanetary Budget #{(Time.new.to_f * 1000).to_i}",
)
cb.delivery_method = :STANDARD
cb.amount_micros = client.wrapper.int64(500000)
end
return_budget = client.service.campaign_budget.mutate_campaign_budgets(
customer_id,
[campaign_budget_operation]
)
O objeto gerado ao bloco cb é uma nova instância de
CampaignBudget
que você pode modificar, e a operação de criação adequada para a
CampaignBudgetService é retornada.
Da mesma forma, oferecemos métodos convenientes para atualizar:
# 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 = client.wrapper.string(
"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 automaticamente para atualizar o recurso na API Google Ads.
Veja 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 você preferir trabalhar com a operação, poderá consultar 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 = client.wrapper.bool(true)
ns.target_search_network = client.wrapper.bool(true)
ns.target_content_network = client.wrapper.bool(false)
ns.target_partner_search_network = client.wrapper.bool(false)
end
Uma nova instância do tipo de recurso solicitado é liberada ao bloco transmitido para campos de configuração.
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 estaticamente campos de tipo enumerado
(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
Definir explicitamente as versões da API Google Ads
Também é possível definir explicitamente uma versão:
client.resource.v16.[entity]
client.operation.v16.[operation]
client.service.v16.[service]
client.enum.v16.[enum]