Maschere di campo

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

FieldMaskUtil

Il modo consigliato per generare maschere di campo è utilizzare la nostra utilità integrata, che consente di generarle 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 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));

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

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

Se devi lavorare con un oggetto esistente per aggiornare alcuni campi, puoi modificare il codice nel seguente modo:

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

Per creare una maschera del campo da zero, devi prima creare un oggetto FieldMask, poi aggiungere il nome di ciascuno dei campi che intendi modificare all'oggetto.

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

Aggiornamento dei campi del messaggio 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 nessuno (ad esempio ManualCpm).

Campi del messaggio senza campi secondari definiti

Quando aggiorni un campo MESSAGE non definito con alcun sottocampo, utilizza FieldMaskUtil per generare una maschera dei campi, come descritto sopra.

Campi del messaggio con sottocampi definiti

Quando aggiorni un campo MESSAGE definito con i sottocampi senza impostare esplicitamente nessuno dei sottocampi nel messaggio, devi aggiungere manualmente ciascuno dei sottocampi MESSAGE modificabili a FieldMask, in modo simile all'esempio precedente che crea una maschera di campo da zero.

Un esempio comune è l'aggiornamento della strategia di offerta di una campagna senza impostare nessuno dei campi della nuova strategia di offerta. L'esempio seguente mostra come aggiornare una campagna per utilizzare 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 FieldMaskUtil 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 evitare di cancellare accidentalmente i campi e produce un errore FieldMaskError.FIELD_HAS_SUBFIELDS.

Avviso: il seguente codice genera un errore.

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

Il seguente esempio 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 correttamente la strategia di offerta della campagna.

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

Cancella campi

Alcuni campi possono essere cancellati in modo esplicito. Analogamente all'esempio precedente, devi aggiungere esplicitamente questi campi alla maschera del campo. 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 maggiore di 0.

Il seguente codice viene eseguito; tuttavia, maximize_conversions.target_cpa_micros non verrà aggiunto alla maschera del campo, quindi non verranno apportate modifiche al campo target_cpa_micros:

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

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

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

Operazione riuscita: il seguente codice cancella 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();

Tieni presente che l'esempio "errato" 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 "errato" non aggiorna la strategia di offerta per cancellare il campo target_cpa.

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