Add v2 refs

Merge branch 'update-api-version-v20' into add-type-hints-custom-logging

Author: bobhancockg

examples/assets/add_call.py

@@ -16,19 +16,33 @@
 
 
 import argparse
+from typing import Optional, Sequence
 import sys
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.services.types.asset_service import AssetOperation
+from google.ads.googleads.v20.resources.types.asset import Asset
+from google.ads.googleads.v20.common.types.criteria import AdScheduleInfo
+from google.ads.googleads.v20.enums.types.day_of_week import DayOfWeekEnum
+from google.ads.googleads.v20.enums.types.minute_of_hour import MinuteOfHourEnum
+from google.ads.googleads.v20.enums.types.call_conversion_reporting_state import CallConversionReportingStateEnum
+from google.ads.googleads.v20.services.types.customer_asset_service import CustomerAssetOperation
+from google.ads.googleads.v20.resources.types.customer_asset import CustomerAsset
+from google.ads.googleads.v20.enums.types.asset_field_type import AssetFieldTypeEnum
 
 # Country code is a two-letter ISO-3166 code, for a list of all codes see:
 # https://developers.google.com/google-ads/api/reference/data/codes-formats#expandable-17
-_DEFAULT_PHONE_COUNTRY = "US"
+_DEFAULT_PHONE_COUNTRY: str = "US"
 
 
 def main(
-    client, customer_id, phone_number, phone_country, conversion_action_id
-):
+    client: GoogleAdsClient,
+    customer_id: str,
+    phone_number: str,
+    phone_country: str,
+    conversion_action_id: Optional[str],
+) -> None:
     """The main method that creates all necessary entities for the example.
 
     Args:
@@ -38,15 +52,19 @@ def main(
         phone_country: a two-letter ISO-3166 code.
         conversion_action_id: an ID for a conversion action.
     """
-    asset_resource_name = add_call_asset(
+    asset_resource_name: str = add_call_asset(
         client, customer_id, phone_number, phone_country, conversion_action_id
     )
     link_asset_to_account(client, customer_id, asset_resource_name)
 
 
 def add_call_asset(
-    client, customer_id, phone_number, phone_country, conversion_action_id
-):
+    client: GoogleAdsClient,
+    customer_id: str,
+    phone_number: str,
+    phone_country: str,
+    conversion_action_id: Optional[str],
+) -> str:
     """Creates a new asset for the call.
 
     Args:
@@ -59,13 +77,13 @@ def add_call_asset(
     Returns:
         a resource name for a new call asset.
     """
-    operation = client.get_type("AssetOperation")
+    operation: AssetOperation = client.get_type("AssetOperation")
     # Creates the call asset.
-    asset = operation.create.call_asset
+    asset: Asset = operation.create.call_asset
     asset.country_code = phone_country
     asset.phone_number = phone_number
     # Optional: Specifies day and time intervals for which the asset may serve.
-    ad_schedule = client.get_type("AdScheduleInfo")
+    ad_schedule: AdScheduleInfo = client.get_type("AdScheduleInfo")
     # Sets the day of this schedule as Monday.
     ad_schedule.day_of_week = client.enums.DayOfWeekEnum.MONDAY
     # Sets the start hour to 9am.
@@ -93,35 +111,39 @@ def add_call_asset(
     response = asset_service.mutate_assets(
         customer_id=customer_id, operations=[operation]
     )
-    resource_name = response.results[0].resource_name
+    resource_name: str = response.results[0].resource_name
     print(f"Created a call asset with resource name: '{resource_name}'")
 
     return resource_name
 
 
-def link_asset_to_account(client, customer_id, asset_resource_name):
+def link_asset_to_account(
+    client: GoogleAdsClient, customer_id: str, asset_resource_name: str
+) -> None:
     """Links the call asset at the account level to serve in eligible campaigns.
 
     Args:
         client: an initialized GoogleAdsClient instance.
         customer_id: a client customer ID.
         asset_resource_name: a resource name for the call asset.
     """
-    operation = client.get_type("CustomerAssetOperation")
-    customer_asset = operation.create
+    operation: CustomerAssetOperation = client.get_type(
+        "CustomerAssetOperation"
+    )
+    customer_asset: CustomerAsset = operation.create
     customer_asset.asset = asset_resource_name
     customer_asset.field_type = client.enums.AssetFieldTypeEnum.CALL
 
     customer_asset_service = client.get_service("CustomerAssetService")
     response = customer_asset_service.mutate_customer_assets(
         customer_id=customer_id, operations=[operation]
     )
-    resource_name = response.results[0].resource_name
+    resource_name: str = response.results[0].resource_name
     print(f"Created a customer asset with resource name: '{resource_name}'")
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description=("Adds a call asset to a specific account.")
     )
     # The following argument(s) should be provided to run the example.
@@ -157,11 +179,13 @@ def link_asset_to_account(client, customer_id, asset_resource_name):
         help=("An optional conversion action ID to attribute conversions to."),
     )
 
-    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="v19")
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
 
     try:
         main(

examples/assets/add_hotel_callout.py

@@ -16,14 +16,22 @@
 
 
 import argparse
+from typing import List, Sequence
 import sys
 
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
+from google.ads.googleads.v20.services.types.asset_service import AssetOperation
+from google.ads.googleads.v20.resources.types.asset import Asset
+from google.ads.googleads.v20.services.types.customer_asset_service import CustomerAssetOperation
+from google.ads.googleads.v20.resources.types.customer_asset import CustomerAsset
+from google.ads.googleads.v20.enums.types.asset_field_type import AssetFieldTypeEnum
 
 
-def main(client, customer_id, language_code):
+def main(
+    client: GoogleAdsClient, customer_id: str, language_code: str
+) -> None:
     """The main method that creates all necessary entities for the example.
 
     Args:
@@ -32,7 +40,7 @@ def main(client, customer_id, language_code):
         language_code: the language of the hotel callout feed item text.
     """
     # Creates assets for the hotel callout assets.
-    asset_resource_names = add_hotel_callout_assets(
+    asset_resource_names: List[str] = add_hotel_callout_assets(
         client, customer_id, language_code
     )
 
@@ -41,7 +49,9 @@ def main(client, customer_id, language_code):
     link_asset_to_account(client, customer_id, asset_resource_names)
 
 
-def add_hotel_callout_assets(client, customer_id, language_code):
+def add_hotel_callout_assets(
+    client: GoogleAdsClient, customer_id: str, language_code: str
+) -> List[str]:
     """Creates new assets for the hotel callout.
 
     Args:
@@ -52,11 +62,11 @@ def add_hotel_callout_assets(client, customer_id, language_code):
     Returns:
         a list of asset resource names.
     """
-    operations = []
+    operations: List[AssetOperation] = []
     # Create a hotel callout asset operation for each of the below texts.
     for text in ["Activities", "Facilities"]:
-        operation = client.get_type("AssetOperation")
-        asset = operation.create
+        operation: AssetOperation = client.get_type("AssetOperation")
+        asset: Asset = operation.create
         asset.hotel_callout_asset.text = text
         asset.hotel_callout_asset.language_code = language_code
         operations.append(operation)
@@ -66,7 +76,9 @@ def add_hotel_callout_assets(client, customer_id, language_code):
     response = asset_service.mutate_assets(
         customer_id=customer_id, operations=operations
     )
-    resource_names = [result.resource_name for result in response.results]
+    resource_names: List[str] = [
+        result.resource_name for result in response.results
+    ]
 
     # Prints information about the result.
     for resource_name in resource_names:
@@ -78,7 +90,9 @@ def add_hotel_callout_assets(client, customer_id, language_code):
     return resource_names
 
 
-def link_asset_to_account(client, customer_id, resource_names):
+def link_asset_to_account(
+    client: GoogleAdsClient, customer_id: str, resource_names: List[str]
+) -> None:
     """Links Asset at the Customer level to serve in all eligible campaigns.
 
     Args:
@@ -87,10 +101,12 @@ def link_asset_to_account(client, customer_id, resource_names):
         resource_names: a list of asset resource names.
     """
     # Creates a CustomerAsset link for each Asset resource name provided.
-    operations = []
+    operations: List[CustomerAssetOperation] = []
     for resource_name in resource_names:
-        operation = client.get_type("CustomerAssetOperation")
-        asset = operation.create
+        operation: CustomerAssetOperation = client.get_type(
+            "CustomerAssetOperation"
+        )
+        asset: CustomerAsset = operation.create
         asset.asset = resource_name
         asset.field_type = client.enums.AssetFieldTypeEnum.HOTEL_CALLOUT
         operations.append(operation)
@@ -108,7 +124,7 @@ def link_asset_to_account(client, customer_id, resource_names):
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description=(
             "Adds a hotel callout asset and adds the asset to the given "
             "account."
@@ -133,11 +149,13 @@ def link_asset_to_account(client, customer_id, resource_names):
             "https://developers.google.com/hotels/hotel-ads/api-reference/language-codes."
         ),
     )
-    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="v19")
+    googleads_client: GoogleAdsClient = GoogleAdsClient.load_from_storage(
+        version="v20"
+    )
 
     try:
         main(googleads_client, args.customer_id, args.language_code)