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

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

  • По-настоящему пустые сообщения: например, campaign.manual_cpm не имеет определенных подполей.
  • Сообщения с необязательными полями: например, campaign.manual_cpc имеет необязательное подполе enhanced_cpc_enabled .

Чтобы обновить примитивное поле, такое как 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 . Помощник по маске поля не может автоматически определить, что пустое сообщение было явно задано.
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. Manually add "manual_cpm" to the update_mask.
from google.api_core.protobuf_helpers import field_mask
campaign_operation = client.get_type('CampaignOperation')
campaign_operation.update = campaign
campaign_operation.update_mask = field_mask(None, 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 .
  2. Вручную добавьте путь к каждому изменяемому подполю ManualCpc в update_mask объекта CampaignOperation . В этом случае соответствующим подполем будет enhanced_cpc_enabled .
client = GoogleAdsClient.load_from_storage()
# Assume 'campaign' is an existing Campaign object you are updating.

# 1. Instantiate and assign an empty ManualCpc
campaign.manual_cpc = client.get_type('ManualCpc')

# 2. Manually add the subfield path to the update_mask.
from google.api_core.protobuf_helpers import field_mask
campaign_operation = client.get_type('CampaignOperation')
campaign_operation.update = campaign
campaign_operation.update_mask = field_mask(None, 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.

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