Maschere dei campi

Nell'API Google Ads, gli aggiornamenti vengono eseguiti utilizzando una maschera del campo. La maschera del campo (google.protobuf.FieldMask) contiene un elenco di percorsi di campo in snake_case che intendi modificare con l'aggiornamento. Eventuali campi specificati che non sono nella maschera di campo vengono ignorati, anche se inviati al server.

Utilità FieldMasks

Il modo consigliato per generare maschere di campo nella libreria client Java è utilizzare la classe di utilità FieldMasks integrata, che consente di generare maschere di campo da un oggetto modificato anziché crearle da zero.

Ecco un esempio di aggiornamento di una campagna:

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

Questo esempio crea innanzitutto un builder Campaign vuoto e imposta il nome della risorsa in modo che l'API sappia quale campagna viene aggiornata.

L'esempio chiama quindi FieldMasks.allSetFieldsOf() nella campagna per produrre automaticamente una maschera di campo che enumera tutti i campi impostati. Puoi passare la maschera restituita direttamente alla chiamata di aggiornamento.

Se devi lavorare con un oggetto esistente e aggiornare alcuni campi, utilizza FieldMasks.compare() nel seguente modo:

// Assumes existingCampaign was retrieved from a previous API call.

// Creates a new campaign based on 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 updates 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));

Per creare una maschera di campo da zero, crea un generatore FieldMask e aggiungi il nome snake_case di ogni campo che intendi modificare:

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

Aggiornare i campi del messaggio e i relativi campi secondari

I campi MESSAGE possono avere sottocampi (ad esempio MaximizeConversions, che ha target_cpa_micros, cpc_bid_ceiling_micros e cpc_bid_floor_micros) oppure non possono avere sottocampi (ad esempio ManualCpm).

Campi del messaggio senza campi secondari definiti

Quando aggiorni un campo MESSAGE non definito con alcun campo secondario, utilizza l'utilità FieldMasks per generare una maschera del campo, come descritto nella sezione precedente.

Campi del messaggio con sottocampi definiti

Quando aggiorni un campo MESSAGE che ha campi secondari definiti senza impostare esplicitamente nessuno dei campi secondari nel messaggio, devi aggiungere manualmente ciascuno dei campi secondari MESSAGE modificabili al FieldMask, in modo simile alla creazione di una maschera di campo da zero.

Un esempio comune è l'aggiornamento della strategia di offerta di una campagna (campo oneofcampaign_bidding_strategy) senza impostare nessuno dei campi della nuova strategia di offerta. L'esempio seguente mostra come aggiornare una campagna in modo che utilizzi la strategia di offerta MaximizeConversions senza impostare nessuno dei campi secondari della strategia di offerta.

In questo caso, l'utilizzo dei metodi allSetFieldsOf() e compare() di FieldMasks da soli non consente di raggiungere l'obiettivo previsto.

L'esempio seguente genera una maschera del campo che include maximize_conversions. Tuttavia, l'API Google Ads non consente percorsi dei messaggi di primo livello con campi secondari in una maschera di aggiornamento (per evitare di cancellare accidentalmente i campi secondari) e restituisce un errore FieldMaskError.FIELD_HAS_SUBFIELDS.

// 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 FieldMasks.allSetFieldsOf to derive the update
// mask. The field mask includes 'maximize_conversions', which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields with
// subfields cannot be included directly in a field mask.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Il seguente esempio mostra come aggiornare correttamente una campagna per utilizzare la strategia di offerta MaximizeConversions senza impostare nessuno dei relativi campi secondari. Scopri di più sull'assegnazione di strategie di offerta standard e di portafoglio.

// 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 campaign and adds the mutable subfield
// ('maximize_conversions.target_cpa_micros') on the MaximizeConversions
// bidding strategy to the field mask. Because this subfield is included in the
// field mask while excluded from the campaign object, the Google Ads API
// switches the campaign's bidding strategy oneof to MaximizeConversions with
// target_cpa_micros unset.
FieldMask fieldMask =
    FieldMasks.allSetFieldsOf(campaign).toBuilder()
        .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();

Cancella campi

Alcuni campi possono essere cancellati in modo esplicito. Analogamente all'esempio precedente, devi aggiungere esplicitamente questi campi alla maschera del campo lasciandoli non impostati nell'oggetto messaggio. Ad esempio, supponiamo che tu abbia una campagna che utilizza una strategia di offerta MaximizeConversions e che il campo target_cpa_micros sia impostato con un valore superiore a 0.

Il seguente codice viene eseguito, ma maximize_conversions.target_cpa_micros non verrà cancellato come previsto:

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

// Constructs an operation using FieldMasks.allSetFieldsOf to derive the
// update mask.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// Sends the operation in a mutate request that does not clear the field
// cleanly.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

L'esempio successivo mostra come cancellare correttamente il campo target_cpa_micros nella strategia di offerta MaximizeConversions.

// 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 campaign and adds the
// 'maximize_conversions.target_cpa_micros' field to the field mask, which
// clears 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();