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

В 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.

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