Maski terenowe

W interfejsie Google Ads API aktualizacje są przeprowadzane za pomocą maski pola. Maska pól zawiera listę wszystkich pól, które chcesz zmienić w ramach aktualizacji. Wszystkie pola, które nie znajdują się w masce, zostaną zignorowane, nawet jeśli zostaną wysłane na serwer.

FieldMaskUtil

Zalecane jest generowanie masek pól za pomocą wbudowanego narzędzia, które umożliwia generowanie masek pól na podstawie zmodyfikowanego obiektu zamiast tworzenia ich od podstaw.

Oto przykład aktualizacji kampanii:

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

W tym przykładzie najpierw tworzymy puste wystąpienie obiektu Campaign, a potem ustawiamy jego nazwę zasobu, aby interfejs API wiedział, która kampania jest aktualizowana.

W przykładzie użyto metody FieldMasks.allSetFieldsOf() w kampanii, aby automatycznie wygenerować maskę pola, która wylicza wszystkie zdefiniowane pola. Następnie możesz przekazać zwróconą maskę bezpośrednio do wywołania update.

Jeśli chcesz zaktualizować kilka pól w istniejącym obiekcie, możesz zmodyfikować kod w ten sposób:

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

Aby utworzyć maskę pola od podstaw, najpierw utwórz obiekt FieldMask, a potem dodaj do niego nazwy wszystkich pól, które chcesz zmienić.

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

Aktualizowanie pól wiadomości i ich podpól

Pola MESSAGE mogą mieć pola podrzędne (np. MaximizeConversions, które ma 3 pola: target_cpa_micros, cpc_bid_ceiling_micros i cpc_bid_floor_micros), lub nie mieć ich wcale (np. ManualCpm).

Pola wiadomości bez zdefiniowanych pól podrzędnych

Podczas aktualizowania pola MESSAGE, które nie jest zdefiniowane za pomocą żadnych pól podrzędnych, użyj FieldMaskUtil, aby wygenerować maskę pola zgodnie z opisem powyżej.

Pola wiadomości z zdefiniowanymi podpolami

Podczas aktualizowania pola MESSAGE zdefiniowanego za pomocą podpol, które nie mają wyraźnie ustawionych podpol, musisz ręcznie dodać do pola FieldMask wszystkie zmienialne podpola MESSAGE, podobnie jak w przykładzie powyżej, w którym maska pola jest tworzona od podstaw.

Typowym przykładem jest aktualizacja strategii ustalania stawek w kampanii bez ustawiania żadnych pól w nowej strategii ustalania stawek. Przykład poniżej pokazuje, jak zaktualizować kampanię, aby używała strategii ustalania stawek MaximizeConversions bez ustawiania żadnych podpól strategii ustalania stawek.

W tym przypadku użycie metod allSetFieldsOf() i compare() klasy FieldMaskUtil nie osiąga zamierzonego celu.

W tym przykładzie maska pola zawiera maximize_conversions. Interfejs Google Ads API nie zezwala jednak na takie działanie, aby zapobiec przypadkowemu wyczyszczeniu pól, i wywołuje błądFieldMaskError.FIELD_HAS_SUBFIELDS.

Ostrzeżenie: ten kod powoduje błąd.

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

Z poniższego przykładu dowiesz się, jak prawidłowo zaktualizować kampanię, aby używała strategii ustalania stawek MaximizeConversions bez ustawiania żadnych jej podpól.

Sukces: kod poniżej zaktualizuje strategię ustalania stawek w kampanii.

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

Czyszczenie pól

Niektóre pola można wyczyścić. Podobnie jak w przypadku przykładu powyżej musisz wyraźnie dodać te pola do maski. Załóżmy np., że masz kampanię, która korzysta ze strategii ustalania stawek MaximizeConversions, a pole target_cpa_micros ma ustawioną wartość większą niż 0.

Ten kod jest wykonywany, ale pole maximize_conversions.target_cpa_micros nie zostanie dodane do maski pola, więc w polu target_cpa_micros nie zostaną wprowadzone żadne zmiany:

Ostrzeżenie: ten kod nie powoduje błędu, ale target_cpa_micros strategii ustalania stawek MaximizeConversions nie zostanie wyczyszczona.

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

Następujący przykład pokazuje, jak prawidłowo wyczyścić pole target_cpa_micros w strategii ustalania stawek MaximizeConversions.

Wynik: kod poniżej czyści zmienną target_cpa_micros.

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

Pamiętaj, że przykład „nieprawidłowy” powyżej działa zgodnie z oczekiwaniami w przypadku pól zdefiniowanych jako optional w interfejsie Google Ads APIprotocol buffers. Ponieważ jednak pole target_cpa_micros nie jest polem optional, w przykładzie „nieprawidłowym” nie nie zmienia się strategii ustalania stawek, aby usunąć pole target_cpa.

Ważna informacja: jeśli chcesz wyczyścić pole, najbezpieczniejszym sposobem na to jest dodanie tego pola do maski pola.