Como definir objetos de mensagem vazios como campos

Na Google Ads API, alguns campos de mensagem são definidos como objetos de mensagem vazios, como campaign.manual_cpm, ou só podem ter campos opcionais que não precisam ser definidos, por exemplo, campaign.manual_cpc. É importante definir esses campos para informar à API qual estratégia de lances usar para determinada campanha, mas isso não é intuitivo quando as mensagens estão vazias.

Ao atualizar o campo campaign.name, que é uma string, definimos o campo atualizando-o diretamente como se fosse um atributo de objeto Python normal:

campaign.name = "Test campaign value"

campaign.manual_cpc é um campo aninhado, o que significa que ele contém outra mensagem protobuf e não um tipo primitivo, como uma string. Também é possível atualizar os campos diretamente:

campaign.manual_cpc.enhanced_cpc_enabled = True

Isso vai informar à API que essa campanha tem uma estratégia de lances de manual_cpc com CPC otimizado ativado.

Mas e se você quiser usar manual_cpm, que está vazio? Ou manual_cpc sem ativar o CPC otimizado? Para fazer isso, copie uma instância vazia separada da classe para a campanha, por exemplo:

client = GoogleAdsClient.load_from_storage()

empty_cpm = client.get_type('ManualCpm')
client.copy_from(campaign.manual_cpm, empty_cpm)

Observe como manual_cpm é especificado para o objeto campaign:

name {
  value: "Test campaign value"
}
manual_cpm {
}

O campo manual_cpm está definido, mas nenhum dos campos tem valores. Ao enviar solicitações à API que usam esse padrão, verifique se você está definindo corretamente o objeto de mensagem vazio ativando a geração de registros e inspecionando o payload da solicitação.

Por fim, você precisará adicionar manualmente esse campo ao update_mask do objeto de solicitação. O auxiliar de máscara de campo não tem mecanismo para determinar a diferença entre um campo que foi definido explicitamente como um objeto vazio e um campo que não foi definido.

from google.api_core.protobuf_helpers import field_mask

campaign_operation.create = campaign
campaign_operation.update_mask = field_mask(None, campaign)
# Here we manually add the "manual_cpm" field
campaign_operation.update_mask.append("manual_cpm")