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

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

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

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

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

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

Обновление с помощью нового локального объекта

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

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

# 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 and set its resource
# name.
campaign = campaign_operation.update
campaign.resource_name = client.get_service("CampaignService").campaign_path(
    customer_id, campaign_id
)

# Mutate the campaign (use direct attribute assignment in proto-plus).
campaign.network_settings.target_search_network = False

# Create a field mask using the updated campaign.
# The field_mask helper is compatible with raw protobuf message instances,
# which you 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)

Как изменить существующий ресурс

В приведенном ниже примере обновляется существующая кампания, полученная из API, при условии, что resource_name и customer_id действительны. При использовании этой стратегии updated_campaign передает все поля, полученные в initial_campaign (включая его resource_name), а сгенерированная маска поля сообщает API, что изменилось только поле network_settings.target_search_network:

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

# 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 the campaign. Quote string literals in GAQL.
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.
initial_campaign = None
for batch in response:
    for row in batch.results:
        initial_campaign = row.campaign
        break

if not initial_campaign:
    raise ValueError(f"Campaign '{resource_name}' not found.")

# 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.
# client.copy_from works with both native protobuf messages and messages
# wrapped by the proto-plus library.
client.copy_from(updated_campaign, initial_campaign)

# Mutate the new campaign.
updated_campaign.network_settings.target_search_network = False

# Create a field mask by comparing initial and updated protobuf objects.
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 works with both native messages
# and messages wrapped by proto-plus, including google.protobuf.field_mask_pb2.
client.copy_from(campaign_operation.update_mask, field_mask)

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

При сравнении с None вспомогательная функция field_mask игнорирует поля, для которых заданы пустые или стандартные значения. Чтобы явно очистить поле или задать пустое сообщение, добавьте путь к полю непосредственно в campaign_operation.update_mask.paths. Подробнее о том, как задать пустые объекты сообщений в качестве полей…