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

Puoi anche usare la nostra utilità integrata per la maschera dei campi (FieldMasks), che nasconde molti dettagli specifici e consente di generare 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 risorsa utilizzando ResourceNames, in modo che l'API sappia quale campagna viene aggiornato. Anche status è impostato su PAUSED.

Il codice crea quindi un oggetto CampaignOperation e imposta la classe a cui è stata creata. Dopodiché, utilizza FieldMasks::allSetFieldsOf() per creare una maschera campi per la campagna utilizzando 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. Per nel codice precedente, avresti potuto usare FieldMasks::compare(new Campaign(), $campaign) anziché allSetFieldsOf().

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 in precedenza.

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, in cui viene creata una maschera di campo da zero.

Un esempio comune è l'aggiornamento della strategia di offerta di una campagna senza impostare alcuna campi della nuova strategia di offerta. Il codice 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 FieldMasks non raggiunge 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 la cancellazione accidentale dei campi produce un 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 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 il 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 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 per l'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 = 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 target_cpa_micros della 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 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 messaggio "Risposta errata" funziona come previsto per i campi definiti come optional nell'API Google Ads protocol buffers. Ma poiché target_cpa_micros non è un campo optional, il messaggio "errato" nel codice non aggiorna strategia di offerta per cancellare il campo target_cpa.