Как задать пустые объекты сообщений в качестве полей

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

  • Сообщения без полей, например campaign.manual_cpm, не имеют определенных вложенных полей.
  • Сообщения с необязательными полями. Например, в сообщении campaign.manual_cpc есть необязательное вложенное поле enhanced_cpc_enabled.

Обратите внимание, что поля стратегии назначения ставок в Campaign относятся к группе bidding_strategy oneof. Если вы зададите новую стратегию назначения ставок, например manual_cpm или manual_cpc, то все ранее настроенные стратегии назначения ставок в группе oneof будут удалены.

Чтобы обновить простое поле, например campaign.name, задайте его напрямую:

campaign.name = "Test campaign value"

Чтобы обновить вложенное сообщение с настраиваемыми вложенными полями, например campaign.manual_cpc, при включении Оптимизатора цены за конверсию, задайте его следующим образом:

campaign.manual_cpc.enhanced_cpc_enabled = True

Как задать пустые сообщения

Чтобы использовать стратегию назначения ставок, например manual_cpm, которая представляет собой пустое сообщение, выполните следующие действия:

  1. Получить пустой экземпляр типа сообщения (ManualCpm).
  2. Используйте client.copy_from, чтобы назначить этот пустой экземпляр полю кампании.
  3. Вручную добавьте название поля (manual_cpm) в элемент update_mask на странице CampaignOperation. Помощник по маске поля не может автоматически определить, что пустое сообщение было задано явно.
from google.ads.googleads import util
from google.ads.googleads.client import GoogleAdsClient
from google.api_core.protobuf_helpers import field_mask

client = GoogleAdsClient.load_from_storage()
# Assume 'campaign' is an existing Campaign object you are updating.

# 1. Get an empty ManualCpm type.
empty_cpm = client.get_type("ManualCpm")

# 2. Copy it to the campaign's manual_cpm field.
client.copy_from(campaign.manual_cpm, empty_cpm)

# 3. Create the operation and manually add "manual_cpm" to the update_mask.
campaign_operation = client.get_type("CampaignOperation")
client.copy_from(campaign_operation.update, campaign)
client.copy_from(
    campaign_operation.update_mask,
    field_mask(None, util.convert_proto_plus_to_protobuf(campaign)),
)
campaign_operation.update_mask.paths.append("manual_cpm")

# The resulting proto sent to the API will include:
# manual_cpm {
# }

Как задавать сообщения с необязательными вложенными полями

Чтобы использовать manual_cpc в качестве стратегии назначения ставок, не включая enhanced_cpc_enabled, можно попробовать подход, аналогичный ManualCpm. Однако, поскольку у поля ManualCpc есть вложенные поля, добавление manual_cpc в поле update_mask приводит к ошибке FieldMaskError.FIELD_HAS_SUBFIELDS. Если в маске есть вложенные поля, API требует большей точности.

Чтобы правильно задать значение campaign.manual_cpc и при этом не задавать значение enhanced_cpc_enabled:

  1. Создайте пустой объект ManualCpc и скопируйте его в campaign.manual_cpc с помощью client.copy_from.
  2. Вручную добавьте путь к каждому изменяемому вложенному полю ManualCpc в update_mask на странице CampaignOperation. В этом случае нужным вложенным полем будет enhanced_cpc_enabled.
from google.ads.googleads import util
from google.ads.googleads.client import GoogleAdsClient
from google.api_core.protobuf_helpers import field_mask

client = GoogleAdsClient.load_from_storage()
# Assume 'campaign' is an existing Campaign object you are updating.

# 1. Copy an empty ManualCpc object into campaign.manual_cpc.
client.copy_from(campaign.manual_cpc, client.get_type("ManualCpc"))

# 2. Manually add the subfield path to the update_mask.
campaign_operation = client.get_type("CampaignOperation")
client.copy_from(campaign_operation.update, campaign)
client.copy_from(
    campaign_operation.update_mask,
    field_mask(None, util.convert_proto_plus_to_protobuf(campaign)),
)

# For ManualCpc, because it has subfields, you must specify the subfield
# path in the update_mask. This tells the API you are updating something
# within manual_cpc. By not setting enhanced_cpc_enabled on the campaign
# object, it defaults to false.
campaign_operation.update_mask.paths.append("manual_cpc.enhanced_cpc_enabled")

# The update_mask paths will include: ['manual_cpc.enhanced_cpc_enabled']
# This correctly signals to the API that ManualCpc is the chosen strategy,
# with enhanced_cpc_enabled in its default state.

При отправке запросов с использованием этих шаблонов вы можете проверить полезную нагрузку, включив регистрацию и изучив запрос.