Fix annotations in shopping ads examples

Change-Id: I836105786063f23d40941a8f8f1986d3d48e2253

Author: BenRKarl

examples/shopping_ads/__init__.py

@@ -1 +0,0 @@
-# Fully type-hinted

examples/shopping_ads/add_listing_scope.py

@@ -29,7 +29,7 @@
 
 import argparse
 import sys
-from typing import Any, List
+from typing import List
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
@@ -51,14 +51,13 @@
 from google.ads.googleads.v20.services.services.campaign_service import (
     CampaignServiceClient,
 )
-from google.ads.googleads.v20.services.types.campaign_criterion_operation import (
+from google.ads.googleads.v20.services.types.campaign_criterion_service import (
     CampaignCriterionOperation,
+    MutateCampaignCriteriaResponse,
 )
 
 
-def main(
-    client: GoogleAdsClient, customer_id: str, campaign_id: str
-) -> None:
+def main(client: GoogleAdsClient, customer_id: str, campaign_id: str) -> None:
     campaign_service: CampaignServiceClient = client.get_service(
         "CampaignService"
     )
@@ -121,7 +120,7 @@ def main(
         client.get_service("CampaignCriterionService")
     )
 
-    campaign_criterion_response: Any = (
+    campaign_criterion_response: MutateCampaignCriteriaResponse = (
         campaign_criterion_service.mutate_campaign_criteria(
             customer_id=customer_id, operations=[campaign_criterion_operation]
         )

examples/shopping_ads/add_performance_max_product_listing_group_tree.py

@@ -25,22 +25,13 @@
 
 import argparse
 import sys
-from typing import Any, Dict, List, Optional
+from typing import Dict, List, Optional
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.ads.googleads.v20.common.types.listing_group_filter_dimension import (
+from google.ads.googleads.v20.resources.types.asset_group_listing_group_filter import (
     ListingGroupFilterDimension,
 )
-from google.ads.googleads.v20.enums.types.listing_group_filter_product_condition import (
-    ListingGroupFilterProductConditionEnum,
-)
-from google.ads.googleads.v20.enums.types.listing_group_filter_type import (
-    ListingGroupFilterTypeEnum,
-)
-from google.ads.googleads.v20.enums.types.listing_group_filter_listing_source import (
-    ListingGroupFilterListingSourceEnum,
-)
 from google.ads.googleads.v20.resources.types.asset_group_listing_group_filter import (
     AssetGroupListingGroupFilter,
 )
@@ -52,7 +43,7 @@
     SearchGoogleAdsRequest,
     SearchGoogleAdsResponse,
 )
-from google.ads.googleads.v20.services.types.mutate_operation import (
+from google.ads.googleads.v20.services.types.google_ads_service import (
     MutateOperation,
 )
 
@@ -95,9 +86,9 @@ def __init__(
         # node and any parent to child edges in the tree.
         for listing_group_filter_node in listing_group_filters:
             resource_name: str = listing_group_filter_node.resource_name
-            parent_resource_name: Optional[
-                str
-            ] = listing_group_filter_node.parent_listing_group_filter
+            parent_resource_name: Optional[str] = (
+                listing_group_filter_node.parent_listing_group_filter
+            )
 
             # When the node has no parent, it means it's the root node.
             if not parent_resource_name:
@@ -423,10 +414,10 @@ def main(
 
     if replace_existing_tree:
         # Retrieve a list of existing AssetGroupListingGroupFilters
-        existing_listing_group_filters: List[
-            AssetGroupListingGroupFilter
-        ] = get_all_existing_listing_group_filter_assets_in_asset_group(
-            client, customer_id, asset_group_resource_name
+        existing_listing_group_filters: List[AssetGroupListingGroupFilter] = (
+            get_all_existing_listing_group_filter_assets_in_asset_group(
+                client, customer_id, asset_group_resource_name
+            )
         )
 
         # If present, create MutateOperations to remove each
@@ -578,7 +569,9 @@ def get_all_existing_listing_group_filter_assets_in_asset_group(
     googleads_service: GoogleAdsServiceClient = client.get_service(
         "GoogleAdsService"
     )
-    response: SearchGoogleAdsResponse = googleads_service.search(request=request)
+    response: SearchGoogleAdsResponse = googleads_service.search(
+        request=request
+    )
 
     return [
         result.asset_group_listing_group_filter

examples/shopping_ads/add_performance_max_retail_campaign.py

@@ -38,46 +38,23 @@
 import argparse
 from datetime import datetime, timedelta
 import sys
-from typing import Any, Dict, List, Tuple
+from typing import Dict, List, Union
 from uuid import uuid4
 
-from examples.utils.example_helpers import get_image_bytes_from_url
 from google.api_core import protobuf_helpers
+
+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.util import convert_snake_case_to_upper_case
-from google.ads.googleads.v20.common.types.criteria import LanguageInfo
-from google.ads.googleads.v20.common.types.asset_types import (
-    ImageAsset,
-    TextAsset,
-)
-from google.ads.googleads.v20.enums.types.advertising_channel_type import (
-    AdvertisingChannelTypeEnum,
-)
-from google.ads.googleads.v20.enums.types.asset_field_type import (
-    AssetFieldTypeEnum,
-)
-from google.ads.googleads.v20.enums.types.asset_group_status import (
-    AssetGroupStatusEnum,
-)
-from google.ads.googleads.v20.enums.types.asset_type import AssetTypeEnum
-from google.ads.googleads.v20.enums.types.budget_delivery_method import (
-    BudgetDeliveryMethodEnum,
-)
-from google.ads.googleads.v20.enums.types.campaign_status import (
-    CampaignStatusEnum,
-)
 from google.ads.googleads.v20.enums.types.conversion_action_category import (
     ConversionActionCategoryEnum,
 )
 from google.ads.googleads.v20.enums.types.conversion_origin import (
     ConversionOriginEnum,
 )
-from google.ads.googleads.v20.enums.types.listing_group_filter_listing_source import (
-    ListingGroupFilterListingSourceEnum,
-)
-from google.ads.googleads.v20.enums.types.listing_group_filter_type import (
-    ListingGroupFilterTypeEnum,
+from google.ads.googleads.v20.enums.types.asset_field_type import (
+    AssetFieldTypeEnum,
 )
 from google.ads.googleads.v20.resources.types.asset import Asset
 from google.ads.googleads.v20.resources.types.asset_group import AssetGroup
@@ -112,9 +89,6 @@
 from google.ads.googleads.v20.services.services.campaign_conversion_goal_service import (
     CampaignConversionGoalServiceClient,
 )
-from google.ads.googleads.v20.services.services.campaign_criterion_service import (
-    CampaignCriterionServiceClient,
-)
 from google.ads.googleads.v20.services.services.campaign_service import (
     CampaignServiceClient,
 )
@@ -130,7 +104,7 @@
     SearchGoogleAdsRequest,
     SearchGoogleAdsResponse,
 )
-from google.ads.googleads.v20.services.types.mutate_operation import (
+from google.ads.googleads.v20.services.types.google_ads_service import (
     MutateOperation,
 )
 
@@ -176,7 +150,13 @@ def main(
     # This campaign will override the customer conversion goals.
     # Retrieve the current list of customer conversion goals.
     customer_conversion_goals: List[
-        Dict[str, Any]
+        Dict[
+            str,
+            Union[
+                ConversionActionCategoryEnum.ConversionActionCategory,
+                ConversionOriginEnum.ConversionOrigin,
+            ],
+        ]
     ] = get_customer_conversion_goals(client, customer_id)
 
     # Performance Max campaigns require that repeated assets such as headlines
@@ -185,9 +165,7 @@ def main(
     # https://developers.google.com/google-ads/api/docs/performance-max/assets
     #
     # Create the headlines.
-    headline_asset_resource_names: List[
-        str
-    ] = create_multiple_text_assets(
+    headline_asset_resource_names: List[str] = create_multiple_text_assets(
         client,
         customer_id,
         [
@@ -197,9 +175,7 @@ def main(
         ],
     )
     # Create the descriptions.
-    description_asset_resource_names: List[
-        str
-    ] = create_multiple_text_assets(
+    description_asset_resource_names: List[str] = create_multiple_text_assets(
         client,
         customer_id,
         [
@@ -229,11 +205,11 @@ def main(
             brand_guidelines_enabled,
         )
     )
-    campaign_criterion_operations: List[
-        MutateOperation
-    ] = create_campaign_criterion_operations(
-        client,
-        customer_id,
+    campaign_criterion_operations: List[MutateOperation] = (
+        create_campaign_criterion_operations(
+            client,
+            customer_id,
+        )
     )
     asset_group_operation: MutateOperation = create_asset_group_operation(
         client, customer_id, final_url
@@ -250,12 +226,12 @@ def main(
             brand_guidelines_enabled,
         )
     )
-    conversion_goal_operations: List[
-        MutateOperation
-    ] = create_conversion_goal_operations(
-        client,
-        customer_id,
-        customer_conversion_goals,
+    conversion_goal_operations: List[MutateOperation] = (
+        create_conversion_goal_operations(
+            client,
+            customer_id,
+            customer_conversion_goals,
+        )
     )
 
     # Send the operations in a single Mutate request.
@@ -313,8 +289,10 @@ def create_campaign_budget_operation(
     campaign_budget_service: CampaignBudgetServiceClient = client.get_service(
         "CampaignBudgetService"
     )
-    campaign_budget.resource_name = campaign_budget_service.campaign_budget_path(
-        customer_id, _BUDGET_TEMPORARY_ID
+    campaign_budget.resource_name = (
+        campaign_budget_service.campaign_budget_path(
+            customer_id, _BUDGET_TEMPORARY_ID
+        )
     )
 
     return mutate_operation
@@ -565,9 +543,6 @@ def create_asset_group_operation(
     Returns:
         a MutateOperation that creates a new asset group.
     """
-    googleads_service: GoogleAdsServiceClient = client.get_service(
-        "GoogleAdsService"
-    )
     campaign_service: CampaignServiceClient = client.get_service(
         "CampaignService"
     )
@@ -913,9 +888,10 @@ def sorter(operation: MutateOperation) -> bool:
             True if the MutateOperation creates an asset group asset.
         """
         # Check if the oneof field 'asset_group_asset_operation' is set.
-        return operation.asset_group_asset_operation != type(
+        return (
             operation.asset_group_asset_operation
-        )()
+            != type(operation.asset_group_asset_operation)()
+        )
 
     return sorted(operations, key=sorter)
     # [END add_performance_max_retail_campaign_12]
@@ -924,7 +900,15 @@ def sorter(operation: MutateOperation) -> bool:
 # [START add_performance_max_retail_campaign_9]
 def get_customer_conversion_goals(
     client: GoogleAdsClient, customer_id: str
-) -> List[Dict[str, Any]]:
+) -> List[
+    Dict[
+        str,
+        Union[
+            ConversionActionCategoryEnum.ConversionActionCategory,
+            ConversionOriginEnum.ConversionOrigin,
+        ],
+    ]
+]:
     """Retrieves the list of customer conversion goals.
 
     Args:
@@ -936,7 +920,15 @@ def get_customer_conversion_goals(
         conversion goals.
     """
     ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
-    customer_conversion_goals: List[Dict[str, Any]] = []
+    customer_conversion_goals: List[
+        Dict[
+            str,
+            Union[
+                ConversionActionCategoryEnum.ConversionActionCategory,
+                ConversionOriginEnum.ConversionOrigin,
+            ],
+        ]
+    ] = []
     query: str = """
             SELECT
               customer_conversion_goal.category,
@@ -966,7 +958,15 @@ def get_customer_conversion_goals(
 def create_conversion_goal_operations(
     client: GoogleAdsClient,
     customer_id: str,
-    customer_conversion_goals: List[Dict[str, Any]],
+    customer_conversion_goals: List[
+        Dict[
+            str,
+            Union[
+                ConversionActionCategoryEnum.ConversionActionCategory,
+                ConversionOriginEnum.ConversionOrigin,
+            ],
+        ]
+    ],
 ) -> List[MutateOperation]:
     """Creates a list of MutateOperations that override customer conversion goals.
 
@@ -993,12 +993,12 @@ def create_conversion_goal_operations(
             mutate_operation.campaign_conversion_goal_operation.update
         )
 
-        category_enum_value: ConversionActionCategoryEnum.ConversionActionCategory = customer_goal_dict[
-            "category"
-        ]
-        origin_enum_value: ConversionOriginEnum.ConversionOrigin = customer_goal_dict[
-            "origin"
-        ]
+        category_enum_value: (
+            ConversionActionCategoryEnum.ConversionActionCategory
+        ) = customer_goal_dict["category"]
+        origin_enum_value: ConversionOriginEnum.ConversionOrigin = (
+            customer_goal_dict["origin"]
+        )
 
         campaign_conversion_goal.resource_name = (
             campaign_conversion_goal_service.campaign_conversion_goal_path(
@@ -1019,8 +1019,7 @@ def create_conversion_goal_operations(
         if (
             category_enum_value
             == client.enums.ConversionActionCategoryEnum.PURCHASE
-            and origin_enum_value
-            == client.enums.ConversionOriginEnum.WEBSITE
+            and origin_enum_value == client.enums.ConversionOriginEnum.WEBSITE
         ):
             biddable = True
         else: