Champs de requête facultatifs

Lorsque vous définissez des champs facultatifs sur une requête API, vous devez créer l'objet de message de requête directement et le transmettre en tant que paramètre request unique à la méthode de service.

Les champs de requête facultatifs, tels que le champ validate_only dans la méthode GoogleAdsService.Search, sont omis des signatures de méthode aplaties pour que les paramètres de mot clé restent gérables. Vous devez donc les définir directement sur l'instance de message de requête.

Pour déterminer si un champ d'objet de requête est obligatoire ou facultatif, consultez les définitions de service protobuf de l'API Google Ads et recherchez les champs contenant l'annotation [(google.api.field_behavior) = REQUIRED]. Les champs sans cette annotation sont facultatifs.

L'exemple suivant construit un objet SearchGoogleAdsRequest et définit le champ facultatif validate_only sur une requête 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)