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:

// 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. Quindi impostiamo il nome della risorsa che l'API sappia esattamente quale campagna stiamo aggiornando.

Nell'esempio viene utilizzato il metodo FieldMasks.AllSetFieldsOf nella campagna genera automaticamente una maschera di campo con l'enumerazione di tutti i campi impostati. Puoi quindi passare la maschera restituita direttamente alla chiamata di aggiornamento.

A volte potresti dover lavorare con un oggetto esistente e aggiornare alcuni campi. In questi casi, dovrai 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 dei campi da zero, devi prima creare una FieldMask , crea un array compilato con i nomi di tutti i campi che vuoi da modificare e, infine, aggiungi 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

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 FieldMasks 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 FromChanges() di FieldMasks 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 = 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 il parametro MaximizeConversions senza impostare nessuno dei relativi campi secondari.

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

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 = 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 target_cpa_micros della strategia di offerta MaximizeConversions.

// 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 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.