Необязательные поля запроса

При настройке необязательных полей в запросе к API необходимо создать объект сообщения запроса напрямую и передать его в качестве одного параметра request методу сервиса.

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

Чтобы определить, является ли поле объекта запроса обязательным или необязательным, обратитесь к определениям сервиса protobuf Google Ads API и найдите поля, содержащие аннотацию [(google.api.field_behavior) = REQUIRED]. Поля без этой аннотации являются необязательными.

В следующем примере создается объект SearchGoogleAdsRequest и задается необязательное поле validate_only в запросе GoogleAdsService.Search:

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)