Campos de solicitação opcionais

Ao definir campos opcionais em uma solicitação de API, é necessário criar o objeto de mensagem de solicitação diretamente e transmiti-lo como um único parâmetro request para o método de serviço.

Os campos de solicitação opcionais, como o campo validate_only no método GoogleAdsService.Search, são omitidos das assinaturas de método simplificadas para manter os parâmetros de palavra-chave gerenciáveis. Portanto, é necessário defini-los diretamente na instância da mensagem de solicitação.

Para determinar se um campo de objeto de solicitação é obrigatório ou opcional, consulte as definições de serviço do protobuf da API Google Ads e procure campos que contenham a anotação [(google.api.field_behavior) = REQUIRED]. Os campos sem essa anotação são opcionais.

O exemplo a seguir cria um objeto SearchGoogleAdsRequest e define o campo opcional validate_only em uma solicitação 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)