Maski terenowe

W interfejsie Google Ads API aktualizacje są wykonywane za pomocą maski pola. Maska pól zawiera listę wszystkich pól, które chcesz zmienić w ramach aktualizacji. Wszelkie określone pola, które nie znajdują się w masce pól, są ignorowane, nawet jeśli są wysyłane do serwera.

Pole maski

Zalecanym sposobem generowania masek jest korzystanie z naszej wbudowanej maski pól, która umożliwia generowanie masek pól ze zmodyfikowanego obiektu, zamiast tworzyć je od podstaw.

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 ustawiamy jego nazwę zasobu, aby interfejs API wiedział dokładnie, którą kampanię aktualizujemy.

W przykładzie zastosowano w kampanii metodę FieldMasks.AllSetFieldsOf automatycznie generującą maskę pola z listą wszystkich ustawionych pól. Zwróconą maskę możesz przekazać bezpośrednio do wywołania aktualizacji.

Czasami może być konieczne zastosowanie istniejącego obiektu i zaktualizowanie kilku pól. W takim przypadku należy zmodyfikować kod w następujący 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ć od podstaw maskę pola, najpierw utwórz obiekt FieldMask, a następnie wstaw tablicę z nazwami wszystkich pól, które chcesz zmienić, a następnie dołącz 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 (takie jak MaximizeConversions, które mają 3 pola: target_cpa_micros, cpc_bid_ceiling_micros i cpc_bid_floor_micros) lub mogą nie zawierać żadnych pól (np. ManualCpm).

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

Podczas aktualizowania pola MESSAGE, które nie jest zdefiniowane w żadnym polu podrzędnym, użyj pola FieldMasks, aby wygenerować maskę pola w sposób opisany powyżej.

Pola wiadomości ze zdefiniowanymi polami podrzędnymi

Podczas aktualizowania pola MESSAGE zdefiniowanego za pomocą pól podrzędnych bez wyraźnego ustawienia któregokolwiek z pól podrzędnych w tej wiadomości, musisz ręcznie dodać każde z pól zmiennych MESSAGE do maski FieldMask utworzonej z podobnej matrycy.

Jednym z częstych przykładów jest zaktualizowanie strategii ustalania stawek bez potrzeby ustawiania pól dla nowej strategii. Przykład poniżej pokazuje, jak zaktualizować kampanię, aby używać strategii ustalania stawek MaximizeConversions bez ustawiania żadnego z pól podrzędnych strategii ustalania stawek.

W tym przypadku korzystanie z metod AllSetFieldsOf() i FromChanges() właściwości FieldMasks nie osiąga założonego celu.

Ten przykład generuje maskę pola zawierającą maximize_conversions. Jednak interfejs Google Ads API nie zezwala na takie działanie, aby zapobiegać przypadkowemu usuwaniu pól i powodować błąd FieldMaskError.FIELD_HAS_SUBFIELDS.

Ostrzeżenie: ten kod powoduje wyświetlenie błędu.

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

Poniższy przykład pokazuje, jak prawidłowo zaktualizować kampanię, tak aby używała strategii ustalania stawek MaximizeConversions bez ustawiania jej pól podrzędnych.

Sukces: ten kod 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
};

Czyszczenie pól

Niektóre pola można usunąć. Podobnie jak w przykładzie powyżej, należy 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 ma wartość większą niż 0.

Uruchamiany jest ten kod, ale maximize_conversions.target_cpa_micros nie jest dodawany do maski pola i dlatego nie wprowadza żadnych zmian w polu target_cpa_micros:

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

// 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.

Udało się: ten kod pozwala wyczyś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
};

Należy pamiętać, że powyższy przykład „nieprawidłowy” działa prawidłowo w przypadku pól zdefiniowanych w interfejsie Google Ads API jako optional protocol buffers. Ponieważ jednak pole target_cpa_micros nie jest polem optional, przykład „nieprawidłowego” nie aktualizuje strategii ustalania stawek do pola target_cpa.

Ważne: jeśli chcesz wyczyścić pole, najprostszym sposobem, aby to osiągnąć, jest bezpośrednie dodanie tego pola do maski pola.