Máscaras de campo

Na API Google Ads, uma máscara de campo é usada para fornecer uma lista de campos que uma solicitação de API precisa atualizar. Qualquer campo não especificado na máscara de campo será ignorado, mesmo que seja enviado ao servidor.

Classe FieldMaskUtil

A maneira recomendada de gerar máscaras de campo é usar a classe FieldMaskUtil integrada, que permite gerar máscaras de campo de um objeto modificado em vez de criá-las do zero.

Confira um exemplo de atualização de uma campanha que usa o método FieldMasks.AllSetFieldsOf para produzir uma máscara de campo que enumera todos os campos definidos. Em seguida, transmita a máscara de campo gerada diretamente para a chamada de atualização.

// Update campaign by setting its status to paused, and "Search network" to false.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    NetworkSettings = new NetworkSettings()
    {
        TargetSearchNetwork = false
    }
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

Às vezes, é necessário trabalhar com um objeto existente e atualizar alguns campos. Nesses casos, modifique o código para usar o método FieldMasks.FromChanges. Esse método gera uma máscara de campo que representa a diferença entre dois objetos.

Campaign existingCampaign;

// Obtain existingCampaign from elsewhere.
...

// Create a new campaign based off the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);

// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
    TargetSearchNetwork = false
}

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};

Como processar erros FieldMaskError.FIELD_HAS_SUBFIELDS

Em raras ocasiões, talvez seja necessário definir um campo sem atualizar nenhum dos subcampos desse tipo. Veja o exemplo a seguir:

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
};

CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

Essa chamada de API vai falhar com um erro FieldMaskError.FIELD_HAS_SUBFIELDS. Como MaximizeConversions tem três subcampos, o servidor da API Google Ads espera que as máscaras de campo desses campos estejam presentes na solicitação. No entanto, FieldMaskUtil não pode gerar máscaras de campo corretamente nessa situação, já que a solicitação não está definindo esses campos.

Nesses casos, é possível editar manualmente a máscara de campo da seguinte maneira:

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

FieldMask 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.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

Como limpar campos

A API Google Ads permite limpar alguns valores de campo. Para limpar um campo, é necessário definir manualmente a máscara de campo dele. Definir um campo como o valor padrão (como zero para um campo int64) não limpa o campo.

O exemplo de código a seguir mostra como limpar o campo target_cpa_micros da estratégia de lances MaximizeConversions.

Código correto

O código a seguir limpa o campo target_cpa_micros porque estamos definindo o maximize_conversions.target_cpa_micros na máscara de campo e não definindo o campo campaign.MaximizeConversions.TargetCpaMicros.

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(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 fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

Código incorreto

O código a seguir não limpa o campo target_cpa_micros, já que estamos definindo esse campo como zero. Tanto o FieldMaskUtils quanto o servidor da API Google Ads vão ignorar esse valor. Além disso, talvez você não receba um erro nesse caso, já que o valor foi ignorado pelo servidor.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object. Attempt to clear the target_cpa_micros field by setting it to 0.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// 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 = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });