Feldmasken

In der Google Ads API werden Aktualisierungen mithilfe einer Feldmaske vorgenommen. In der Feldmaske sind alle Felder aufgeführt, die Sie mit der Aktualisierung ä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 Google\Protobuf\FieldMask erstellen, ein Array mit den Namen aller Felder, die Sie ändern möchten, und dieses dann dem Pfadfeld der Feldmaske zuweisen.

Sie können auch unser integriertes Dienstprogramm für Feldmasken (FieldMasks) verwenden. Damit werden viele der spezifischen Details ausgeblendet und Sie können Feldmasken automatisch generieren lassen, indem Sie die Änderungen an den Feldern der Einheit beobachten.

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 und dann der zugehörige Ressourcenname mit ResourceNames festgelegt, damit die API weiß, welche Kampagne aktualisiert wird. status ist auch auf PAUSED festgelegt.

Mit dem Code wird dann ein CampaignOperation-Objekt erstellt und die zuvor erstellte Kampagne dafür festgelegt. Anschließend wird FieldMasks::allSetFieldsOf() verwendet, um eine Feldmaske für die Kampagne mit allen geänderten Feldern zu erstellen. 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 allSetFieldsOf() verwenden können.

Nachrichtenfelder und ihre untergeordneten Felder aktualisieren

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

Nachrichtfelder ohne definierte Unterfelder

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

Nachrichtfelder mit definierten untergeordneten Feldern

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 zu FieldMask hinzufügen. Das ist ähnlich wie im vorherigen Beispiel, in dem eine Feldmaske von Grund auf neu erstellt wurde.

Ein häufiges Beispiel ist das Aktualisieren der Gebotsstrategie einer Kampagne, ohne dass Felder der neuen Gebotsstrategie festgelegt werden. Im folgenden Code wird veranschaulicht, wie Sie eine Kampagne so aktualisieren, dass die Gebotsstrategie MaximizeConversions verwendet wird, ohne dass Sie Unterfelder für die Gebotsstrategie festlegen.

In diesem Fall wird das beabsichtigte Ziel durch die Verwendung der Methoden allSetFieldsOf() und compare() des 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. Stattdessen wird ein FieldMaskError.FIELD_HAS_SUBFIELDS-Fehler ausgegeben.

Warnung :Der folgende Code führt zu einem Fehler.

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

Im folgenden Code wird gezeigt, wie eine Kampagne richtig aktualisiert wird, damit die Gebotsstrategie MaximizeConversions verwendet wird, ohne dass die zugehörigen Unterfelder festgelegt werden.

Erfolg :Mit dem folgenden Code wird die Gebotsstrategie der Kampagne aktualisiert.

// 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 diese Felder explizit der Feldmaske hinzufügen. Angenommen, Sie haben eine Kampagne, in der die Gebotsstrategie MaximizeConversions verwendet wird und für das Feld target_cpa_micros ein Wert festgelegt ist, der größer als 0 ist.

Der folgende Code wird ausgeführt. Die maximize_conversions.target_cpa_micros wird jedoch nicht der Feldmaske hinzugefügt. Daher werden keine Änderungen am Feld target_cpa_micros vorgenommen:

Warnung :Dieser Code führt nicht zu einem Fehler, aber die target_cpa_micros der Gebotsstrategie MaximizeConversions wird nicht gelöscht.

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

Im folgenden Code wird gezeigt, wie das Feld target_cpa_micros in der Gebotsstrategie MaximizeConversions richtig gelöscht wird.

Erfolg :Der folgende Code löscht 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);

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 kein optional-Feld ist, wird die Gebotsstrategie durch den „falschen“ Code nicht aktualisiert, um das Feld target_cpa zu leeren.

Wichtiger Hinweis :Wenn Sie ein Feld leeren möchten, ist es am sichersten, es explizit der Feldmaske hinzuzufügen.