Feldmasken

In der Google Ads API erfolgen Aktualisierungen mithilfe einer Feldmaske. Die Feldmaske listet alle Felder auf, 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.

FieldMaskUtil

Die empfohlene Methode zum Generieren von Feldmasken ist unser integriertes Dienstprogramm für Feldmasken. Damit können Sie Feldmasken aus einem geänderten Objekt generieren, anstatt sie von Grund auf neu zu 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. Anschließend wird der Ressourcenname festgelegt, damit die API weiß, welche Kampagne aktualisiert wird.

Im Beispiel wird die Methode FieldMasks.allSetFieldsOf() für die Kampagne verwendet, um automatisch eine Feldmaske zu erstellen, die alle festgelegten Felder aufzählt. Anschließend können Sie die zurückgegebene Maske direkt an den Aktualisierungsaufruf übergeben.

Wenn Sie mit einem vorhandenen Objekt arbeiten müssen, um einige Felder zu aktualisieren, können Sie den Code so ändern:

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 ein FieldMask-Objekt erstellen. Fügen Sie dann die Namen der Felder hinzu, die Sie in das Objekt ändern möchten.

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

Nachrichtenfelder und ihre Unterfelder aktualisieren

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

Nachrichtenfelder ohne definierte Unterfelder

Wenn Sie ein MESSAGE-Feld aktualisieren, das nicht mit Unterfeldern definiert ist, generieren Sie mit „FieldMaskUtil“ wie oben beschrieben eine Feldmaske.

Nachrichtenfelder mit definierten untergeordneten Feldern

Wenn Sie ein MESSAGE-Feld aktualisieren, das mit Unterfeldern definiert ist, ohne eines der Unterfelder für diese Nachricht explizit festzulegen, müssen Sie jedes änderbare MESSAGE-Unterfeld manuell zu FieldMask hinzufügen, ähnlich wie im obigen Beispiel, bei dem eine neue Feldmaske erstellt wird.

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

In diesem Fall wird mit den Methoden allSetFieldsOf() und compare() von FieldMaskUtil das beabsichtigte Ziel nicht erreicht.

Im folgenden Beispiel wird eine Feldmaske generiert, die maximize_conversions enthält. Die Google Ads API lässt dies jedoch nicht zu. Damit wird verhindert, dass Felder versehentlich gelöscht werden und der Fehler FieldMaskError.FIELD_HAS_SUBFIELDS ausgegeben wird.

Warnung: Der folgende Code führt zu einem 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 eine Kampagne ordnungsgemäß für die Verwendung der Gebotsstrategie MaximizeConversions aktualisiert wird, ohne eines ihrer Unterfelder festzulegen.

Erfolgreich :Die Gebotsstrategie für die Kampagne wurde mit dem folgenden Code 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 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 ist ein Wert größer als 0 festgelegt.

Der folgende Code wird ausgeführt. Allerdings wird maximize_conversions.target_cpa_micros der Feldmaske nicht hinzugefügt, sodass keine Änderungen am Feld target_cpa_micros vorgenommen werden:

Warnung :Dieser Code löst keinen Fehler aus, aber die target_cpa_micros der MaximizeConversions-Gebotsstrategie 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));

Im nächsten Beispiel wird gezeigt, wie Sie das Feld target_cpa_micros in der Gebotsstrategie MaximizeConversions richtig löschen.

Erfolgreich: Mit dem folgenden Code wird die 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();

Das „falsche“ Beispiel oben funktioniert wie vorgesehen für Felder, die in der Google Ads API protocol buffers als optional definiert sind. Da das target_cpa_micros-Feld jedoch kein optional-Feld ist, wird im „falschen“ Beispiel die Gebotsstrategie nicht aktualisiert, um das Feld target_cpa zu löschen.

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