Mutação em massa

Para fazer mutações em vários tipos de recursos em uma única solicitação ou enviar todas as mutações para um endpoint unificado, use GoogleAdsService.Mutate. Para conferir a lista completa de operações compatíveis, consulte a referência MutateOperation.

Operações de mutação

Cada MutateGoogleAdsRequest aceita um MutateOperation repetido no campo mutate_operations:

  • Operações de mutação de recursos (todas as versões compatíveis): cada entrada pode especificar uma única operação create, update ou remove para um tipo de recurso.
  • Operações de ação (v23 e mais recentes): cada entrada também pode especificar uma operação de ação, como book_campaigns_operation ou quote_campaigns_operation. Na v22, MutateOperation só é compatível com operações de mutação de recursos.

Para criar entidades dependentes (como uma campanha e um grupo de anúncios) em uma única chamada GoogleAdsService.Mutate, crie duas entradas MutateOperation (uma contendo um CampaignOperation e outra contendo um AdGroupOperation). Atribua um nome de recurso temporário com um ID negativo (como customers/CUSTOMER_ID/campaigns/-1) à campanha para que a operação do grupo de anúncios possa fazer referência a ela na mesma solicitação:

Python

import uuid

campaign_budget_service = client.get_service("CampaignBudgetService")
campaign_service = client.get_service("CampaignService")
googleads_service = client.get_service("GoogleAdsService")

campaign_budget_resource_name = campaign_budget_service.campaign_budget_path(
    customer_id, budget_id
)
temp_campaign_resource_name = campaign_service.campaign_path(customer_id, "-1")

mutate_operation1 = client.get_type("MutateOperation")
campaign = mutate_operation1.campaign_operation.create
campaign.resource_name = temp_campaign_resource_name
campaign.name = f"Bulk Mutate Campaign #{uuid.uuid4()}"
campaign.advertising_channel_type = (
    client.enums.AdvertisingChannelTypeEnum.SEARCH
)
campaign.status = client.enums.CampaignStatusEnum.PAUSED
campaign.manual_cpc = client.get_type("ManualCpc")
campaign.campaign_budget = campaign_budget_resource_name
campaign.contains_eu_political_advertising = (
    client.enums.EuPoliticalAdvertisingStatusEnum.DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING
)

mutate_operation2 = client.get_type("MutateOperation")
ad_group = mutate_operation2.ad_group_operation.create
ad_group.name = "Bulk Mutate Ad Group"
ad_group.campaign = temp_campaign_resource_name
ad_group.status = client.enums.AdGroupStatusEnum.ENABLED

response = googleads_service.mutate(
    customer_id=customer_id,
    mutate_operations=[mutate_operation1, mutate_operation2],
)

for op_response in response.mutate_operation_responses:
    result_type = op_response._pb.WhichOneof("response")
    result = getattr(op_response, result_type)
    print(f"Created {result_type}: {result.resource_name}")

Ruby

campaign_budget_resource_name =
  client.path.campaign_budget(customer_id, budget_id)
temp_campaign_resource_name =
  client.path.campaign(customer_id, -1)

mutate_operation1 = client.operation.mutate do |m|
  m.campaign_operation = client.operation.create_resource.campaign do |c|
    c.resource_name = temp_campaign_resource_name
    c.name = "Bulk Mutate Campaign #{(Time.new.to_f * 1000).to_i}"
    c.advertising_channel_type = :SEARCH
    c.status = :PAUSED
    c.manual_cpc = client.resource.manual_cpc
    c.campaign_budget = campaign_budget_resource_name
    c.contains_eu_political_advertising = :DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING
  end
end

mutate_operation2 = client.operation.mutate do |m|
  m.ad_group_operation = client.operation.create_resource.ad_group do |ag|
    ag.name = "Bulk Mutate Ad Group"
    ag.campaign = temp_campaign_resource_name
    ag.status = :ENABLED
  end
end

response = client.service.google_ads.mutate(
  customer_id: customer_id,
  mutate_operations: [mutate_operation1, mutate_operation2]
)

response.mutate_operation_responses.each do |op_response|
  result = op_response.send(op_response.response)
  puts "Created #{op_response.response}: #{result.resource_name}"
end

Atomicidade e falha parcial

Por padrão, as operações em uma solicitação GoogleAdsService.Mutate são executadas de forma atômica: todas as operações são bem-sucedidas juntas ou toda a solicitação falha se alguma operação contiver um erro.

Assim como os serviços de recursos individuais, esse endpoint é compatível com as seguintes opções:

  • Falha parcial (partial_failure = true): confirma operações válidas e retorna erros para operações com falha em partial_failure_error.
  • Modo de validação (validate_only = true): verifica se há erros nas operações sem confirmar as mudanças na conta:
    • Operações de mutação de recursos:retornam apenas erros de validação e omitem resultados.
    • Operações de ação (v23 e mais recentes): retornam o resultado da ação (como quote_campaigns_result ou book_campaigns_result) quando a validação é bem-sucedida. Se ocorrerem erros de validação, o resultado da ação será omitido de MutateOperationResponse (embora uma cotação ainda possa ser retornada em ErrorDetails.reservation_error_details). Observe que quote_campaigns_operation exige validate_only = true e partial_failure = false.
Anterior
O recurso sofre mutações
Avançar
Práticas recomendadas