Feldmasken

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

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 sich nicht in der Feldmaske befinden, werden ignoriert, auch wenn sie an den Server gesendet werden. Sie können eine Feldmaske manuell erstellen. Dazu erstellen Sie einen Google\Protobuf\FieldMask, legen ein Array mit den Namen aller Felder fest, die Sie ändern möchten, und weisen sie dann dem Pfadfeld der Feldmaske zu.

Sie können auch unser integriertes Dienstprogramm für Feldmasken (FieldMasks) verwenden. Damit werden viele spezifische Details ausgeblendet und Sie können Feldmasken automatisch generieren, indem Sie die Änderungen an den Feldern der Entität 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));

Dieser Code erstellt zuerst ein Kampagnenobjekt und legt dann seinen Ressourcennamen mit ResourceNames fest, damit die API weiß, welche Kampagne aktualisiert wird. status ist auch auf PAUSED festgelegt.

Der Code erstellt dann ein CampaignOperation-Objekt und legt die zuvor erstellte Kampagne darauf fest. Danach wird mit FieldMasks::allSetFieldsOf() eine Feldmaske für die Kampagne mit allen geänderten Feldern erstellt. Schließlich wird die zurückgegebene Maske an das Kampagnenvorgangsobjekt übergeben.

FieldMasks::allSetFieldsOf ist eine bequeme Methode für FieldMasks::compare(). Das übergebene Objekt wird 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 Unterfelder aktualisieren

MESSAGE-Felder können untergeordnete Felder (z. B. MaximizeConversions mit drei target_cpa_micros, cpc_bid_ceiling_micros und cpc_bid_floor_micros) oder überhaupt keine Felder (wie ManualCpm) haben.

Nachrichtenfelder ohne definierte Unterfelder

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

Nachrichtenfelder mit definierten untergeordneten Feldern

Wenn Sie ein MESSAGE-Feld aktualisieren, das mit untergeordneten Feldern definiert ist, ohne explizit ein untergeordnetes Feld für diese Nachricht festzulegen, müssen Sie jedes der änderbaren MESSAGE-Unterfelder manuell zu FieldMask hinzufügen, ähnlich wie im vorherigen Beispiel, das eine Feldmaske von Grund auf neu erstellt hat.

Ein gängiges Beispiel ist das Aktualisieren der Gebotsstrategie einer Kampagne, ohne Felder der neuen Gebotsstrategie festzulegen. Der folgende Code zeigt, wie Sie eine Kampagne aktualisieren, um die Gebotsstrategie MaximizeConversions zu verwenden, ohne die untergeordneten Felder der Gebotsstrategie festzulegen.

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

Der folgende Code generiert eine Feldmaske, die maximize_conversions enthält. In der Google Ads API ist dies jedoch nicht zulässig, um das versehentliche Löschen von Feldern zu verhindern und den Fehler FieldMaskError.FIELD_HAS_SUBFIELDS auszugeben.

// 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 Sie eine Kampagne mit der Gebotsstrategie MaximizeConversions aktualisieren, ohne untergeordnete Felder 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 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, für die eine MaximizeConversions-Gebotsstrategie verwendet wird und für das Feld target_cpa_micros ein Wert größer als 0 festgelegt ist.

Der folgende Code wird ausgeführt. Allerdings wird maximize_conversions.target_cpa_micros der Feldmaske nicht 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 ordnungsgemäß 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);

Der „falsche“ Code funktioniert wie vorgesehen, wenn in der Google Ads API protocol buffers der Wert optional festgelegt ist. Da es sich bei target_cpa_micros jedoch nicht um das Feld optional handelt, aktualisiert der „falsche“ Code nicht die Gebotsstrategie, um das Feld target_cpa zu löschen.