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 eine Google\Protobuf\FieldMask erstellen, ein Array mit den Namen aller Felder erstellen, die Sie ändern möchten, und dieses dann dem Pfadfeld der Feldmaske zuweisen.

Sie können auch das integrierte Dienstprogramm für Feldmasken (FieldMasks) verwenden. Dabei werden viele Details ausgeblendet und Sie können Feldmasken automatisch generieren, indem Sie die Änderungen an den Feldern der Entität überwachen.

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 Kampagnenobjekt erstellt und dann der Ressourcenname mit ResourceNames festgelegt, damit die API weiß, welche Kampagne aktualisiert wird. status ist ebenfalls auf PAUSED gesetzt.

Anschließend wird mit dem Code ein CampaignOperation-Objekt erstellt und die zuvor erstellte Kampagne darauf festgelegt. Anschließend wird mit FieldMasks::allSetFieldsOf() eine Feldmaske für die Kampagne erstellt, wobei alle geänderten Felder verwendet werden. Schließlich wird die zurückgegebene Maske an das Kampagnenvorgang-Objekt übergeben.

FieldMasks::allSetFieldsOf ist eine praktische Methode für FieldMasks::compare(). Dabei wird das übergebene Objekt mit einem leeren Objekt derselben Klasse verglichen. Im obigen Code könnten Sie beispielsweise FieldMasks::compare(new Campaign(), $campaign) anstelle von allSetFieldsOf() verwenden.

Nachrichtenfelder und ihre untergeordneten Felder aktualisieren

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

Nachrichtenfelder ohne definierte untergeordnete Felder

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

Nachrichtenfelder mit definierten untergeordneten Feldern

Wenn Sie ein MESSAGE-Feld aktualisieren, das mit Unterfeldern definiert ist, ohne eines der Unterfelder explizit für diese Nachricht festzulegen, müssen Sie jedes der veränderbaren MESSAGE-Unterfelder manuell zur FieldMask hinzufügen, ähnlich wie im vorherigen Beispiel, in dem eine Feldmaske von Grund auf neu erstellt wurde.

Ein häufiges Beispiel ist die Aktualisierung der Gebotsstrategie einer Kampagne, ohne dass die Felder der neuen Gebotsstrategie festgelegt werden. Im folgenden Code wird gezeigt, wie eine Kampagne so aktualisiert wird, dass die Gebotsstrategie MaximizeConversions verwendet wird, ohne dass eines der Unterfelder für die Gebotsstrategie festgelegt wird.

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

Mit dem folgenden Code wird eine Feldmaske generiert, die maximize_conversions enthält. Die Google Ads API erlaubt dieses Verhalten jedoch nicht, um das versehentliche Löschen von Feldern zu verhindern. Es wird stattdessen der Fehler FieldMaskError.FIELD_HAS_SUBFIELDS 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, um die Gebotsstrategie MaximizeConversions zu verwenden, ohne eines ihrer untergeordneten Felder festzulegen.

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 der Feldmaske explizit hinzufügen. Angenommen, Sie haben eine Kampagne mit der Gebotsstrategie MaximizeConversions und das Feld target_cpa_micros ist auf einen Wert festgelegt, der über 0 liegt.

Der folgende Code wird ausgeführt, 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: Mit dem folgenden Code wird die target_cpa_micros gelöscht.

// 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 für Felder, die in der Google Ads API protocol buffers als optional definiert sind, wie vorgesehen. 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.

Wichtiger Hinweis :Wenn Sie ein Feld löschen möchten, sollten Sie es der Feldmaske explizit hinzufügen.