Maschere di campo

Nell'API Google Ads, gli aggiornamenti vengono effettuati utilizzando una maschera di campo. La maschera dei campi elenca tutti i campi che intendi modificare con l'aggiornamento e tutti i campi specificati che non sono presenti nella maschera del campo verranno ignorati, anche se inviati al server.

FieldMaskUtil

Il metodo consigliato per generare maschere di campo è utilizzare la nostra utilità per le maschere di campo integrata, che consente di generare maschere di campo da un oggetto modificato invece di crearle da zero.

Di seguito è riportato un esempio per l'aggiornamento di una campagna:

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

Per prima cosa, creiamo un oggetto Campaign vuoto. Abbiamo quindi impostato il nome della risorsa in modo che l'API sappia esattamente quale campagna stiamo aggiornando.

L'esempio utilizza il metodo FieldMasks.AllSetFieldsOf nella campagna, producendo automaticamente una maschera di campo che enumera tutti i campi impostati. Puoi quindi passare la maschera restituita direttamente alla chiamata di aggiornamento.

A volte potrebbe essere necessario lavorare con un oggetto esistente e aggiornare alcuni campi. In questi casi, devi modificare il codice come segue:

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

Per creare una maschera di campo da zero, devi prima creare un oggetto FieldMask, poi compilare un array con i nomi di tutti i campi che intendi modificare e infine aggiungere i contenuti dell'array al campo Path della maschera di campo.

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "status", "name" });

Aggiornamento dei campi dei messaggi e dei relativi campi secondari

I campi MESSAGE possono avere dei sottocampi (ad esempio MaximizeConversions che ne ha tre: target_cpa_micros, cpc_bid_ceiling_micros e cpc_bid_floor_micros) oppure non averne affatto (ad esempio ManualCpm).

Campi dei messaggi senza campi secondari definiti

Quando aggiorni un campo MESSAGE che non è definito con alcun sottocampi, utilizza FieldMasks per generare una maschera di campo, come descritto sopra.

Campi dei messaggi con sottocampi definiti

Quando aggiorni un campo MESSAGE definito con sottocampi senza impostare esplicitamente alcun sottocampo del messaggio, devi aggiungere manualmente ciascuno dei sottocampi MESSAGE mutabili a FieldMask, come nell'esempio precedente, che crea una maschera di campo da zero.

Un esempio comune è l'aggiornamento della strategia di offerta di una campagna senza impostare alcun campo nella nuova strategia di offerta. L'esempio riportato di seguito mostra come aggiornare una campagna per utilizzare la strategia di offerta MaximizeConversions senza impostare nessuno dei campi secondari nella strategia di offerta.

In questo caso, l'utilizzo dei metodi AllSetFieldsOf() e FromChanges() di FieldMasks non consente di raggiungere l'obiettivo previsto.

L'esempio seguente genera una maschera di campo che include maximize_conversions. Tuttavia, l'API Google Ads non consente questo comportamento per impedire la cancellazione accidentale dei campi e viene restituito un errore FieldMaskError.FIELD_HAS_SUBFIELDS.

Avviso: il codice seguente genera un errore.

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

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

L'esempio seguente mostra come aggiornare correttamente una campagna per utilizzare la strategia di offerta MaximizeConversions senza impostare nessuno dei relativi campi secondari.

Operazione riuscita: il codice riportato di seguito aggiorna la strategia di offerta della campagna.

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

// Creates a field mask from the existing campaign and adds all of the fields
// on the MaximizeConversions bidding strategy to the field mask. Because these
// fields are 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 with none of its subfields set.
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
};

Cancellazione dei campi

Alcuni campi possono essere cancellati esplicitamente. Come nell'esempio precedente, devi aggiungere esplicitamente questi campi alla maschera. Ad esempio, supponiamo di avere una campagna che utilizza una strategia di offerta MaximizeConversions e che il campo target_cpa_micros sia impostato con un valore maggiore di 0.

Viene eseguito il codice seguente; tuttavia, maximize_conversions.target_cpa_micros non verrà aggiunto alla maschera del campo e non vengono apportate modifiche al campo target_cpa_micros:

Avviso: questo codice non genera un errore, ma la target_cpa_micros della strategia di offerta MaximizeConversions non verrà cancellata.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set 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 });

Il prossimo esempio mostra come cancellare correttamente il campo target_cpa_micros nella strategia di offerta MaximizeConversions.

Operazione riuscita: il codice seguente cancella target_cpa_micros.

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

Tieni presente che l'esempio "non corretto" riportato sopra funziona come previsto per i campi definiti come optional nell'API Google Ads protocol buffers. Tuttavia, poiché target_cpa_micros non è un campo optional, l'esempio "sbagliato" non aggiorna la strategia di offerta per cancellare il campo target_cpa.

Punto chiave: se vuoi cancellare un campo, il modo più sicuro per raggiungere questo obiettivo è aggiungere esplicitamente il campo alla maschera del campo.