factories proporciona una interfaz de alto nivel para crear operaciones y recursos con la biblioteca cliente.
Los métodos de fábrica se generan automáticamente para todos los recursos, enumeraciones, operaciones y tipos de servicios que proporciona la API de Google Ads.
Operaciones
La biblioteca proporciona métodos convenientes client.operation.create_resource.<resource_type>, client.operation.update_resource.<resource_type> y client.operation.remove_resource.<resource_type> para crear fácilmente operaciones que funcionen con la API de Google Ads.
A continuación, se muestra un ejemplo para crear un 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]
)
Ten en cuenta que el objeto entregado al bloque cb es una instancia nueva de CampaignBudget que luego puedes mutar y se muestra la operación de creación adecuada para CampaignBudgetService.
De manera similar, proporcionamos métodos prácticos para la actualización:
# 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])
Estas llamadas muestran una operación de actualización bien formada, con una máscara de campo prepropagada para actualizar el recurso en la API de Google Ads.
A continuación, se muestra un ejemplo de cómo quitar un recurso con una ruta de acceso al recurso:
remove_operation = client.operation.remove_resource.campaign(campaign_resource_name)
campaign_service.mutate_campaigns(customer_id, [remove_operation])
Si prefieres trabajar con la operación por tu cuenta, puedes obtener una operación sin procesar y, luego, propagar los campos de forma manual.
operation = client.operation.campaign
Recursos
La biblioteca proporciona client.resource.<resource_type> como una forma conveniente de inicializar objetos de recursos:
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
Se entrega una instancia nueva del tipo de recurso solicitado al bloque que se pasó para configurar campos.
Servicios
La biblioteca proporciona client.service.<service_name> como una forma conveniente de obtener objetos de servicio:
campaign_service = client.service.campaign
Enumeradores
Te recomendamos que uses la sintaxis de símbolos para configurar campos de enumeración de forma estática (p.ej., campaign.status = :PAUSED). Sin embargo, si deseas enumerar todos los valores válidos para una enum, también proporcionamos métodos para eso:
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
Configuración explícita de versiones de la API de Google Ads
También puedes configurar una versión de forma explícita:
client.resource.v16.[entity]
client.operation.v16.[operation]
client.service.v16.[service]
client.enum.v16.[enum]