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

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

Класс FieldMaskUtil

Рекомендуемый способ генерации масок полей — использование встроенного класса FieldMaskUtil , который позволяет генерировать маски полей из модифицированного объекта, а не создавать их с нуля.

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

Как обрабатывать ошибки 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 ожидает, что в запросе будут присутствовать маски полей для этих полей. Однако FieldMaskUtil не может корректно сгенерировать маски полей в этой ситуации, поскольку запрос не задает эти поля.

В таких случаях вы можете вручную отредактировать маску поля следующим образом:

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

Как очистить поля

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

Неверный код

Приведенный ниже код не очищает поле target_cpa_micros , поскольку мы устанавливаем для него значение ноль. И FieldMaskUtils , и сервер Google Ads API проигнорируют это значение. Кроме того, в этом случае вы можете не получить ошибку, поскольку значение было проигнорировано сервером.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object. Attempt 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 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 });