Feldmasken

<ph type="x-smartling-placeholder">

</ph> Warnung:Ab Version 19.0.0 wird die Google Ads API-Clientbibliothek für .NET unterstützt .NET 5.0 nicht mehr. Um einen reibungslosen Betrieb zu gewährleisten, .NET-Version vor Ende 2024 aktualisieren.

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:

// Update campaign by setting its status to paused, and "Search network" to false.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    NetworkSettings = new NetworkSettings()
    {
        TargetSearchNetwork = false
    }
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

Zuerst erstellen wir ein leeres Campaign-Objekt. Dann legen wir den Ressourcennamen so fest, damit die API genau weiß, welche Kampagne aktualisiert wird.

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

Manchmal müssen Sie mit einem vorhandenen Objekt arbeiten und einige Felder aktualisieren. In solchen Fällen ändern Sie den Code wie folgt:

Campaign existingCampaign;

// Obtain existingCampaign from elsewhere.
...

// Create a new campaign based off the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);

// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
    TargetSearchNetwork = false
}

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};

Um eine neue Feldmaske zu erstellen, müssen Sie zuerst eine FieldMask und erstellen Sie dann ein Array, das die Namen aller Felder enthält, und schließlich den Array-Inhalt an das Feld Path der Feldmaske anhängen.

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "status", "name" });

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 FieldMasks 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 FromChanges() des Mit FieldMasks wird das vorgesehene Ziel nicht erreicht.

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 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = 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 operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { 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 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

// Creates a field mask from the existing campaign and adds all of the fields
// on the MaximizeConversions bidding strategy to the field mask. Because these
// fields are 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 with none of its subfields set.
FieldMask 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.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

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 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// 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 = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { 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 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(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 fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

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.