Maski terenowe

W interfejsie Google Ads API aktualizacje są przeprowadzane za pomocą maski pola. Maska pola zawiera listę wszystkie pola, które chcesz zmienić w ramach aktualizacji, oraz wszystkie określone pola, nieuwzględnione w masce pola zostaną zignorowane, nawet jeśli zostaną wysłane na serwer.

FieldMaskUtil

Zalecanym sposobem generowania masek pól jest użycie naszej wbudowanej maski pola które umożliwia generowanie masek pól na podstawie zmodyfikowanego obiektu zamiast i tworzą je od podstaw.

Oto przykład aktualizowania 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 nazwę jego zasobu w taki sposób, że interfejs API będzie dokładnie wiedzieć, którą kampanię aktualizujemy.

W przykładzie użyto w kampanii metody FieldMasks.AllSetFieldsOf. automatycznie tworzy maskę pola wyliczającą wszystkie ustawione pola. Następnie możesz: przekazać zwróconą maskę bezpośrednio do wywołania aktualizacji.

Czasami może być konieczne popracowanie z istniejącym obiektem i zaktualizowanie kilku pól. W takich przypadkach możesz 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 FieldMask obiektu, a następnie utwórz tablicę z nazwami wszystkich pól, których aby ją zmienić, i na koniec 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 (takie jak MaximizeConversions, która ma 3 elementy: target_cpa_micros, cpc_bid_ceiling_micros i cpc_bid_floor_micros) albo nie mogą mieć żadnego w ogóle (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 FieldMasks, aby wygenerować maskę pola, jak opisano powyżej.

Pola wiadomości ze zdefiniowanymi polami podrzędnymi

Podczas aktualizowania pola MESSAGE zdefiniowanego za pomocą pól podrzędnych bez przez ustawienie dowolnego z pól podrzędnych tej wiadomości, musisz ręcznie dodaj każde z zmiennych pól podrzędnych MESSAGE do FieldMask, podobnie jak przykładu powyżej, który tworzy od zera maskę pola.

Typowy przykład to aktualizacja strategii ustalania stawek w kampanii bez ustawiania w nowej strategii określania stawek. Poniższy przykład pokazuje, jak zaktualizować kampanię, tak aby korzystała z Strategia ustalania stawek: MaximizeConversions bez konfigurowania żadnych pól podrzędnych strategii ustalania stawek.

W tym przypadku za pomocą metod AllSetFieldsOf() i FromChanges() FieldMasks nie osiąga zamierzonego celu.

Ten przykład generuje maskę pola zawierającą maximize_conversions Interfejs Google Ads API nie pozwala jednak na takie zachowanie zapobiega przypadkowemu czyszczeniu pól i generuje FieldMaskError.FIELD_HAS_SUBFIELDS .

// 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ę, aby korzystała z MaximizeConversions strategia ustalania stawek bez ustawienia żadnego z pól podrzędnych.

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

Oczyszczanie pól

Niektóre pola można wyczyścić bezpośrednio. Podobnie jak w przykładzie powyżej, musisz bezpośrednio dodaj te pola do maski pola. Załóżmy na przykład, że masz kampania wykorzystująca MaximizeConversions strategię ustalania stawek. W polu target_cpa_micros ustawiono wartość większą niż 0.

Uruchomi się następujący kod: jednak maximize_conversions.target_cpa_micros nie zostaną dodane do maski pola, więc żadne zmiany nie zostaną wprowadzone w Pole target_cpa_micros:

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

Następny przykład pokazuje, jak poprawnie wyczyścić target_cpa_micros w strategii ustalania stawek MaximizeConversions.

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

Pamiętaj, że "nieprawidłowe" z powyższego przykładu działa poprawnie w przypadku pól, są zdefiniowane w interfejsie Google Ads API jako optional protocol buffers Ponieważ jednak target_cpa_micros nie jest polem optional, wyrażenie „nieprawidłowe” przykład nie aktualizuje strategię ustalania stawek, aby wyczyścić pole target_cpa.