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:

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

Najpierw tworzymy pusty obiekt Campaign. Następnie ustawimy nazwę zasobu, aby interfejs API wiedział, którą kampanię aktualizujemy.

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

Czasami musisz pracować z istniejącym obiektem i zaktualizować kilka pól. W takim przypadku zmodyfikuj kod w taki sposób:

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

Aby utworzyć maskę pola od zera, trzeba najpierw utworzyć obiekt FieldMask, a następnie utworzyć tablicę zawierającą nazwy wszystkich pól, które chcesz zmienić, i dołączyć zawartość tablicy do pola Path maski pola.

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

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

Podczas aktualizowania pola MESSAGE, które nie jest zdefiniowane za pomocą żadnych pól podrzędnych, użyj wartości FieldMasks do wygenerowania maski 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 FromChanges() w metodzie FieldMasks 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.

Ostrzeżenie: poniższy kod powoduje błąd.

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

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.

Udało się: poniższy kod skutecznie aktualizuje strategię ustalania stawek w kampanii.

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

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:

Ostrzeżenie: ten kod nie powoduje błędu, ale target_cpa_micros strategia 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 = 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 });

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

Powodzenie: poniższy kod czyści target_cpa_micros.

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

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.

Ważne: jeśli chcesz wyczyścić pole, najbezpieczniejszym sposobem na osiągnięcie tego celu jest wyraźne dodanie tego pola do maski pola.