Add type hints to examples/misc (#935)

Author: bobhancockg

examples/misc/add_ad_group_image_asset.py

@@ -26,9 +26,14 @@
 from google.api_core import protobuf_helpers
 
 
-def main(client, customer_id, ad_group_id, asset_id):
+def main(
+    client: GoogleAdsClient,
+    customer_id: str,
+    ad_group_id: str,
+    asset_id: str,
+) -> None:
     ad_group_asset_service = client.get_service("AdGroupAssetService")
-    ad_group_asset_resource_name = ad_group_asset_service.asset_path(
+    ad_group_asset_resource_name: str = ad_group_asset_service.asset_path(
         customer_id, asset_id
     )
 

examples/misc/campaign_report_to_csv.py

@@ -38,19 +38,24 @@
 _DEFAULT_FILE_NAME = "campaign_report_to_csv_results.csv"
 
 
-def main(client, customer_id, output_file, write_headers):
+def main(
+    client: GoogleAdsClient,
+    customer_id: str,
+    output_file: str,
+    write_headers: bool,
+) -> None:
     """Writes rows returned from a search_stream request to a CSV file.
     Args:
         client: An initialized GoogleAdsClient instance.
         customer_id (str): The client customer ID string.
         output_file (str): Filename of the file to write the report data to.
         write_headers (bool): From argparse, True if arg is provided.
     """
-    file_dir = os.path.dirname(os.path.abspath(__file__))
-    file_path = os.path.join(file_dir, output_file)
+    file_dir: str = os.path.dirname(os.path.abspath(__file__))
+    file_path: str = os.path.join(file_dir, output_file)
     ga_service = client.get_service("GoogleAdsService")
 
-    query = """
+    query: str = """
         SELECT
           customer.descriptive_name,
           segments.date,
@@ -74,7 +79,7 @@ def main(client, customer_id, output_file, write_headers):
         writer = csv.writer(f)
 
         # Define a list of headers for the first row.
-        headers = [
+        headers: list[str] = [
             "Account",
             "Date",
             "Campaign",

examples/misc/set_custom_client_timeouts.py

@@ -25,6 +25,7 @@
 
 import argparse
 import sys
+from typing import List
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
@@ -33,25 +34,27 @@
 
 
 _CLIENT_TIMEOUT_SECONDS = 5 * 60  # 5 minutes.
-_QUERY = "SELECT campaign.id FROM campaign"
+_QUERY: str = "SELECT campaign.id FROM campaign"
 
 
-def main(client, customer_id):
+def main(client: GoogleAdsClient, customer_id: str) -> None:
     """Main method, to run this code example as a standalone application."""
     make_server_streaming_call(client, customer_id)
     make_unary_call(client, customer_id)
 
 
 # [START set_custom_client_timeouts]
-def make_server_streaming_call(client, customer_id):
+def make_server_streaming_call(
+    client: GoogleAdsClient, customer_id: str
+) -> None:
     """Makes a server streaming call using a custom client timeout.
 
     Args:
         client: An initialized GoogleAds client.
         customer_id: The str Google Ads customer ID.
     """
     ga_service = client.get_service("GoogleAdsService")
-    campaign_ids = []
+    campaign_ids: List[str] = []
 
     try:
         search_request = client.get_type("SearchGoogleAdsStreamRequest")
@@ -92,15 +95,15 @@ def make_server_streaming_call(client, customer_id):
 
 
 # [START set_custom_client_timeouts_1]
-def make_unary_call(client, customer_id):
+def make_unary_call(client: GoogleAdsClient, customer_id: str) -> None:
     """Makes a unary call using a custom client timeout.
 
     Args:
         client: An initialized GoogleAds client.
         customer_id: The Google Ads customer ID.
     """
     ga_service = client.get_service("GoogleAdsService")
-    campaign_ids = []
+    campaign_ids: List[str] = []
 
     try:
         search_request = client.get_type("SearchGoogleAdsRequest")

examples/misc/upload_image_asset.py

@@ -23,20 +23,25 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v19.services.types import (
+    AssetOperation,
+    MutateAssetsResponse,
+)
+from google.ads.googleads.v19.resources.types import Asset
 from examples.utils.example_helpers import get_image_bytes_from_url
 
 
 # [START upload_image_asset]
-def main(client, customer_id):
+def main(client: GoogleAdsClient, customer_id: str) -> None:
     """Main method, to run this code example as a standalone application."""
 
     # Download image from URL
-    url = "https://gaagl.page.link/Eit5"
-    image_content = get_image_bytes_from_url(url)
+    url: str = "https://gaagl.page.link/Eit5"
+    image_content: bytes = get_image_bytes_from_url(url)
 
     asset_service = client.get_service("AssetService")
-    asset_operation = client.get_type("AssetOperation")
-    asset = asset_operation.create
+    asset_operation: AssetOperation = client.get_type("AssetOperation")
+    asset: Asset = asset_operation.create
     asset.type_ = client.enums.AssetTypeEnum.IMAGE
     asset.image_asset.data = image_content
     asset.image_asset.file_size = len(image_content)
@@ -49,9 +54,10 @@ def main(client, customer_id):
     # When there is an existing image asset with the same content but a different
     # name, the new name will be dropped silently.
     asset.name = "Marketing Image"
-
-    mutate_asset_response = asset_service.mutate_assets(
-        customer_id=customer_id, operations=[asset_operation]
+    mutate_asset_response: MutateAssetsResponse = (
+        asset_service.mutate_assets(
+            customer_id=customer_id, operations=[asset_operation]
+        )
     )
     print("Uploaded file(s):")
     for row in mutate_asset_response.results: