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; tutti i campi specificati che non sono presenti nella maschera del campo vengono ignorati, anche se inviati al server. Potresti creare manualmente una maschera di campo creando un Google\Protobuf\FieldMask, un array compilato con i nomi di tutti i campi che vuoi modificare e assegnandolo poi al campo del percorso della maschera del campo.

Puoi anche utilizzare la nostra utilità integrata per la maschera dei campi (FieldMasks), che nasconde molti dettagli specifici e ti consente di generare automaticamente maschere di campo monitorando le modifiche apportate ai campi dell'entità.

Di seguito è riportato un esempio di aggiornamento di una campagna:

    $campaign = new Campaign([
        'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
        'status' => CampaignStatus::PAUSED
    ]);

    $campaignOperation = new CampaignOperation();
    $campaignOperation->setUpdate($campaign);
    $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

Questo codice crea prima un oggetto Campaign e poi imposta il nome della risorsa utilizzando ResourceNames, in modo che l'API sappia quale campagna è in fase di aggiornamento. Anche status è impostato su PAUSED.

Il codice crea quindi un oggetto CampaignOperation e imposta la campagna creata in precedenza. Dopodiché, utilizza FieldMasks::allSetFieldsOf() per creare una maschera dei campi per la campagna utilizzando tutti i campi modificati. Infine, trasmette la maschera restituita all'oggetto dell'operazione della campagna.

Tieni presente che FieldMasks::allSetFieldsOf è un metodo pratico per FieldMasks::compare(). Confronta l'oggetto passato con un oggetto vuoto della stessa classe. Ad esempio, nel codice precedente avresti potuto utilizzare FieldMasks::compare(new Campaign(), $campaign) anziché allSetFieldsOf().

Aggiornamento dei campi dei messaggi e dei relativi campi secondari

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

Campi del messaggio senza campi secondari definiti

Quando aggiorni un campo MESSAGE non definito con campi secondari, utilizza FieldMasks per generare una maschera di campo, come descritto in precedenza.

Campi del messaggio con campi secondari definiti

Quando aggiorni un campo MESSAGE definito con campi secondari senza impostare esplicitamente nessuno dei campi secondari nel messaggio, devi aggiungere manualmente ciascuno dei sottocampi MESSAGE modificabili a FieldMask, come nell'esempio precedente, in cui hai creato una maschera dei campi da zero.

Un esempio comune è l'aggiornamento della strategia di offerta di una campagna senza impostare nessuno dei campi sulla nuova strategia di offerta. Il codice 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 compare() di FieldMasks non consente di raggiungere l'obiettivo previsto.

Il seguente codice 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 generare 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

Il seguente codice mostra come aggiornare correttamente una campagna per utilizzare la strategia di offerta MaximizeConversions senza impostare nessuno dei suoi 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// 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 = 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->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

Cancellazione dei 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 sia impostato con un valore maggiore di 0.

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

Avviso: questo codice non genera un errore, ma la target_cpa_micros 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
    'status' => CampaignStatus::PAUSED
]);

// 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

Il seguente codice 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($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 = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

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

Punto chiave :se la tua intenzione è cancellare un campo, il modo più sicuro è aggiungerlo esplicitamente alla maschera del campo.