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.

Dienstprogramm „FieldMasks“

Die empfohlene Methode zum Generieren von Feldmasken ist die Verwendung unserer integrierten Feldmaske Dienstprogramm (FieldMasks), 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:

my $campaign = Google::Ads::GoogleAds::V17::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
    status => PAUSED,
    networkSettings =>
      Google::Ads::GoogleAds::V17::Resources::NetworkSettings->new({
        targetSearchNetwork => "false"
      })
    });

my $campaign_operation =
  Google::Ads::GoogleAds::V17::Services::CampaignService::CampaignOperation->new({
    update     => $campaign,
    updateMask => all_set_fields_of($campaign)
  });

In diesem Beispiel wird zuerst ein Campaign-Objekt erstellt, indem dessen Ressourcenname festgelegt wird mit dem Dienstprogramm ResourceNames, damit die API weiß, welche Kampagne aktualisiert wird.

In diesem Beispiel wird das FieldMasks::all_set_fields_of() für die Kampagne, um automatisch eine Feldmaske zu erstellen, die alle festlegen. Anschließend können Sie die zurückgegebene Maske direkt an den Aktualisierungsaufruf übergeben.

FieldMasks::all_set_fields_of() ist eine bequeme Methode für FieldMasks::field_mask() Es vergleicht das übergebene Objekt mit einem leeren Objekt derselben Klasse. In der Code oben eingeben, können Sie auch

field_mask(Google::Ads::GoogleAds::V17::Resources::Campaign->new({}), $campaign)

statt all_set_fields_of($campaign).

Maske manuell erstellen

Um eine neue Feldmaske zu erstellen, müssen Sie zuerst eine Google::Ads::GoogleAds::Common::FieldMask und erstellen Sie dann einen Array-Verweis, der mit den Namen aller Felder gefüllt ist. die Sie ändern möchten. Weisen Sie schließlich den Arrayverweis der paths.

my $field_mask = Google::Ads::GoogleAds::Common::FieldMask->new({
    paths => ["status", "name"]
  });

Objektfelder und ihre Unterfelder aktualisieren

Objektfelder können Unterfelder enthalten (z. B. MaximizeConversions mit drei: target_cpa_micros, cpc_bid_ceiling_micros und cpc_bid_floor_micros); oder Sie dürfen auch keine haben (z. B. ManualCpm).

Objektfelder ohne definierte Unterfelder

Ein Objektfeld in Perl entspricht der protobuf-MESSAGE im Client auf gRPC ausgeführte Bibliotheken. Beim Aktualisieren eines nicht definierten Objektfelds mit beliebigen Unterfeldern hinzufügen, verwenden Sie das Dienstprogramm "FieldMasks", um eine Feldmaske wie beschrieben.

Objektfelder mit definierten Unterfeldern

Beim Aktualisieren eines Objektfelds, das mit Unterfeldern ohne explizit oder eines der untergeordneten Felder der Nachricht festgelegt haben, müssen Sie jedes der mutable-Objekt-Unterfelder in FieldMask, ähnlich wie im obigen Beispiel. mit der eine komplett neue Feldmaske erstellt wird.

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 all_set_fields_of() und field_mask() der Das Dienstprogramm FieldMasks erreicht nicht das vorgesehene Ziel.

Im folgenden Beispiel wird eine Feldmaske generiert, die Folgendes enthält: maximize_conversions Die Google Ads API unterstützt dies jedoch nicht. um zu verhindern, dass Felder versehentlich gelöscht werden. 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.
my $campaign = Google::Ads::GoogleAds::V17::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
    maximizeConversions =>
      Google::Ads::GoogleAds::V17::Resources::MaximizeConversions->new()
    });

# Constructs an operation, using the FieldMasks' all_set_fields_of utility to
# derive the update mask. The field mask will include 'maximize_conversions',
# which will produce a FieldMaskError.FIELD_HAS_SUBFIELDS error.
my $campaign_operation =
  Google::Ads::GoogleAds::V17::Services::CampaignService::CampaignOperation->new({
    update     => $campaign,
    updateMask => all_set_fields_of($campaign)
  });

# Sends the operation in a mutate request that will result in a
# FieldMaskError.FIELD_HAS_SUBFIELDS error because empty object fields cannot
# be included in a field mask.
my $response = $api_client->CampaignService()->mutate({
    customerId => $customer_id,
    operations => [$campaign_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 with the proper resource name.
my $campaign = Google::Ads::GoogleAds::V17::Resources::Campaign->new({
    resourceName => Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
      $customer_id, $campaign_id
    )
  });

# 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.
# 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
my $field_mask = all_set_fields_of($campaign);
push @{$field_mask->{paths}}, "maximize_conversions.target_cpa_micros";

# Creates an operation to update the campaign with the specified fields.
my $campaign_operation =
  Google::Ads::GoogleAds::V17::Services::CampaignService::CampaignOperation->new({
    update     => $campaign,
    updateMask => $field_mask
  });

Felder löschen

Felder können explizit gelöscht werden, indem sie wie gezeigt zur Feldmaske hinzugefügt werden. oder indem Sie das Feld auf einen leeren oder nicht definierten Wert setzen. Beispiel: Angenommen, Sie haben eine Kampagne mit der Gebotsstrategie „MaximizeConversions“ und für das Feld target_cpa_micros ein Wert größer als 0

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

# Creates a campaign with the proper resource name and a MaximizeConversions
# object with target_cpa_micros set to 0.
my $campaign =
  Google::Ads::GoogleAds::V17::Resources::Campaign->new({
    resourceName => Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
      $customer_id, $campaign_id
    ),
    maximizeConversions => Google::Ads::GoogleAds::V17::Resources::MaximizeConversions->new({
      targetCpaMicros => 0
    })
  });

# Constructs an operation, using the FieldMasks' all_set_fields_of utility to
# derive the update mask, which will include 'maximize_conversions.target_cpa_micros'.
my $campaign_operation =
  Google::Ads::GoogleAds::V17::Services::CampaignService::CampaignOperation->new({
    update     => $campaign,
    updateMask => all_set_fields_of($campaign)
  });

Beachten Sie, dass Felder mit verschachtelten Unterfeldern nur durch Löschen der folgenden den einzelnen Unterfeldern, wie in Objektfeldern mit definierten untergeordneten Felder.