可选的请求字段

在 API 请求中设置可选字段时,您必须直接构造请求消息对象,并将其作为单个 request 参数传递给服务方法。

可选请求字段(例如 GoogleAdsService.Search 方法中的 validate_only 字段)会从扁平化方法签名中省略,以使关键字参数易于管理,因此您必须直接在请求消息实例上设置这些字段。

如需确定请求对象字段是必填还是可选,请参阅 Google Ads API protobuf 服务定义,并查找包含注解 [(google.api.field_behavior) = REQUIRED] 的字段。没有此注解的字段是可选字段。

以下示例会构造一个 SearchGoogleAdsRequest 对象,并在 GoogleAdsService.Search 请求中设置可选的 validate_only 字段:

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage()
googleads_service = client.get_service("GoogleAdsService")

# Initialize the request object and set required fields.
request = client.get_type("SearchGoogleAdsRequest")
request.customer_id = customer_id
request.query = query

# Set the optional validate_only field.
request.validate_only = True

response = googleads_service.search(request=request)