Полевые маски

В API Google Ads используется маска поля , которая указывает список полей, которые должен обновить запрос к 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
};

Чистые поля

API Google Ads поддерживает очистку значений некоторых полей. Чтобы очистить поле, необходимо вручную включить это поле в маску поля, оставив поле незаданным в объекте ресурса. Установка значения поля по умолчанию (например, 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 });