فیلدهای درخواست اختیاری

هنگام تنظیم فیلدهای اختیاری در درخواست API، باید شیء پیام درخواست را مستقیماً بسازید و آن را به‌عنوان یک پارامتر request به روش سرویس ارسال کنید.

فیلدهای اختیاری درخواست—مثل فیلد validate_only در روش GoogleAdsService.Search—از امضاهای روش مسطح حذف می‌شوند تا پارامترهای کلیدواژه قابل‌مدیریت باقی بمانند، بنابراین باید آن‌ها را مستقیماً در نمونه پیام درخواست تنظیم کنید.

برای تعیین اینکه فیلد شیء درخواست الزامی است یا اختیاری، به تعریف‌های سرویس Google Ads API protobuf مراجعه کنید و فیلدهایی را که حاوی گزارمان [(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)