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.

FieldMaskUtil

Die empfohlene Methode zum Generieren von Feldmasken ist die Verwendung unserer integrierten Feldmaske mit dem Sie Feldmasken aus einem geänderten Objekt generieren können, von Grund auf neu erstellen.

Hier ein Beispiel für die Aktualisierung einer Kampagne:

// Creates a Campaign object with the proper resource name and any other changes.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// allSetFieldsOf utility to derive the update mask. This mask tells the Google
// Ads API which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

In diesem Beispiel wird zuerst ein leeres Campaign-Objekt erstellt und dann seine Ressource festgelegt. , damit die API weiß, welche Kampagne aktualisiert wird.

Im Beispiel wird die Methode FieldMasks.allSetFieldsOf() für die Kampagne verwendet, erzeugen automatisch eine Feldmaske, die alle festgelegten Felder auflistet. Sie können dann übergeben Sie die zurückgegebene Maske direkt an den Aktualisierungsaufruf.

Wenn Sie mit einem vorhandenen Objekt arbeiten müssen, um einige Felder zu aktualisieren, können Sie modifizieren Sie den Code wie folgt:

Campaign existingCampaign;

// Obtains existingCampaign from elsewhere.
...

// Creates a new campaign based off the existing campaign and updates the
// campaign by setting its status to paused.
Campaign campaignToUpdate =
    existingCampaign.toBuilder()
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// compare utility to derive the update mask. This mask tells the Google Ads API
// which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaignToUpdate)
        .setUpdateMask(FieldMasks.compare(existingCampaign, campaignToUpdate))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Um eine neue Feldmaske zu erstellen, müssen Sie zuerst eine FieldMask und fügen Sie die Namen der Felder, die Sie ändern möchten, in den -Objekt enthält.

FieldMask fieldMask =
    FieldMask.newBuilder()
        .addPaths("status")
        .addPaths("name")
        .build();

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 die FieldMaskUtil zum Generieren einer Feldmaske, wie oben 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 Im obigen Beispiel wird eine komplett neue Feldmaske erstellt.

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

In diesem Fall wird mithilfe der Methoden allSetFieldsOf() und compare() der FieldMaskUtil erreicht nicht das beabsichtigte Ziel.

Im folgenden Beispiel wird eine Feldmaske generiert, die Folgendes enthält: maximize_conversions Die Google Ads API lässt jedoch nicht zu, dass dieses Verhalten das versehentliche Löschen von Feldern verhindert, FieldMaskError.FIELD_HAS_SUBFIELDS Fehler.

Warnung: Der folgende Code erzeugt einen Fehler.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .setMaximizeConversions(MaximizeConversions.newBuilder().build())
    .build();

// 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 operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Das folgende Beispiel zeigt, wie Sie eine Kampagne ordnungsgemäß für die Verwendung des MaximizeConversions-Gebotsstrategie, ohne eines ihrer untergeordneten Felder festzulegen.

Erfolgreich :Mit dem Code unten wurde die Gebotsstrategie für die Kampagne aktualisiert.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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 fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    // 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
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask)
        .build();

Felder löschen

Einige Felder können explizit gelöscht werden. Ähnlich wie im obigen 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 größer als 0.

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:

Warnung: Dieser Code erzeugt keinen Fehler, aber der 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 campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setMaximizeConversions(
            MaximizeConversions.newBuilder().setTargetCpa(0).build())
        .setStatus(CampaignStatus.PAUSED)
        .build();

// 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 operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Das nächste Beispiel zeigt, wie target_cpa_micros richtig gelöscht wird für die Gebotsstrategie MaximizeConversions.

Erfolgreich: Mit dem folgenden Code wird target_cpa_micros gelöscht.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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 fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask))
        .build();

Beachten Sie, dass das Feld wie im obigen Beispiel für Felder vorgesehen, in der Google Ads API als optional definiert protocol buffers Aber da die target_cpa_micros kein optional-Feld ist, ist das "falsch" wird im Beispiel das nicht Gebotsstrategie ändern, um das Feld target_cpa zu löschen.

Wichtiger Hinweis :Wenn Sie ein Feld bereinigen möchten, ist dies die sicherste Methode, Ziel ist es, das Feld explizit der Feldmaske hinzuzufügen.