Maschere di campo

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

FieldMaskUtil

Il modo consigliato per generare maschere dei campi è usare la nostra maschera integrata dei campi che ti consente di generare maschere di campo da un oggetto modificato anziché creandoli da zero.

Di seguito è riportato 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 prima un oggetto Campaign vuoto, quindi imposta la relativa risorsa in modo che l'API sappia quale campagna viene aggiornata.

L'esempio utilizza il metodo FieldMasks.allSetFieldsOf() nella campagna per genera automaticamente una maschera dei campi 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 modifica il codice come segue:

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 dei campi da zero, devi prima creare una FieldMask , poi aggiungi il nome di ciascuno dei campi che intendi modificare .

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

Aggiornamento dei campi dei messaggi e dei relativi campi secondari

MESSAGE campi possono avere campi secondari (ad esempio MaximizeConversions, che ne ha tre: target_cpa_micros, cpc_bid_ceiling_micros e cpc_bid_floor_micros) o non possono averne nessuno (ad esempio ManualCpm).

Campi del messaggio senza campi secondari definiti

Quando aggiorni un campo MESSAGE che non è definito con altri campi secondari, utilizza FieldMaskUtil per generare una maschera di campo, come descritto sopra.

Campi del messaggio con campi secondari definiti

Quando aggiorni un campo MESSAGE definito con campi secondari senza impostare in modo esplicito uno qualsiasi dei campi secondari di quel messaggio, è necessario aggiungi ciascuno dei sottocampi MESSAGE mutabili a FieldMask, come nell'esempio precedente che crea una maschera dei campi da zero.

Un esempio comune è l'aggiornamento della strategia di offerta di una campagna senza impostare alcuna campi della nuova strategia di offerta. L'esempio seguente mostra come aggiorna una campagna per utilizzare Strategia di offerta MaximizeConversions senza impostare nessuno dei campi secondari nella strategia di offerta.

In questo caso, utilizzando i metodi allSetFieldsOf() e compare() del metodo FieldMaskUtil non raggiunge l'obiettivo previsto.

L'esempio seguente genera una maschera di campo che include maximize_conversions. Tuttavia, l'API Google Ads non consente questo comportamento impedire la cancellazione accidentale dei campi e generare un 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 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));

L'esempio seguente mostra come aggiornare correttamente una campagna per utilizzare il parametro MaximizeConversions senza impostare nessuno dei relativi campi secondari.

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

Sgombero campi

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

Viene eseguito il codice riportato di seguito. tuttavia, maximize_conversions.target_cpa_micros non verranno aggiunte alla maschera del campo e quindi non verranno apportate modifiche alla Campo target_cpa_micros:

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

Il prossimo esempio mostra come cancellare correttamente target_cpa_micros della 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 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 il messaggio "Risposta errata" dell'esempio precedente funziona come previsto per i campi che sono definiti come optional nell'API Google Ads protocol buffers Ma poiché target_cpa_micros non è un campo optional, il messaggio "errato" esempio non aggiorna strategia di offerta per cancellare il campo target_cpa.