Nell'API Google Ads, gli aggiornamenti vengono eseguiti utilizzando una maschera di campo. La maschera di campo elenca tutti i campi che intendi modificare con l'aggiornamento e tutti i campi specificati che non sono presenti nella maschera di campo vengono ignorati, anche se inviati al server. Puoi creare manualmente una maschera di campo creando un FieldMask (Google\Protobuf\FieldMask), creando un array compilato con i nomi di tutti i campi che intendi modificare e assegnando l'array al campo paths della maschera di campo.
Puoi anche utilizzare la nostra utilità di maschera di campo integrata (FieldMasks), che nasconde molti dei dettagli specifici e ti consente di generare automaticamente maschere di campo esaminando le modifiche apportate ai campi dell'entità.
Ecco un esempio di aggiornamento di una campagna:
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'status' => CampaignStatusEnum\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 viene aggiornata. status è impostato anche su CampaignStatus::PAUSED.
Il codice crea quindi un oggetto CampaignOperation e imposta la campagna creata in precedenza. Dopodiché, utilizza FieldMasks::allSetFieldsOf() per creare una maschera di campo per la campagna enumerando tutti i campi modificati. Infine, passa 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é FieldMasks::allSetFieldsOf($campaign).
Aggiorna i campi dei messaggi e i relativi sottocampi
I campi MESSAGE possono avere campi secondari (come MaximizeConversions, che include campi secondari come target_cpa_micros, cpc_bid_ceiling_micros e cpc_bid_floor_micros) o non averne affatto (come ManualCpm).
Campi dei messaggi senza sottocampi definiti
Quando aggiorni un campo MESSAGE non definito con campi secondari, utilizza FieldMasks per generare una maschera di campo, come descritto in precedenza.
Campi dei messaggi con sottocampi definiti
Quando aggiorni un campo MESSAGE definito con campi secondari senza impostare esplicitamente nessuno dei campi secondari su quel messaggio, devi aggiungere manualmente ciascuno dei campi secondari MESSAGE mutabili a FieldMask, in modo simile all'esempio precedente che ha creato 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. Il seguente codice 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 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 genera un errore FieldMaskError.FIELD_HAS_SUBFIELDS.
// 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 includes 'maximize_conversions',
// which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
MutateCampaignsRequest::build($customerId, [$campaignOperation])
);
Il seguente codice mostra come aggiornare correttamente una campagna per utilizzare la strategia di offerta MaximizeConversions senza impostare nessuno dei relativi campi secondari.
// 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 the mutable
// subfield 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 sets 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->getPaths()[] = '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);
Cancella campi
Alcuni campi possono essere cancellati esplicitamente. Come nell'esempio precedente, devi aggiungere esplicitamente questi campi alla maschera di campo perché FieldMasks ignora i campi scalari Proto3 impostati sui valori predefiniti (come 0, false o ""). Ad esempio, supponiamo che tu abbia una campagna che utilizza una strategia di offerta MaximizeConversions e che il campo target_cpa_micros sia impostato su un valore maggiore di 0.
Il seguente codice viene eseguito, ma maximize_conversions.target_cpa_micros non viene aggiunto alla maschera di campo, quindi non vengono apportate modifiche al campo target_cpa_micros:
// 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_micros' => 0
]),
'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);
// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does 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 succeeds, but does 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(
MutateCampaignsRequest::build($customerId, [$campaignOperation])
);
Il codice seguente mostra come cancellare correttamente il campo target_cpa_micros nella strategia di offerta MaximizeConversions.
// 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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->getPaths()[] = '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 l'impostazione di un valore predefinito funziona come previsto per i campi definiti come optional nei buffer di protocollo dell'API Google Ads. Tuttavia, poiché target_cpa_micros non è un campo optional, l'impostazione su 0 senza aggiungere esplicitamente il percorso alla maschera di campo non aggiorna la strategia di offerta per cancellare target_cpa_micros.