Maski terenowe

W interfejsie Google Ads API aktualizacje są wprowadzane przy użyciu maski pola. Maska pola zawiera listę wszystkich pól, które chcesz zmienić w ramach aktualizacji. Wszystkie określone pola, których nie ma w masce pola, będą ignorowane, nawet jeśli zostaną wysłane na serwer.

FieldMaskUtil

Zalecanym sposobem generowania masek pól jest użycie naszego wbudowanego narzędzia maski pól, które umożliwia generowanie masek ze zmodyfikowanego obiektu zamiast kompilowania ich od zera.

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 pusty obiekt Campaign, a następnie ustawiamy jego nazwę zasobu, aby interfejs API wiedział, która kampania jest aktualizowana.

W przykładzie użyto w kampanii metody FieldMasks.allSetFieldsOf(), aby automatycznie utworzyć maskę pola, która zawiera wszystkie ustawione pola. Zwróconą maskę możesz następnie przekazać bezpośrednio do wywołania aktualizacji.

Jeśli chcesz zaktualizować kilka pól za pomocą istniejącego obiektu, 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 następnie dodaj do obiektu nazwę każdego z pól, które chcesz zmienić.

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

aktualizowanie pól wiadomości i ich pól podrzędnych;

Pola MESSAGE mogą zawierać pola podrzędne (np. MaximizeConversions, które zawierają 3 pola: target_cpa_micros, cpc_bid_ceiling_micros i cpc_bid_floor_micros), albo mogą nie mieć żadnych pól podrzędnych (np. ManualCpm).

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

Aktualizując pole MESSAGE, które nie jest zdefiniowane za pomocą żadnych pól podrzędnych, użyj pola FieldMaskUtil, aby wygenerować maskę pola w sposób opisany powyżej.

Pola wiadomości ze zdefiniowanymi polami podrzędnymi

Aktualizując pole MESSAGE, które jest zdefiniowane za pomocą pól podrzędnych, bez ustawiania konkretnych pól podrzędnych w wiadomości, musisz ręcznie dodać do FieldMask wszystkie zmienne pola podrzędne MESSAGE, podobnie jak w przykładzie powyżej, który tworzy maskę pola od podstaw.

Typowym przykładem jest aktualizacja strategii ustalania stawek w kampanii bez ustawiania jakichkolwiek pól w nowej strategii. Z przykładu poniżej dowiesz się, jak zaktualizować kampanię, aby korzystała ze strategii ustalania stawek MaximizeConversions bez ustawiania żadnych pól podrzędnych tej strategii.

W tym przypadku użycie metod allSetFieldsOf() i compare() interfejsu FieldMaskUtil nie pozwala osiągnąć zamierzonego celu.

Poniższy przykład pokazuje maskę pola zawierającą maximize_conversions. Interfejs Google Ads API nie zezwala jednak na takie zachowanie, aby zapobiec przypadkowemu wyczyszczeniu pól i wystąpić błąd FieldMaskError.FIELD_HAS_SUBFIELDS.

// 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 przykładu poniżej dowiesz się, jak prawidłowo zaktualizować kampanię, aby korzystała ze strategii ustalania stawek MaximizeConversions bez ustawiania jej pól podrzędnych.

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

Opróżnianie pól

Niektóre pola można wyczyścić bezpośrednio. Podobnie jak w przykładzie powyżej, musisz dodać te pola do maski pola. Załóżmy na przykład, że masz kampanię, która korzysta ze strategii ustalania stawek MaximizeConversions, a pole target_cpa_micros zawiera wartość większą niż 0.

Uruchomi się następujący kod, 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:

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

W następnym przykładzie pokazujemy, jak prawidłowo wyczyścić pole target_cpa_micros w strategii ustalania stawek MaximizeConversions.

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

Powyższy przykład „nieprawidłowe” działa zgodnie z oczekiwaniami w polach zdefiniowanych jako optional w interfejsie Google Ads API.protocol buffers. Ponieważ jednak target_cpa_micros nie jest polem optional, przykład „nieprawidłowy” nie aktualizuje strategii ustalania stawek, aby wyczyścić pole target_cpa.