Обновления с использованием масок полей

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

Помощник по маске поля

Рекомендуемый способ создания масок полей — использование вспомогательной функции field_mask , включенной в пакет google.api_core . Он принимает два объекта protobuf и возвращает объект маски поля с полем list , содержащим все поля, которые различаются между двумя объектами.

Если None передано в качестве первого параметра, то список масок полей будет содержать только все поля второго объекта protobuf, для которых не установлено значение по умолчанию.

После создания объект маски поля должен быть скопирован в объект операции, который будет отправлен на сервер:

Вот пример обновления кампании:

from google.api_core import protobuf_helpers
from google.ads.googleads.client import GoogleAdsClient

# Retrieve a GoogleAdsClient instance.
client = GoogleAdsClient.load_from_storage()
# Create a new campaign operation.
campaign_operation = client.get_type('CampaignOperation')
# Retrieve a new campaign object from its update field.
campaign = campaign_operation.update
# Mutate the campaign.
campaign.network_settings.target_search_network.value = False

# Create a field mask using the updated campaign.
# The field_mask helper is only compatible with raw protobuf message
# instances, which we can access using the ._pb attribute.
field_mask = protobuf_helpers.field_mask(None, campaign._pb)

# Copy the field_mask onto the operation's update_mask field.
client.copy_from(campaign_operation.update_mask, field_mask)

Сначала мы создаем пустой объект CampaignOperation. Затем мы устанавливаем из него получение пустого объекта Campaign. Затем мы обновляем этот объект кампании и создаем новую маску поля, сравнивая ее с None , что создаст список масок полей, содержащий только измененное поле network_settings.target_search_network .

Ниже приведен пример обновления существующей кампании. Здесь мы предполагаем, что скрипту предоставлен параметр resource_name , который является допустимым именем ресурса для кампании и действительным customer_id :

import proto

from google.api_core import protobuf_helpers
from google.ads.googleads.client import GoogleAdsClient

# Retrieve a GoogleAdsClient instance.
client = GoogleAdsClient.load_from_storage()
# Retrieve an instance of the GoogleAdsService.
googleads_service = client.get_service('GoogleAdsService')

# Search query to retrieve campaign.
query = f"""
    SELECT
      campaign.network_settings.target_search_network,
      campaign.resource_name
    FROM campaign
    WHERE campaign.resource_name = {resource_name}"""

# Submit a query to retrieve a campaign instance.
response = googleads_service.search_stream(customer_id=customer_id, query=query)

# Iterate over results to retrieve the campaign.
for batch in response:
    for row in batch.results:
        initial_campaign = row.campaign

# Create a new campaign operation.
campaign_operation = client.get_type('CampaignOperation')
# Set the copied campaign object to a variable for easy reference.
updated_campaign = campaign_operation.update
# Copy the retrieved campaign into the new campaign.
# Here we use the proto.Message.copy_from method because of its simple
# compatibility with the protobuf message instances, which are wrapped
# by the proto-plus library.
proto.Message.copy_from(updated_campaign, initial_campaign)
# Mutate the new campaign.
updated_campaign.network_settings.target_search_network = False

# Create a field mask using the updated campaign.
field_mask = protobuf_helpers.field_mask(
    initial_campaign._pb, updated_campaign._pb
)

# Copy the field mask onto the operation's update_mask field.
# Note that the client's copy_from  method is designed to work with both native
# messages and messages wrapped by proto-plus, so it works here for the
# update_mask, even though it's an instance of the native message class
# google.protobuf.field_mask_pb2.FieldMask.
client.copy_from(campaign_operation.update_mask, field_mask)

При использовании этой стратегии updated_campaign будет использовать все те же поля, что и initial_campaign , полученная из API, а именно имя ресурса. Сгенерированная маска поля сообщит API, что необходимо изменить только поле network_settings.target_search_network .