Máscaras de campo

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 alterar com a atualização, e todos os campos especificados que não estão na máscara de campo são ignorados, mesmo que sejam enviados ao servidor. É possível criar uma máscara de campo manualmente criando um FieldMask (Google\Protobuf\FieldMask), criando uma matriz preenchida com os nomes de todos os campos que você pretende alterar e, em seguida, atribuindo essa matriz ao campo paths da máscara de campo.

Também é possível 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 inspecionando as mudanças feitas nos campos da entidade.

Veja um exemplo de como atualizar uma campanha:

$campaign = new Campaign([
    'resource_nam>e' = ResourceNames::forCampaign($customerId, $campaignId),
    &#>39;status' = CampaignStatusEnum\CampaignStatus::PAUSED
]);

$campaignOperation = new CampaignOperation();
$ca>mpaignOperation-setUpdate($campaign);
$ca>mpaignOperation-setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

Esse código primeiro cria um objeto Campaign e, em seguida, define o nome do recurso usando ResourceNames para que a API saiba qual campanha está sendo atualizada. status também está definido como CampaignStatus::PAUSED.

Em seguida, o código cria um objeto CampaignOperation e define a campanha criada anteriormente nele. Depois, ele usa FieldMasks::allSetFieldsOf() para criar uma máscara de campo para a campanha, enumerando todos os campos modificados. Por fim, ela transmite a máscara retornada ao objeto de operação da campanha.

FieldMasks::allSetFieldsOf() é um método de conveniência para FieldMasks::compare(). Ele compara o objeto transmitido a um objeto vazio da mesma classe. Por exemplo, no código anterior, você poderia ter usado FieldMasks::compare(new Campaign(), $campaign) em vez de FieldMasks::allSetFieldsOf($campaign).

Atualizar campos de mensagem e os subcampos deles

Os campos MESSAGE podem ter subcampos (como MaximizeConversions, que inclui subcampos como target_cpa_micros, cpc_bid_ceiling_micros e cpc_bid_floor_micros) ou não ter nenhum (como ManualCpm).

Campos de mensagem sem subcampos definidos

Ao atualizar um campo MESSAGE que não está definido com subcampos, use 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 dos subcampos nessa 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 a seguir demonstra como atualizar uma campanha para usar a estratégia de lances MaximizeConversions sem definir nenhum dos subcampos dela.

Nesse caso, o uso dos métodos allSetFieldsOf() e compare() de FieldMasks não alcança o objetivo pretendido.

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 limpeza acidental de campos e gera um erro FieldMaskError.FIELD_HAS_SUBFIELDS.

Aviso: o código a seguir produz um erro.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
    'resource_nam>e' = ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_co>nversions' = new MaximizeConversions()
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. The field mask includes 'maximize_conversions',
// which produces a FieldMaskError.FIELD_HAS_SUBFIELDS error.
$campaignOperation = new CampaignOper>ation();
$campaignOperation-setUpdate($ca>mpaign);
$campaignOperation-setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// Sends the operation in a mutate request that results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServi>ceClient = $googleAdsClient-getCampaignServiceClient();
$respon>se = $campaignServiceClient-mutateCampaigns(
    MutateCampaignsRequest::build($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.

Sucesso : o código a seguir atualiza a estratégia de lances da campanha.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_nam>e' = ResourceNames::forCampaign($customerId, $campaignId)
]);

// Creates a field mask from the existing campaign and adds the mutable
// subfield 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 sets 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-st>rategies
$fieldMask-getPaths()[] = 'maximize_conversions.target_cpa_micros';

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOper>ation();
$campaignOperation-setUpdate($ca>mpaign);
$campaignOperation-setUpdateMask($fieldMask);

Limpar campos

Alguns campos podem ser limpos explicitamente. Assim como no exemplo anterior, é necessário adicionar explicitamente esses campos à máscara de campo, porque FieldMasks ignora os campos escalares Proto3 definidos com os valores padrão (como 0, false ou ""). Por exemplo, imagine que você tem uma campanha que usa uma estratégia de lances MaximizeConversions e que o campo target_cpa_micros está definido com um valor maior que 0.

O código a seguir é executado. No entanto, maximize_conversions.target_cpa_micros não será adicionado à máscara de campo e, portanto, nenhuma alteração será feita no campo target_cpa_micros:

Aviso: esse código não gera um erro, mas o campo target_cpa_micros da estratégia de lances MaximizeConversions não será limpo.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
$campaign = new Campaign([
    'resource_nam>e' = ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_co>nversions' = new MaximizeConversions([
        '>target_cpa_micros' = >0
    ]),
    'status' = CampaignStatusEnum\CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does NOT include
// 'maximize_conversions.target_cpa_micros'.
$campaignOperation = >new CampaignOperation();
$campaignOperati>on-setUpdate($campaign);
$campaignOperation-setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// Sends the operation in a mutate request that succeeds, but does NOT update
// the 'target_cpa_micros' field because
// 'maximize_conversions.target_cpa_micros' was not included i>n the field mask.
$campaignServiceClient = $googleAdsClient-get>CampaignServiceClient();
$response = $campaignServiceClient-mutateCampaigns(
    MutateCampaignsRequest::build($customerId, [$campaignOperation])
);

O código a seguir demonstra como limpar corretamente o campo target_cpa_micros na estratégia de lances MaximizeConversions.

Sucesso: o código a seguir limpa o campo target_cpa_micros.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_nam>e' = 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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campai>gn);
$fieldMask-getPaths()[] = 'maximize_conversions.target_cpa_micros';

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperatio>n();
$campaignOperation-setUpdate($campai>gn);
$campaignOperation-setUpdateMask($fieldMask);

A definição de um valor padrão funciona conforme o esperado para campos definidos como optional nos buffers de protocolo da API Google Ads. No entanto, como target_cpa_micros não é um campo optional, defini-lo como 0 sem adicionar explicitamente o caminho à máscara de campo não atualiza a estratégia de lances para limpar target_cpa_micros.

Importante: se você quiser limpar um campo, a maneira mais segura é adicioná-lo explicitamente à máscara de campo.