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 estiverem na máscara de campo serão ignorados, mesmo se forem enviadas ao servidor.

FieldMaskUtil

A maneira recomendada de gerar máscaras de campo é usando nossa máscara de campo integrada que permite gerar máscaras de campo a partir de um objeto modificado em vez de construí-los do zero.

Veja um exemplo de atualização de uma campanha:

// Creates a Campaign object with the proper resource name and any other changes.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// allSetFieldsOf utility to derive the update mask. This mask tells the Google
// Ads API which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Este exemplo primeiro cria um objeto Campaign vazio e, em seguida, define o recurso para que a API saiba qual campanha está sendo atualizada.

O exemplo usa o método FieldMasks.allSetFieldsOf() na campanha para produz automaticamente uma máscara de campo que enumera todos os campos definidos. É possível passa a máscara retornada diretamente para a chamada de atualização.

Se precisar trabalhar com um objeto existente para atualizar alguns campos, você poderá modifique o código da seguinte maneira:

Campaign existingCampaign;

// Obtains existingCampaign from elsewhere.
...

// Creates a new campaign based off the existing campaign and updates the
// campaign by setting its status to paused.
Campaign campaignToUpdate =
    existingCampaign.toBuilder()
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// compare utility to derive the update mask. This mask tells the Google Ads API
// which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaignToUpdate)
        .setUpdateMask(FieldMasks.compare(existingCampaign, campaignToUpdate))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Para criar uma máscara de campo do zero, primeiro é necessário criar uma FieldMask em seguida, adicione o nome de cada um dos campos que você pretende alterar ao objeto.

FieldMask fieldMask =
    FieldMask.newBuilder()
        .addPaths("status")
        .addPaths("name")
        .build();

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 FieldMaskUtil para gerar uma máscara de campo, conforme descrito acima.

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 acima, que cria 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 exemplo 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 O FieldMaskUtil não atinge a meta pretendida.

O exemplo a seguir gera uma máscara de campo que inclui maximize_conversions: No entanto, a API Google Ads não permite que esse comportamento evita a limpeza acidental de campos e produz uma FieldMaskError.FIELD_HAS_SUBFIELDS erro.

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

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .setMaximizeConversions(MaximizeConversions.newBuilder().build())
    .build();

// 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 operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

O exemplo a seguir demonstra como atualizar corretamente uma campanha para usar o MaximizeConversions estratégia de lances sem definir nenhum dos subcampos.

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

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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 fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    // 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
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask)
        .build();

Como limpar campos

Alguns campos podem ser explicitamente apagados. Assim como no exemplo acima, é 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:

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

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setMaximizeConversions(
            MaximizeConversions.newBuilder().setTargetCpa(0).build())
        .setStatus(CampaignStatus.PAUSED)
        .build();

// 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 operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

O próximo exemplo demonstra como limpar corretamente o target_cpa_micros. na estratégia de lances MaximizeConversions.

Tudo certo: o código a seguir limpa o target_cpa_micros.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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 fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask))
        .build();

O valor "incorreto" exemplo acima funciona conforme esperado para os campos que São definidos como optional na API Google Ads. protocol buffers. Mas, como o target_cpa_micros não for um campo optional, o valor "incorreto" exemplo não atualiza o estratégia de lances para limpar o campo target_cpa.

Importante :se sua intenção é limpar um campo, a maneira mais segura de fazer isso o objetivo é adicionar explicitamente esse campo à máscara de campo.