Added annotations to examples/remarketing (#953)

Author: bobhancockg

examples/remarketing/add_conversion_action.py

@@ -21,17 +21,31 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.resources.types.conversion_action import (
+    ConversionAction,
+)
+from google.ads.googleads.v20.services.services.conversion_action_service import (
+    ConversionActionServiceClient,
+)
+from google.ads.googleads.v20.services.types.conversion_action_service import (
+    ConversionActionOperation,
+    MutateConversionActionsResponse,
+)
 
 
 # [START add_conversion_action]
-def main(client, customer_id):
-    conversion_action_service = client.get_service("ConversionActionService")
+def main(client: GoogleAdsClient, customer_id: str) -> None:
+    conversion_action_service: ConversionActionServiceClient = (
+        client.get_service("ConversionActionService")
+    )
 
     # Create the operation.
-    conversion_action_operation = client.get_type("ConversionActionOperation")
+    conversion_action_operation: ConversionActionOperation = client.get_type(
+        "ConversionActionOperation"
+    )
 
     # Create conversion action.
-    conversion_action = conversion_action_operation.create
+    conversion_action: ConversionAction = conversion_action_operation.create
 
     # Note that conversion action names must be unique. If a conversion action
     # already exists with the specified conversion_action_name, the create
@@ -47,12 +61,14 @@ def main(client, customer_id):
     conversion_action.view_through_lookback_window_days = 15
 
     # Create a value settings object.
-    value_settings = conversion_action.value_settings
+    value_settings: ConversionAction.ValueSettings = (
+        conversion_action.value_settings
+    )
     value_settings.default_value = 15.0
     value_settings.always_use_default_value = True
 
     # Add the conversion action.
-    conversion_action_response = (
+    conversion_action_response: MutateConversionActionsResponse = (
         conversion_action_service.mutate_conversion_actions(
             customer_id=customer_id,
             operations=[conversion_action_operation],
@@ -67,7 +83,7 @@ def main(client, customer_id):
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description="Adds a conversion action for specified customer."
     )
     # The following argument(s) should be provided to run the example.
@@ -78,11 +94,13 @@ def main(client, customer_id):
         required=True,
         help="The Google Ads customer ID.",
     )
-    args = parser.parse_args()
+    args: argparse.Namespace = parser.parse_args()
 
     # GoogleAdsClient will read the google-ads.yaml configuration file in the
     # home directory if none is specified.
-    googleads_client = GoogleAdsClient.load_from_storage(version="v20")
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
 
     try:
         main(googleads_client, args.customer_id)

examples/remarketing/add_conversion_based_user_list.py

@@ -22,13 +22,30 @@
 import argparse
 import sys
 from uuid import uuid4
+from typing import List
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.common.types.user_lists import UserListActionInfo
+from google.ads.googleads.v20.resources.types.user_list import UserList
+from google.ads.googleads.v20.services.services.conversion_action_service import (
+    ConversionActionServiceClient,
+)
+from google.ads.googleads.v20.services.services.user_list_service import (
+    UserListServiceClient,
+)
+from google.ads.googleads.v20.services.types.user_list_service import (
+    UserListOperation,
+    MutateUserListsResponse,
+)
 
 
 # [START add_conversion_based_user_list]
-def main(client, customer_id, conversion_action_ids):
+def main(
+    client: GoogleAdsClient,
+    customer_id: str,
+    conversion_action_ids: List[str],
+) -> None:
     """Creates a combination user list.
 
     Args:
@@ -38,15 +55,21 @@ def main(client, customer_id, conversion_action_ids):
             user list.
     """
     # Get the UserListService and ConversionActionService clients.
-    user_list_service = client.get_service("UserListService")
-    conversion_action_service = client.get_service("ConversionActionService")
+    user_list_service: UserListServiceClient = client.get_service(
+        "UserListService"
+    )
+    conversion_action_service: ConversionActionServiceClient = (
+        client.get_service("ConversionActionService")
+    )
 
     # Create a list of UserListActionInfo objects for the given conversion
     # actions. These specify the conversion actions that, when triggered, will
     # cause a user to be added to a UserList.
-    user_list_action_info_list = []
+    user_list_action_info_list: List[UserListActionInfo] = []
     for conversion_action_id in conversion_action_ids:
-        user_list_action_info = client.get_type("UserListActionInfo")
+        user_list_action_info: UserListActionInfo = client.get_type(
+            "UserListActionInfo"
+        )
         user_list_action_info.conversion_action = (
             conversion_action_service.conversion_action_path(
                 customer_id, conversion_action_id
@@ -55,8 +78,10 @@ def main(client, customer_id, conversion_action_ids):
         user_list_action_info_list.append(user_list_action_info)
 
     # Create a UserListOperation and populate the UserList.
-    user_list_operation = client.get_type("UserListOperation")
-    user_list = user_list_operation.create
+    user_list_operation: UserListOperation = client.get_type(
+        "UserListOperation"
+    )
+    user_list: UserList = user_list_operation.create
     user_list.name = f"Example BasicUserList #{uuid4()}"
     user_list.description = (
         "A list of people who have triggered one or more conversion actions"
@@ -67,7 +92,7 @@ def main(client, customer_id, conversion_action_ids):
     user_list.basic_user_list.actions.extend(user_list_action_info_list)
 
     # Issue a mutate request to add the user list, then print the results.
-    response = user_list_service.mutate_user_lists(
+    response: MutateUserListsResponse = user_list_service.mutate_user_lists(
         customer_id=customer_id, operations=[user_list_operation]
     )
     print(
@@ -78,7 +103,7 @@ def main(client, customer_id, conversion_action_ids):
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description="Creates a basic user list based on conversion actions."
     )
     # The following argument(s) should be provided to run the example.
@@ -97,11 +122,13 @@ def main(client, customer_id, conversion_action_ids):
         required=True,
         help="The IDs of the conversion actions for the basic user list.",
     )
-    args = parser.parse_args()
+    args: argparse.Namespace = parser.parse_args()
 
     # GoogleAdsClient will read the google-ads.yaml configuration file in the
     # home directory if none is specified.
-    googleads_client = GoogleAdsClient.load_from_storage(version="v20")
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
 
     try:
         main(googleads_client, args.customer_id, args.conversion_action_ids)

examples/remarketing/add_custom_audience.py

@@ -26,22 +26,40 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-
-
-def main(client, customer_id):
+from google.ads.googleads.v20.enums.types.custom_audience_member_type import (
+    CustomAudienceMemberTypeEnum,
+)
+from google.ads.googleads.v20.resources.types.custom_audience import (
+    CustomAudience,
+    CustomAudienceMember,
+)
+from google.ads.googleads.v20.services.types.custom_audience_service import (
+    CustomAudienceOperation,
+    MutateCustomAudiencesResponse,
+)
+from google.ads.googleads.v20.services.services.custom_audience_service import (
+    CustomAudienceServiceClient,
+)
+
+
+def main(client: GoogleAdsClient, customer_id: str) -> None:
     """The main method that creates all necessary entities for the example.
 
     Args:
         client: an initialized GoogleAdsClient instance.
         customer_id: a client customer ID.
     """
-    custom_audience_service = client.get_service("CustomAudienceService")
+    custom_audience_service: CustomAudienceServiceClient = client.get_service(
+        "CustomAudienceService"
+    )
 
     # Create a custom audience operation.
-    custom_audience_operation = client.get_type("CustomAudienceOperation")
+    custom_audience_operation: CustomAudienceOperation = client.get_type(
+        "CustomAudienceOperation"
+    )
 
     # Create a custom audience
-    custom_audience = custom_audience_operation.create
+    custom_audience: CustomAudience = custom_audience_operation.create
     custom_audience.name = f"Example CustomAudience #{uuid4()}"
     custom_audience.description = (
         "Custom audiences who have searched specific terms on Google Search."
@@ -54,25 +72,27 @@ def main(client, customer_id):
     custom_audience.status = client.enums.CustomAudienceStatusEnum.ENABLED
     # List of members that this custom audience is composed of. Customers that
     # meet any of the membership conditions will be reached.
-    member_type_enum = client.enums.CustomAudienceMemberTypeEnum
+    member_type_enum: CustomAudienceMemberTypeEnum = (
+        client.enums.CustomAudienceMemberTypeEnum
+    )
 
-    member1 = create_custom_audience_member(
+    member1: CustomAudienceMember = create_custom_audience_member(
         client, member_type_enum.KEYWORD, "mars cruise"
     )
 
-    member2 = create_custom_audience_member(
+    member2: CustomAudienceMember = create_custom_audience_member(
         client, member_type_enum.KEYWORD, "jupiter cruise"
     )
 
-    member3 = create_custom_audience_member(
+    member3: CustomAudienceMember = create_custom_audience_member(
         client, member_type_enum.URL, "http://www.example.com/locations/mars"
     )
 
-    member4 = create_custom_audience_member(
+    member4: CustomAudienceMember = create_custom_audience_member(
         client, member_type_enum.URL, "http://www.example.com/locations/jupiter"
     )
 
-    member5 = create_custom_audience_member(
+    member5: CustomAudienceMember = create_custom_audience_member(
         client, member_type_enum.APP, "com.google.android.apps.adwords"
     )
 
@@ -81,8 +101,10 @@ def main(client, customer_id):
     )
 
     # Add the custom audience.
-    custom_audience_response = custom_audience_service.mutate_custom_audiences(
-        customer_id=customer_id, operations=[custom_audience_operation]
+    custom_audience_response: MutateCustomAudiencesResponse = (
+        custom_audience_service.mutate_custom_audiences(
+            customer_id=customer_id, operations=[custom_audience_operation]
+        )
     )
 
     print(
@@ -91,7 +113,11 @@ def main(client, customer_id):
     )
 
 
-def create_custom_audience_member(client, member_type, value):
+def create_custom_audience_member(
+    client: GoogleAdsClient,
+    member_type: CustomAudienceMemberTypeEnum,
+    value: str,
+) -> CustomAudienceMember:
     """Creates a custom audience member for a given member type and value.
 
     Args:
@@ -102,10 +128,12 @@ def create_custom_audience_member(client, member_type, value):
     Returns:
         A newly created CustomAudienceMember.
     """
-    member = client.get_type("CustomAudienceMember")
+    member: CustomAudienceMember = client.get_type("CustomAudienceMember")
     member.member_type = member_type
 
-    member_type_enum = client.enums.CustomAudienceMemberTypeEnum
+    member_type_enum: CustomAudienceMemberTypeEnum = (
+        client.enums.CustomAudienceMemberTypeEnum
+    )
 
     if member_type == member_type_enum.KEYWORD:
         member.keyword = value
@@ -122,7 +150,7 @@ def create_custom_audience_member(client, member_type, value):
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description="Adds a custom audience for a specified customer."
     )
     # The following argument(s) should be provided to run the example.
@@ -133,11 +161,13 @@ def create_custom_audience_member(client, member_type, value):
         required=True,
         help="The Google Ads customer ID.",
     )
-    args = parser.parse_args()
+    args: argparse.Namespace = parser.parse_args()
 
     # GoogleAdsClient will read the google-ads.yaml configuration file in the
     # home directory if none is specified.
-    googleads_client = GoogleAdsClient.load_from_storage(version="v20")
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
 
     try:
         main(googleads_client, args.customer_id)