Masques de champ

Dans l'API Google Ads, un masque de champ est utilisé pour fournir une liste des champs qu'une requête API doit mettre à jour. Tout champ non spécifié dans le masque de champ sera ignoré, même s'il est envoyé au serveur.

Classe FieldMaskUtil

La méthode recommandée pour générer des masques de champ consiste à utiliser la classe FieldMaskUtil intégrée, qui vous permet de générer des masques de champ à partir d'un objet modifié au lieu de les créer de toutes pièces.

Voici un exemple de mise à jour d'une campagne qui utilise la méthode FieldMasks.AllSetFieldsOf pour générer un masque de champ qui énumère tous les champs définis. Vous pouvez ensuite transmettre le masque de champ généré directement à l'appel d'update.

// 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 });

Il peut arriver que vous deviez travailler avec un objet existant et mettre à jour quelques champs. Dans ce cas, vous devez modifier le code pour utiliser la méthode FieldMasks.FromChanges. Cette méthode génère un masque de champ qui représente la différence entre deux objets.

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

Gérer les erreurs FieldMaskError.FIELD_HAS_SUBFIELDS

Dans de rares cas, vous devrez peut-être définir un champ sans mettre à jour aucun des sous-champs de ce type. Prenons l'exemple suivant :

// 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 });

Cet appel d'API échouera et renverra une erreur FieldMaskError.FIELD_HAS_SUBFIELDS. Étant donné que MaximizeConversions comporte trois sous-champs, le serveur de l'API Google Ads s'attend à ce que les masques de champ de ces champs soient présents dans la requête. Toutefois, FieldMaskUtil ne peut pas générer correctement les masques de champ dans cette situation, car la requête ne définit pas ces champs.

Dans ce cas, vous pouvez modifier manuellement le masque de champ comme suit :

// 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
};

Effacer des champs

L'API Google Ads permet d'effacer certaines valeurs de champ. Pour effacer un champ, vous devez définir manuellement le masque de champ correspondant. Définir un champ sur sa valeur par défaut (par exemple, zéro pour un champ int64) ne l'effacera pas.

L'exemple de code suivant montre comment effacer le champ target_cpa_micros de la stratégie d'enchères MaximizeConversions.

Code correct

Le code suivant efface le champ target_cpa_micros, car nous définissons maximize_conversions.target_cpa_micros dans le masque de champ et ne définissons pas le champ 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
};

Code incorrect

Le code suivant n'efface pas le champ target_cpa_micros, car nous définissons ce champ sur zéro. Cette valeur sera ignorée par FieldMaskUtils et par le serveur de l'API Google Ads. De plus, il est possible que vous ne receviez pas d'erreur dans ce cas, car la valeur a été ignorée par le serveur.

// 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 });