Na API Google Ads, as atualizações são feitas usando uma máscara de campo. A máscara de campo lista
todos os campos que você pretende mudar com a atualização. Os campos especificados
que não estiverem na máscara de campo serão ignorados, mesmo que sejam enviados ao servidor. Você
pode criar uma máscara de campo manualmente, criando um
Google\Protobuf\FieldMask
,
criando uma matriz preenchida com os nomes de todos os campos que você pretende mudar
e, em seguida, atribuindo isso ao campo de caminho da máscara de campo.
Você também pode usar nosso utilitário de máscara de campo integrado (FieldMasks), que oculta muitos dos detalhes específicos e permite gerar máscaras de campo automaticamente monitorando as mudanças feitas nos campos da entidade.
Confira um exemplo de atualização de uma campanha:
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'status' => CampaignStatus::PAUSED
]);
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
Esse código primeiro cria um objeto de campanha e, em seguida, define o nome do recurso usando
ResourceNames
, para que a API saiba qual campanha está sendo
atualizada. status
também é definido como PAUSED
.
Em seguida, o código cria um objeto CampaignOperation
e define a campanha
criada anteriormente. Em seguida, ele usa
FieldMasks::allSetFieldsOf()
para criar uma máscara de campo para a campanha usando todos os campos alterados. Por fim, ele
transmite a máscara retornada ao objeto de operação da campanha.
FieldMasks::allSetFieldsOf
é um método conveniente para
FieldMasks::compare()
.
Ele compara o objeto transmitido com um objeto vazio da mesma classe. Por
exemplo, no código anterior, você poderia ter usado FieldMasks::compare(new
Campaign(), $campaign)
em vez de allSetFieldsOf()
.
Como atualizar campos de mensagem e subcampos
Os campos MESSAGE
podem ter subcampos, como
MaximizeConversions
, que tem três:
target_cpa_micros
,
cpc_bid_ceiling_micros
e cpc_bid_floor_micros
, ou podem não ter nenhum, como
ManualCpm
.
Campos de mensagem sem subcampos definidos
Ao atualizar um campo MESSAGE
que não é definido com subcampos, use
o FieldMasks
para gerar uma máscara de campo, conforme descrito anteriormente.
Campos de mensagem com subcampos definidos
Ao atualizar um campo MESSAGE
definido com subcampos sem
definir explicitamente nenhum deles na mensagem, é necessário adicionar manualmente
cada um dos subcampos MESSAGE
mutáveis ao FieldMask
, semelhante ao
exemplo anterior que criou uma máscara de campo do zero.
Um exemplo comum é atualizar a estratégia de lances de uma campanha sem definir nenhum dos campos na nova estratégia. O código abaixo demonstra como
atualizar uma campanha para usar a estratégia de lances
MaximizeConversions
sem definir nenhum dos subcampos na estratégia de lances.
Nesse caso, o uso dos métodos allSetFieldsOf()
e compare()
do
FieldMasks
não atinge a meta pretendida.
O código a seguir gera uma máscara de campo que inclui maximize_conversions
.
No entanto, a API Google Ads não permite esse comportamento para evitar
a exclusão acidental de campos e produz um
erro FieldMaskError.FIELD_HAS_SUBFIELDS
.
// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'maximize_conversions' => new MaximizeConversions()
]);
// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. The field mask will include 'maximize_conversions`,
// which will produce a FieldMaskError.FIELD_HAS_SUBFIELDS error.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
// Sends the operation in a mutate request that will result in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);
O código a seguir demonstra como atualizar corretamente uma campanha para usar a
estratégia de lances MaximizeConversions
sem definir nenhum dos subcampos.
// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);
// Creates a field mask from the existing campaign and adds all of the mutable
// fields (only one in this case) on the MaximizeConversions bidding strategy to
// the field mask. Because this field is included in the field mask but
// excluded from the campaign object, the Google Ads API will set the campaign's
// bidding strategy to a MaximizeConversions object without any of its subfields
// set.
fieldMask = FieldMasks::allSetFieldsOf($campaign);
// Only include 'maximize_conversions.target_cpa_micros' in the field mask
// as it is the only mutable subfield on MaximizeConversions when used as a
// standard bidding strategy.
//
// Learn more about standard and portfolio bidding strategies here:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->setPaths(array_merge(
iterator_to_array($fieldMask->getPaths()->getIterator()),
['maximize_conversions.target_cpa_micros']
));
// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);
Limpar campos
Alguns campos podem ser limpos explicitamente. Assim como no exemplo anterior, é necessário
adicionar esses campos explicitamente à máscara de campo. Por exemplo, suponha que você tenha uma
campanha que usa uma estratégia de lances MaximizeConversions
e que o
campo target_cpa_micros
seja definido com um valor maior que 0
.
O código abaixo é executado. No entanto, o maximize_conversions.target_cpa_micros
não é adicionado à máscara de campo, e nenhuma mudança é feita no
campo target_cpa_micros
:
// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
'status' => CampaignStatus::PAUSED
]);
// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask will NOT include
// 'maximize_conversions.target_cpa_micros'.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
// Sends the operation in a mutate request that will succeed but will NOT update
// the 'target_cpa_micros' field because
// 'maximize_conversions.target_cpa_micros' was not included in the field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);
O código a seguir demonstra como limpar corretamente o campo target_cpa_micros
na estratégia de lances MaximizeConversions
.
// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);
// Constructs a field mask from the existing campaign and adds the
// 'maximize_conversions.target_cpa_micros' field to the field mask, which will
// clear this field from the bidding strategy without impacting any other fields
// on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
iterator_to_array($fieldMask->getPaths()->getIterator()),
['maximize_conversions.target_cpa_micros']
));
// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);
O código "incorreto" funciona como esperado para campos definidos
como optional
na API Google Ads protocol buffers
. No entanto, como o
target_cpa_micros
não é um campo optional
, o código "incorreto" não atualiza a
estratégia de lances para limpar o campo target_cpa
.