Маски полей

В Google Ads API маска поля используется для предоставления списка полей, которые должен обновить запрос к API. Любое поле, не указанное в маске, игнорируется, даже если оно отправлено на сервер.

Класс FieldMasks

Рекомендуемый способ создания масок полей в клиентской библиотеке .NET – использовать встроенный класс утилит FieldMasks, который позволяет создавать маски полей из измененного объекта, а не с нуля.

Ниже приведен пример обновления кампании, в котором используется метод FieldMasks.AllSetFieldsOf для создания маски поля, перечисляющей все заданные поля. Затем вы можете передать сгенерированную маску поля непосредственно в вызов обновления:

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

Иногда вам может потребоваться поработать с существующим объектом и обновить несколько полей. В таких случаях используйте метод FieldMasks.FromChanges. Этот метод генерирует маску поля, которая представляет разницу между двумя объектами:

Campaign existingCampaign;

// Obtain existingCampaign from an earlier API call.

// Create a new campaign based on 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)
};

Как устранять ошибки 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()
};

CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

Вызов API завершается ошибкой FieldMaskError.FIELD_HAS_SUBFIELDS. Поскольку у MaximizeConversions есть подполя, сервер Google Ads API ожидает, что в запросе будут присутствовать маски полей для изменяемых подполей. Однако в этом случае FieldMasks не может автоматически сгенерировать маски вложенных полей, поскольку в запросе не заданы вложенные поля.

В таких случаях вы можете вручную добавить пути к fieldMask.Paths (это RepeatedField<string>):

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

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 at:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
fieldMask.Paths.Add("maximize_conversions.target_cpa_micros");

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

Очистить поля

Google Ads API поддерживает очистку значений некоторых полей. Чтобы очистить поле, необходимо вручную включить его в маску поля, оставив поле неустановленным в объекте ресурса. Если задать для поля значение по умолчанию (например, 0 для поля int64), оно не будет очищено.

В примере кода ниже показано, как очистить поле target_cpa_micros стратегии назначения ставок MaximizeConversions.

Правильный код

В следующем коде поле target_cpa_micros очищается, поскольку в маску поля добавляется maximize_conversions.target_cpa_micros без настройки свойства campaign.MaximizeConversions.TargetCpaMicros:

// 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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
FieldMask fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.Add("maximize_conversions.target_cpa_micros");

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

Неверный код

Следующий код не очищает поле target_cpa_micros, поскольку задает для него значение 0. И утилита FieldMasks, и сервер Google Ads API игнорируют это значение, если TargetCpaMicros имеет значение 0 или если путь опущен в маске, и сервер не возвращает ошибку:

// Creates a campaign with the proper resource name and a
// MaximizeConversions object. Attempts to clear the target_cpa_micros
// field by setting it to 0.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// Constructs an operation using FieldMasks.AllSetFieldsOf to derive the
// update mask.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

// Sends the operation in a mutate request that succeeds without clearing
// the previous 'target_cpa_micros' value cleanly.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });