Add annotations to examples/misc/ directory

Author: BenRKarl

examples/misc/add_ad_group_image_asset.py

@@ -23,7 +23,15 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.api_core import protobuf_helpers
+from google.ads.googleads.v20.resources.types.ad_group_asset import AdGroupAsset
+from google.ads.googleads.v20.services.services.ad_group_asset_service.client import (
+    AdGroupAssetServiceClient,
+)
+from google.ads.googleads.v20.services.types.ad_group_asset_service import (
+    AdGroupAssetOperation,
+    MutateAdGroupAssetResult,
+    MutateAdGroupAssetsResponse,
+)
 
 
 def main(
@@ -32,22 +40,29 @@ def main(
     ad_group_id: str,
     asset_id: str,
 ) -> None:
-    ad_group_asset_service = client.get_service("AdGroupAssetService")
+    ad_group_asset_service: AdGroupAssetServiceClient = client.get_service(
+        "AdGroupAssetService"
+    )
     ad_group_asset_resource_name: str = ad_group_asset_service.asset_path(
         customer_id, asset_id
     )
 
-    ad_group_asset_operation = client.get_type("AdGroupAssetOperation")
-    ad_group_asset_set = ad_group_asset_operation.create
+    ad_group_asset_operation: AdGroupAssetOperation = client.get_type(
+        "AdGroupAssetOperation"
+    )
+    ad_group_asset_set: AdGroupAsset = ad_group_asset_operation.create
     ad_group_asset_set.asset = ad_group_asset_resource_name
     ad_group_asset_set.field_type = client.enums.AssetFieldTypeEnum.AD_IMAGE
     ad_group_asset_set.ad_group = ad_group_asset_service.ad_group_path(
         customer_id, ad_group_id
     )
-    response = ad_group_asset_service.mutate_ad_group_assets(
-        customer_id=customer_id, operations=[ad_group_asset_operation]
+    response: MutateAdGroupAssetsResponse = (
+        ad_group_asset_service.mutate_ad_group_assets(
+            customer_id=customer_id, operations=[ad_group_asset_operation]
+        )
     )
 
+    result: MutateAdGroupAssetResult
     for result in response.results:
         print(
             f"Created ad group asset with resource name: '{result.resource_name}'"

examples/misc/campaign_report_to_csv.py

@@ -28,11 +28,20 @@
 """
 import argparse
 import csv
+from collections.abc import Iterator
 import os
 import sys
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.services.services.google_ads_service.client import (
+    GoogleAdsServiceClient,
+)
+from google.ads.googleads.v20.services.types.google_ads_service import (
+    GoogleAdsRow,
+    SearchGoogleAdsStreamRequest,
+    SearchGoogleAdsStreamResponse,
+)
 
 
 _DEFAULT_FILE_NAME = "campaign_report_to_csv_results.csv"
@@ -66,13 +75,17 @@ def main(
     """
     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")
+    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
 
     # Issues a search request using streaming.
-    search_request = client.get_type("SearchGoogleAdsStreamRequest")
+    search_request: SearchGoogleAdsStreamRequest = client.get_type(
+        "SearchGoogleAdsStreamRequest"
+    )
     search_request.customer_id = customer_id
     search_request.query = _QUERY
-    stream = ga_service.search_stream(search_request)
+    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
+        search_request
+    )
 
     with open(file_path, "w", newline="") as f:
         writer = csv.writer(f)
@@ -91,7 +104,9 @@ def main(
         if write_headers:
             writer.writerow(headers)
 
+        batch: SearchGoogleAdsStreamResponse
         for batch in stream:
+            row: GoogleAdsRow
             for row in batch.results:
                 # Use the CSV writer to write the individual GoogleAdsRow
                 # fields returned in the SearchGoogleAdsStreamResponse.

examples/misc/set_custom_client_timeouts.py

@@ -24,11 +24,21 @@
 
 
 import argparse
+from collections.abc import Iterator
 import sys
 from typing import List
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.services.services.google_ads_service.client import (
+    GoogleAdsServiceClient,
+)
+from google.ads.googleads.v20.services.types.google_ads_service import (
+    GoogleAdsRow,
+    SearchGoogleAdsRequest,
+    SearchGoogleAdsStreamRequest,
+    SearchGoogleAdsStreamResponse,
+)
 from google.api_core.exceptions import DeadlineExceeded
 from google.api_core.retry import Retry
 
@@ -53,14 +63,18 @@ def make_server_streaming_call(
         client: An initialized GoogleAds client.
         customer_id: The str Google Ads customer ID.
     """
-    ga_service = client.get_service("GoogleAdsService")
+    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
     campaign_ids: List[str] = []
 
     try:
-        search_request = client.get_type("SearchGoogleAdsStreamRequest")
+        search_request: SearchGoogleAdsStreamRequest = client.get_type(
+            "SearchGoogleAdsStreamRequest"
+        )
         search_request.customer_id = customer_id
         search_request.query = _QUERY
-        stream = ga_service.search_stream(
+        stream: Iterator[
+            SearchGoogleAdsStreamResponse
+        ] = ga_service.search_stream(
             request=search_request,
             # When making any request, an optional "timeout" parameter can be
             # provided to specify a client-side response deadline in seconds.
@@ -70,7 +84,9 @@ def make_server_streaming_call(
             timeout=_CLIENT_TIMEOUT_SECONDS,
         )
 
+        batch: SearchGoogleAdsStreamResponse
         for batch in stream:
+            row: GoogleAdsRow
             for row in batch.results:
                 campaign_ids.append(row.campaign.id)
 
@@ -102,14 +118,16 @@ def make_unary_call(client: GoogleAdsClient, customer_id: str) -> None:
         client: An initialized GoogleAds client.
         customer_id: The Google Ads customer ID.
     """
-    ga_service = client.get_service("GoogleAdsService")
+    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
     campaign_ids: List[str] = []
 
     try:
-        search_request = client.get_type("SearchGoogleAdsRequest")
+        search_request: SearchGoogleAdsRequest = client.get_type(
+            "SearchGoogleAdsRequest"
+        )
         search_request.customer_id = customer_id
         search_request.query = _QUERY
-        results = ga_service.search(
+        results: Iterator[GoogleAdsRow] = ga_service.search(
             request=search_request,
             # When making any request, an optional "retry" parameter can be
             # provided to specify its retry behavior. Complete information about
@@ -133,6 +151,7 @@ def make_unary_call(client: GoogleAdsClient, customer_id: str) -> None:
             ),
         )
 
+        row: GoogleAdsRow
         for row in results:
             campaign_ids.append(row.campaign.id)
 

examples/misc/upload_image_asset.py

@@ -24,11 +24,15 @@
 from examples.utils.example_helpers import get_image_bytes_from_url
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.ads.googleads.v19.services.types import (
+from google.ads.googleads.v20.resources.types.asset import Asset
+from google.ads.googleads.v20.services.services.asset_service.client import (
+    AssetServiceClient,
+)
+from google.ads.googleads.v20.services.types.asset_service import (
     AssetOperation,
+    MutateAssetResult,
     MutateAssetsResponse,
 )
-from google.ads.googleads.v19.resources.types import Asset
 from examples.utils.example_helpers import get_image_bytes_from_url
 
 
@@ -40,7 +44,7 @@ def main(client: GoogleAdsClient, customer_id: str) -> None:
     url: str = "https://gaagl.page.link/Eit5"
     image_content: bytes = get_image_bytes_from_url(url)
 
-    asset_service = client.get_service("AssetService")
+    asset_service: AssetServiceClient = client.get_service("AssetService")
     asset_operation: AssetOperation = client.get_type("AssetOperation")
     asset: Asset = asset_operation.create
     asset.type_ = client.enums.AssetTypeEnum.IMAGE
@@ -59,6 +63,7 @@ def main(client: GoogleAdsClient, customer_id: str) -> None:
         customer_id=customer_id, operations=[asset_operation]
     )
     print("Uploaded file(s):")
+    row: MutateAssetResult
     for row in mutate_asset_response.results:
         print(f"\tResource name: {row.resource_name}")