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 se forem enviados ao servidor. Você poderia criar uma máscara de campo manualmente, criando uma Google\Protobuf\FieldMask, preencher uma matriz com os nomes de todos os campos que você pretende alterar; e, em seguida, atribuí-lo ao campo de caminho da máscara de campo.

Você também pode usar nosso utilitário integrado de máscaras de campo (FieldMasks), que oculta vários detalhes específicos e permite gerar campos mascara automaticamente ao monitorar as alterações feitas nos campos da entidade.

Veja 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));

Primeiro, esse código cria um objeto Campaign e define o nome do recurso usando ResourceNames, para que a API saiba qual campanha está sendo atualizado. status também é definido como PAUSED.

Em seguida, o código cria um objeto CampaignOperation e define o que criou uma campanha nele. Depois disso, ele usa FieldMasks::allSetFieldsOf() para criar uma máscara de campo para a campanha usando todos os campos alterados. Por fim, passa a máscara retornada ao objeto de operação da campanha.

Observe que FieldMasks::allSetFieldsOf é um método conveniente para FieldMasks::compare(). Ela compara o objeto transmitido com um objeto vazio da mesma classe. Para 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 não podem ter nenhum (como ManualCpm).

Campos de mensagem sem subcampos definidos

Ao atualizar um campo MESSAGE que não está 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 um dos subcampos da mensagem, será necessário adicione cada um dos subcampos mutáveis MESSAGE ao FieldMask, semelhante a no 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 nenhuma dos campos na nova estratégia de lances. O código abaixo demonstra como atualizar uma campanha para usar MaximizeConversions estratégia de lances sem definir nenhum dos subcampos na estratégia de lances.

Nesse caso, usar os métodos allSetFieldsOf() e compare() da FieldMasks não atinge a meta.

O código a seguir gera uma máscara de campo que inclui maximize_conversions. No entanto, a API do Google Ads não permite esse comportamento para impedir apagando acidentalmente campos e produz uma FieldMaskError.FIELD_HAS_SUBFIELDS erro.

// 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 adequadamente uma campanha para usar o MaximizeConversions estratégia de lances 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 explicitamente apagados. Como no exemplo anterior, é preciso adicionar explicitamente esses campos à máscara de campo. Por exemplo, suponha que você tenha campanha que usa uma estratégia de lances de MaximizeConversions e que o O campo target_cpa_micros é definido com um valor maior que 0.

O código a seguir é executado: No entanto, o maximize_conversions.target_cpa_micros não será adicionada à máscara de campo e, portanto, nenhuma alteração será feita na 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 abaixo demonstra como limpar corretamente o 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 valor "incorreto" funciona como pretendido nos campos definidos como optional na API Google Ads protocol buffers. Mas, como o target_cpa_micros não for um campo optional, o valor "incorreto" código não atualiza estratégia de lances para limpar o campo target_cpa.