Установка пустых объектов сообщений в качестве полей

В API Google Ads некоторые поля сообщений определены как пустые объекты сообщений, например, campaign.manual_cpm , или могут содержать только необязательные поля, которые не нужно задавать, например, campaign.manual_cpc . Настройка этих полей важна для указания API, какую стратегию назначения ставок использовать для данной кампании, но это не всегда интуитивно понятно, если сообщения пустые.

При обновлении поля campaign.name , которое является строкой, мы устанавливаем поле, обновляя его напрямую, как если бы это был обычный атрибут объекта Python:

campaign.name = "Test campaign value"

Поле campaign.manual_cpc является вложенным, то есть оно содержит ещё одно сообщение protobuf, а не примитивный тип, например, строку. Вы также можете обновлять его поля напрямую:

campaign.manual_cpc.enhanced_cpc_enabled = True

Это сообщит API, что в данной кампании используется стратегия назначения ставок manual_cpc с включенной расширенной ценой за клик.

Но что, если вы хотите использовать manual_cpm , который пуст? Или manual_cpc без включения расширенной цены за клик? Для этого вам нужно скопировать отдельный пустой экземпляр класса в кампанию, например:

client = GoogleAdsClient.load_from_storage()

empty_cpm = client.get_type('ManualCpm')
client.copy_from(campaign.manual_cpm, empty_cpm)

Обратите внимание, как manual_cpm указывается для объекта campaign :

name {
  value: "Test campaign value"
}
manual_cpm {
}

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

Наконец, вам нужно вручную добавить это поле в update_mask объекта запроса. Вспомогательный метод маски полей не имеет механизма для определения разницы между полем, явно заданным как пустой объект, и полем, значение которого не задано.

from google.api_core.protobuf_helpers import field_mask

campaign_operation.create = campaign
campaign_operation.update_mask = field_mask(None, campaign)
# Here we manually add the "manual_cpm" field
campaign_operation.update_mask.append("manual_cpm")