In der Google Ads API werden Aktualisierungen mithilfe einer Feldmaske vorgenommen. In der Feldmaske werden alle Felder aufgeführt, die Sie mit dem Update ändern möchten. Alle angegebenen Felder, die nicht in der Feldmaske enthalten sind, werden ignoriert, auch wenn sie an den Server gesendet werden. Sie können eine Feldmaske manuell erstellen, indem Sie ein FieldMask (Google\Protobuf\FieldMask) erstellen, ein Array mit den Namen aller Felder füllen, die Sie ändern möchten, und dieses Array dann dem Feld paths der Feldmaske zuweisen.
Sie können auch unser integriertes Dienstprogramm für Feldmasken (FieldMasks) verwenden, das viele der spezifischen Details verbirgt und es Ihnen ermöglicht, Feldmasken automatisch zu generieren, indem Sie die Änderungen an den Feldern der Entität prüfen.
Hier ein Beispiel für die Aktualisierung einer Kampagne:
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
Mit diesem Code wird zuerst ein Campaign-Objekt erstellt und dann der Ressourcenname mit ResourceNames festgelegt, damit die API weiß, welche Kampagne aktualisiert wird. status ist ebenfalls auf CampaignStatus::PAUSED gesetzt.
Anschließend wird ein CampaignOperation-Objekt erstellt und die zuvor erstellte Kampagne darauf festgelegt. Anschließend wird FieldMasks::allSetFieldsOf() verwendet, um eine Feldmaske für die Kampagne zu erstellen, indem alle geänderten Felder aufgezählt werden. Schließlich wird die zurückgegebene Maske an das Kampagnenvorgangsobjekt übergeben.
FieldMasks::allSetFieldsOf() ist eine praktische Methode für FieldMasks::compare(). Dabei wird das übergebene Objekt mit einem leeren Objekt derselben Klasse verglichen. Im vorherigen Code hätten Sie beispielsweise FieldMasks::compare(new Campaign(), $campaign) anstelle von FieldMasks::allSetFieldsOf($campaign) verwenden können.
Nachrichtenfelder und ihre Unterfelder aktualisieren
MESSAGE-Felder können Unterfelder haben (z. B. MaximizeConversions, das Unterfelder wie target_cpa_micros, cpc_bid_ceiling_micros und cpc_bid_floor_micros enthält) oder gar keine (z. B. ManualCpm).
Nachrichtenfelder ohne definierte Unterfelder
Wenn Sie ein MESSAGE-Feld aktualisieren, das nicht mit Unterfeldern definiert ist, verwenden Sie FieldMasks, um eine Feldmaske zu generieren, wie zuvor beschrieben.
Nachrichtenfelder mit definierten Unterfeldern
Wenn Sie ein MESSAGE-Feld aktualisieren, das mit Unterfeldern definiert ist, ohne eines der Unterfelder in dieser Nachricht explizit festzulegen, müssen Sie jedes der änderbaren MESSAGE-Unterfelder manuell zur FieldMask hinzufügen, ähnlich wie im vorherigen Beispiel, in dem eine Feldmaske von Grund auf neu erstellt wurde.
Ein gängiges Beispiel ist die Aktualisierung der Gebotsstrategie einer Kampagne, ohne dass Felder für die neue Gebotsstrategie festgelegt werden. Der folgende Code zeigt, wie Sie eine Kampagne so aktualisieren, dass die Gebotsstrategie MaximizeConversions verwendet wird, ohne dass eines der Unterfelder der Gebotsstrategie festgelegt wird.
In diesem Fall wird das beabsichtigte Ziel mit den Methoden allSetFieldsOf() und compare() von FieldMasks nicht erreicht.
Mit dem folgenden Code wird eine Feldmaske generiert, die maximize_conversions enthält.
Die Google Ads API lässt dieses Verhalten jedoch nicht zu, um zu verhindern, dass Felder versehentlich gelöscht werden. Es wird ein FieldMaskError.FIELD_HAS_SUBFIELDS-Fehler ausgegeben.
// 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])
);
Der folgende Code zeigt, wie Sie eine Kampagne richtig aktualisieren, um die Gebotsstrategie MaximizeConversions zu verwenden, ohne eines ihrer Unterfelder festzulegen.
// 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);
Felder löschen
Einige Felder können explizit gelöscht werden. Ähnlich wie im vorherigen Beispiel müssen Sie diese Felder explizit der Feldmaske hinzufügen, da FieldMasks Proto3-Skalarfelder ignoriert, die auf ihre Standardwerte gesetzt sind (z. B. 0, false oder ""). Angenommen, Sie haben eine Kampagne, die eine MaximizeConversions-Gebotsstrategie verwendet, und das Feld target_cpa_micros ist auf einen Wert größer als 0 gesetzt.
Der folgende Code wird ausgeführt, aber maximize_conversions.target_cpa_micros wird nicht zur Feldmaske hinzugefügt. Daher werden keine Änderungen am Feld target_cpa_micros vorgenommen:
// 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])
);
Der folgende Code zeigt, wie Sie das Feld target_cpa_micros in der Gebotsstrategie MaximizeConversions richtig löschen.
// 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);
Das Festlegen eines Standardwerts funktioniert wie vorgesehen für Felder, die in den Protokollzwischenspeichern der Google Ads API als optional definiert sind. Da target_cpa_micros jedoch kein optional-Feld ist, wird die Gebotsstrategie nicht aktualisiert, um target_cpa_micros zu löschen, wenn Sie es auf 0 festlegen, ohne den Pfad explizit zur Feldmaske hinzuzufügen.