Feldmasken

In der Google Ads API werden Aktualisierungen mithilfe einer Feldmaske vorgenommen. Die Feldmaske listet alle Felder, die Sie mit der Aktualisierung ändern möchten, sowie alle angegebenen Felder die nicht in der Feldmaske enthalten sind, werden ignoriert, auch wenn sie an den Server gesendet werden. Ich können Sie manuell eine Feldmaske erstellen, Google\Protobuf\FieldMask, ein Array mit den Namen aller Felder erstellen, die Sie ändern möchten, Diese wird dann dem Pfadfeld der Feldmaske zugewiesen.

Sie können auch unser integriertes Dienstprogramm für die Feldmaske verwenden (FieldMasks) Dadurch werden viele spezifische Details ausgeblendet und Sie können Felder automatisch maskiert. Dabei werden die Änderungen überwacht, 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));

Dieser Code erstellt zuerst ein Campaign-Objekt und legt dann seinen Ressourcennamen mithilfe von ResourceNames, damit die API weiß, welche Kampagne aktualisiert. status ist auch auf PAUSED gesetzt.

Mit dem Code wird dann ein CampaignOperation-Objekt erstellt und das zuvor erstellten Kampagne hinzugefügt. Danach werden mithilfe von FieldMasks::allSetFieldsOf() um eine Feldmaske für die Kampagne zu erstellen, indem alle geänderten Felder verwendet werden. Zu guter Letzt übergibt die zurückgegebene Maske an das Kampagnenvorgangsobjekt.

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

Nachrichtenfelder und ihre Unterfelder aktualisieren

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

Nachrichtenfelder ohne definierte Unterfelder

Wenn Sie ein MESSAGE-Feld aktualisieren, das nicht mit einem Unterfeld definiert ist, verwenden Sie den FieldMasks zum Generieren einer Feldmaske, wie zuvor beschrieben.

Nachrichtenfelder mit definierten untergeordneten Feldern

Beim Aktualisieren eines MESSAGE-Felds, das mit Unterfeldern ohne explizit eines der Unterfelder der Nachricht festlegen, müssen Sie manuell Fügen Sie jedes der änderbaren MESSAGE-Unterfelder zu FieldMask hinzu, ähnlich wie bei Beispiel, in dem eine komplett neue Feldmaske erstellt wurde.

Ein gängiges Beispiel ist die Aktualisierung der Gebotsstrategie einer Kampagne, ohne der Felder der neuen Gebotsstrategie. Der folgende Code zeigt, wie Sie Kampagne aktualisieren, um Gebotsstrategie MaximizeConversions ohne Unterfelder der Gebotsstrategie festzulegen.

In diesem Fall wird mithilfe der Methoden allSetFieldsOf() und compare() der Mit FieldMasks wird das vorgesehene Ziel nicht erreicht.

Der folgende Code generiert eine Feldmaske, die maximize_conversions enthält. Die Google Ads API lässt dies jedoch nicht zu, um zu verhindern, Felder versehentlich gelöscht, und es wird eine FieldMaskError.FIELD_HAS_SUBFIELDS 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]);

Der folgende Code zeigt, wie eine Kampagne ordnungsgemäß für die Verwendung des MaximizeConversions-Gebotsstrategie, ohne eines ihrer untergeordneten 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 werden der Feldmaske explizit hinzugefügt. Angenommen, Sie haben eine Kampagne mit der Gebotsstrategie „MaximizeConversions“ verwendet, Das Feld target_cpa_micros enthält einen Wert, der größer als 0 ist.

Der folgende Code wird ausgeführt: Der maximize_conversions.target_cpa_micros werden der Feldmaske nicht hinzugefügt und es werden keine Änderungen an der Feld target_cpa_micros:

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

Mit dem folgenden Code wird veranschaulicht, wie target_cpa_micros ordnungsgemäß gelöscht wird. für die Gebotsstrategie MaximizeConversions.

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

Beachten Sie, dass das Feld wie vorgesehen funktioniert, wenn der Code als optional in der Google Ads API protocol buffers. Aber da die target_cpa_micros kein optional-Feld ist, ist das "falsch" aktualisiert den Code nicht Gebotsstrategie ändern, um das Feld target_cpa zu löschen.