省略可能なリクエスト フィールド

API リクエストにオプション フィールドを設定する場合は、リクエスト メッセージ オブジェクトを直接作成し、1 つの 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)