Feldmasken

In der Google Ads API werden Aktualisierungen mithilfe einer Feldmaske vorgenommen. Die Feldmaske listet alle Felder auf, die Sie mit der Aktualisierung ändern möchten. Alle angegebenen Felder, die nicht in der Feldmaske enthalten sind, werden ignoriert, selbst wenn sie an den Server gesendet werden. Sie können eine Feldmaske manuell erstellen. Dazu erstellen Sie eine Google\Protobuf\FieldMask, erstellen ein Array, das die Namen aller Felder enthält, die Sie ändern möchten, und weisen dieses dann dem Pfadfeld der Feldmaske zu.

Sie können auch unser integriertes Dienstprogramm für Feldmasken (FieldMasks) verwenden, das viele der spezifischen Details verbirgt und Feldmasken automatisch generiert, indem die Änderungen überwacht werden, die Sie an den Feldern der Entität vornehmen.

Hier ein Beispiel für die Aktualisierung einer Kampagne:

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

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

Mit diesem Code wird zuerst ein Campaign-Objekt erstellt. Anschließend wird der Ressourcenname mit ResourceNames festgelegt, damit die API weiß, welche Kampagne aktualisiert wird. status ist auch auf PAUSED gesetzt.

Mit dem Code wird dann ein CampaignOperation-Objekt erstellt und für die zuvor erstellte Kampagne festgelegt. Danach wird mit FieldMasks::allSetFieldsOf() eine Feldmaske für die Kampagne erstellt. Dabei werden alle geänderten Felder verwendet. Schließlich wird die zurückgegebene Maske an das Kampagnenvorgangsobjekt übergeben.

FieldMasks::allSetFieldsOf ist eine praktische Methode für FieldMasks::compare(). Es vergleicht das übergebene Objekt mit einem leeren Objekt derselben Klasse. Im vorherigen Code hätten Sie beispielsweise FieldMasks::compare(new Campaign(), $campaign) anstelle von allSetFieldsOf() verwenden können.

Nachrichtenfelder und ihre Unterfelder aktualisieren

MESSAGE-Felder können untergeordnete Felder haben (z. B. MaximizeConversions mit drei: target_cpa_micros, cpc_bid_ceiling_micros und cpc_bid_floor_micros) oder gar keines (z. B. ManualCpm).

Nachrichtenfelder ohne definierte Unterfelder

Wenn Sie ein MESSAGE-Feld aktualisieren, das nicht mit Unterfeldern definiert ist, verwenden Sie FieldMasks, um wie zuvor beschrieben eine Feldmaske zu generieren.

Nachrichtenfelder mit definierten untergeordneten Feldern

Wenn Sie ein MESSAGE-Feld aktualisieren, das mit Unterfeldern definiert ist, ohne explizit eines der Unterfelder der Nachricht festzulegen, müssen Sie jedes der änderbaren MESSAGE-Unterfelder manuell zu FieldMask hinzufügen, ähnlich wie im vorherigen Beispiel, bei dem eine komplett neue Feldmaske erstellt wurde.

Ein gängiges Beispiel ist die Aktualisierung der Gebotsstrategie einer Kampagne, ohne eines der Felder für die neue Gebotsstrategie festzulegen. Der folgende Code zeigt, wie Sie eine Kampagne aktualisieren, um die Gebotsstrategie MaximizeConversions zu verwenden, ohne eines der untergeordneten Felder der Gebotsstrategie festzulegen.

In diesem Fall wird mit den Methoden allSetFieldsOf() und compare() der FieldMasks nicht das beabsichtigte Ziel erreicht.

Der folgende Code generiert eine Feldmaske, die maximize_conversions enthält. Die Google Ads API lässt dies jedoch nicht zu, um das versehentliche Löschen von Feldern zu verhindern und den Fehler FieldMaskError.FIELD_HAS_SUBFIELDS zu erzeugen.

// 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]);

Der folgende Code zeigt, wie eine Kampagne ordnungsgemäß für die Verwendung der Gebotsstrategie MaximizeConversions aktualisiert wird, ohne dass eines ihrer Unterfelder festgelegt wird.

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

Felder löschen

Einige Felder können explizit gelöscht werden. Ähnlich wie im vorherigen Beispiel müssen Sie der Feldmaske diese Felder explizit hinzufügen. Beispiel: In einer Kampagne wird die Gebotsstrategie MaximizeConversions verwendet und für das Feld target_cpa_micros ist ein Wert größer als 0 festgelegt.

Der folgende Code wird ausgeführt. Allerdings wird maximize_conversions.target_cpa_micros nicht der Feldmaske hinzugefügt und es 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' => 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]);

Der folgende Code zeigt, wie das Feld target_cpa_micros in der Gebotsstrategie MaximizeConversions korrekt gelöscht wird.

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

Hinweis: Der „falsche“ Code funktioniert wie vorgesehen für Felder, die in der Google Ads API protocol buffers als optional definiert sind. Da target_cpa_micros jedoch kein optional-Feld ist, wird die Gebotsstrategie durch den „falschen“ Code nicht aktualisiert, um das Feld target_cpa zu löschen.