Update annotations in account_management

Change-Id: Ibfc7606f8c05f5a0528738a3c0905e518fd627b9

Author: BenRKarl

examples/account_management/create_customer.py

@@ -27,15 +27,26 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.ads.googleads.v19.resources.types.customer import Customer
-from google.ads.googleads.v19.services.services.customer_service.client import CustomerServiceClient
-from google.ads.googleads.v19.services.types.customer_service import CreateCustomerClientResponse
-
+from google.ads.googleads.v20.resources.types.customer import Customer
+from google.ads.googleads.v20.services.services.customer_service.client import (
+    CustomerServiceClient,
+)
+from google.ads.googleads.v20.services.types.customer_service import (
+    CreateCustomerClientResponse,
+)
 
 
 # [START create_customer]
 def main(client: GoogleAdsClient, manager_customer_id: str) -> None:
-    customer_service: CustomerServiceClient = client.get_service("CustomerService")
+    """The main method that creates all necessary entities for the example.
+
+    Args:
+        client: an initialized GoogleAdsClient instance.
+        manager_customer_id: a manager client customer ID.
+    """
+    customer_service: CustomerServiceClient = client.get_service(
+        "CustomerService"
+    )
     customer: Customer = client.get_type("Customer")
     now: str = datetime.today().strftime("%Y%m%d %H:%M:%S")
     customer.descriptive_name = f"Account created with CustomerService on {now}"
@@ -47,11 +58,13 @@ def main(client: GoogleAdsClient, manager_customer_id: str) -> None:
     # options see: https://support.google.com/google-ads/answer/6305348
     customer.tracking_url_template = "{lpurl}?device={device}"
     customer.final_url_suffix = (
-        "keyword={keyword}&matchtype={matchtype}" "&adgroupid={adgroupid}"
+        "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}"
     )
 
-    response: CreateCustomerClientResponse = customer_service.create_customer_client(
-        customer_id=manager_customer_id, customer_client=customer
+    response: CreateCustomerClientResponse = (
+        customer_service.create_customer_client(
+            customer_id=manager_customer_id, customer_client=customer
+        )
     )
     print(
         f'Customer created with resource name "{response.resource_name}" '

examples/account_management/get_account_hierarchy.py

@@ -28,14 +28,27 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.ads.googleads.v19.services.services.google_ads_service.client import GoogleAdsServiceClient
-from google.ads.googleads.v19.services.services.customer_service.client import CustomerServiceClient
-from google.ads.googleads.v19.resources.types.customer_client import CustomerClient
-from google.ads.googleads.v19.services.types.google_ads_service import SearchPagedResponse, GoogleAdsRow
+from google.ads.googleads.v20.services.services.google_ads_service.client import (
+    GoogleAdsServiceClient,
+)
+from google.ads.googleads.v20.services.services.customer_service.client import (
+    CustomerServiceClient,
+)
+from google.ads.googleads.v20.resources.types.customer_client import (
+    CustomerClient,
+)
+from google.ads.googleads.v20.services.types.google_ads_service import (
+    SearchPagedResponse,
+    GoogleAdsRow,
+)
+
 # ListAccessibleCustomersResponse is not directly used for a variable type,
 # but its attribute .resource_names is used, which is List[str].
 
-def main(client: GoogleAdsClient, login_customer_id: Optional[str] = None) -> None:
+
+def main(
+    client: GoogleAdsClient, login_customer_id: Optional[str] = None
+) -> None:
     """Gets the account hierarchy of the given MCC and login customer ID.
 
     Args:
@@ -44,10 +57,13 @@ def main(client: GoogleAdsClient, login_customer_id: Optional[str] = None) -> No
       method will instead list the accounts accessible from the
       authenticated Google Ads account.
     """
-
     # Gets instances of the GoogleAdsService and CustomerService clients.
-    googleads_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
-    customer_service: CustomerServiceClient = client.get_service("CustomerService")
+    googleads_service: GoogleAdsServiceClient = client.get_service(
+        "GoogleAdsService"
+    )
+    customer_service: CustomerServiceClient = client.get_service(
+        "CustomerService"
+    )
 
     # A collection of customer IDs to handle.
     seed_customer_ids: List[str] = []
@@ -90,7 +106,9 @@ def main(client: GoogleAdsClient, login_customer_id: Optional[str] = None) -> No
             print(customer_id_from_parse)
             seed_customer_ids.append(customer_id_from_parse)
 
-    for seed_customer_id_str in seed_customer_ids: # seed_customer_id_str is a string
+    for (
+        seed_customer_id_str
+    ) in seed_customer_ids:  # seed_customer_id_str is a string
         # Performs a breadth-first search to build a Dictionary that maps
         # managers to their child accounts (customerIdsToChildAccounts).
         # unprocessed_customer_ids should store integers.
@@ -99,16 +117,21 @@ def main(client: GoogleAdsClient, login_customer_id: Optional[str] = None) -> No
         root_customer_client: CustomerClient | None = None
 
         while unprocessed_customer_ids:
-            customer_id_loop: int = unprocessed_customer_ids.pop(0) # customer_id_loop is an int
+            customer_id_loop: int = unprocessed_customer_ids.pop(
+                0
+            )  # customer_id_loop is an int
             # The search method expects customer_id to be a string.
             response: SearchPagedResponse = googleads_service.search(
                 customer_id=str(customer_id_loop), query=query
             )
 
             # Iterates over all rows in all pages to get all customer
             # clients under the specified customer's hierarchy.
-            for googleads_row: GoogleAdsRow in response:
-                customer_client_loop_var: CustomerClient = googleads_row.customer_client
+            googleads_row: GoogleAdsRow
+            for googleads_row in response:
+                customer_client_loop_var: CustomerClient = (
+                    googleads_row.customer_client
+                )
 
                 # The customer client that with level 0 is the specified
                 # customer.
@@ -134,10 +157,13 @@ def main(client: GoogleAdsClient, login_customer_id: Optional[str] = None) -> No
                     # need to check if it's already in the Dictionary.
                     # Assuming customer_client_loop_var.id is an int
                     if (
-                        customer_client_loop_var.id not in customer_ids_to_child_accounts
+                        customer_client_loop_var.id
+                        not in customer_ids_to_child_accounts
                         and customer_client_loop_var.level == 1
                     ):
-                        unprocessed_customer_ids.append(customer_client_loop_var.id)
+                        unprocessed_customer_ids.append(
+                            customer_client_loop_var.id
+                        )
 
         if root_customer_client is not None:
             print(
@@ -156,7 +182,9 @@ def main(client: GoogleAdsClient, login_customer_id: Optional[str] = None) -> No
 
 
 def print_account_hierarchy(
-    customer_client: CustomerClient, customer_ids_to_child_accounts: Dict[int, List[CustomerClient]], depth: int
+    customer_client: CustomerClient,
+    customer_ids_to_child_accounts: Dict[int, List[CustomerClient]],
+    depth: int,
 ) -> None:
     """Prints the specified account's hierarchy using recursion.
 
@@ -182,7 +210,8 @@ def print_account_hierarchy(
 
     # Recursively call this function for all child accounts of customer_client.
     if customer_id_print in customer_ids_to_child_accounts:
-        for child_account: CustomerClient in customer_ids_to_child_accounts[customer_id_print]:
+        child_account: CustomerClient
+        for child_account in customer_ids_to_child_accounts[customer_id_print]:
             print_account_hierarchy(
                 child_account, customer_ids_to_child_accounts, depth + 1
             )

examples/account_management/get_change_details.py

@@ -28,9 +28,15 @@
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
 from google.ads.googleads.util import get_nested_attr
-from google.ads.googleads.v19.services.services.google_ads_service.client import GoogleAdsServiceClient
-from google.ads.googleads.v19.services.types.google_ads_service import SearchGoogleAdsRequest, SearchPagedResponse, GoogleAdsRow
-from google.ads.googleads.v19.resources.types.change_event import ChangeEvent
+from google.ads.googleads.v20.services.services.google_ads_service.client import (
+    GoogleAdsServiceClient,
+)
+from google.ads.googleads.v20.services.types.google_ads_service import (
+    SearchGoogleAdsRequest,
+    SearchPagedResponse,
+    GoogleAdsRow,
+)
+from google.ads.googleads.v20.resources.types.change_event import ChangeEvent
 
 
 # [START get_change_details]
@@ -41,7 +47,9 @@ def main(client: GoogleAdsClient, customer_id: str) -> None:
       client: The Google Ads client.
       customer_id: The Google Ads customer ID.
     """
-    googleads_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")
+    googleads_service: GoogleAdsServiceClient = client.get_service(
+        "GoogleAdsService"
+    )
 
     # Construct a query to find details for recent changes in your account.
     # The LIMIT clause is required for the change_event resource.
@@ -70,13 +78,18 @@ def main(client: GoogleAdsClient, customer_id: str) -> None:
         ORDER BY change_event.change_date_time DESC
         LIMIT 5"""
 
-    search_request: SearchGoogleAdsRequest = client.get_type("SearchGoogleAdsRequest")
+    search_request: SearchGoogleAdsRequest = client.get_type(
+        "SearchGoogleAdsRequest"
+    )
     search_request.customer_id = customer_id
     search_request.query = query
 
-    results: SearchPagedResponse = googleads_service.search(request=search_request)
+    results: SearchPagedResponse = googleads_service.search(
+        request=search_request
+    )
 
-    for row: GoogleAdsRow in results:
+    row: GoogleAdsRow
+    for row in results:
         event: ChangeEvent = row.change_event
         resource_type: str = event.change_resource_type.name
         old_resource: Any
@@ -174,7 +187,9 @@ def main(client: GoogleAdsClient, customer_id: str) -> None:
                 if operation_type == "CREATE":
                     print(f"\t{changed_field} set to {new_value}")
                 else:
-                    old_value: Any = get_nested_attr(old_resource, changed_field)
+                    old_value: Any = get_nested_attr(
+                        old_resource, changed_field
+                    )
                     # If the field value is an Enum get the human readable name
                     # so that it is printed instead of the field ID integer.
                     if isinstance(type(old_value), ProtoEnumMeta):

examples/account_management/get_change_summary.py

@@ -22,9 +22,15 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.ads.googleads.v19.services.services.google_ads_service.client import GoogleAdsServiceClient
-from google.ads.googleads.v19.services.types.google_ads_service import SearchGoogleAdsRequest, SearchPagedResponse, GoogleAdsRow
-from google.ads.googleads.v19.resources.types.change_status import ChangeStatus
+from google.ads.googleads.v20.services.services.google_ads_service.client import (
+    GoogleAdsServiceClient,
+)
+from google.ads.googleads.v20.services.types.google_ads_service import (
+    SearchGoogleAdsRequest,
+    SearchPagedResponse,
+    GoogleAdsRow,
+)
+from google.ads.googleads.v20.resources.types.change_status import ChangeStatus
 
 
 # [START get_change_summary]
@@ -49,13 +55,16 @@ def main(client: GoogleAdsClient, customer_id: str) -> None:
         ORDER BY change_status.last_change_date_time
         LIMIT 10000"""
 
-    search_request: SearchGoogleAdsRequest = client.get_type("SearchGoogleAdsRequest")
+    search_request: SearchGoogleAdsRequest = client.get_type(
+        "SearchGoogleAdsRequest"
+    )
     search_request.customer_id = customer_id
     search_request.query = query
 
     response: SearchPagedResponse = ads_service.search(request=search_request)
 
-    for row: GoogleAdsRow in response:
+    row: GoogleAdsRow
+    for row in response:
         cs: ChangeStatus = row.change_status
         resource_type: str = cs.resource_type.name
         resource_name: str

examples/account_management/invite_user_with_access_role.py

@@ -23,14 +23,28 @@
 
 from google.ads.googleads.client import GoogleAdsClient
 from google.ads.googleads.errors import GoogleAdsException
-from google.ads.googleads.v19.services.services.customer_user_access_invitation_service.client import CustomerUserAccessInvitationServiceClient
-from google.ads.googleads.v19.services.types.customer_user_access_invitation_service import CustomerUserAccessInvitationOperation, MutateCustomerUserAccessInvitationResponse
-from google.ads.googleads.v19.resources.types.customer_user_access_invitation import CustomerUserAccessInvitation
+from google.ads.googleads.v20.services.services.customer_user_access_invitation_service.client import (
+    CustomerUserAccessInvitationServiceClient,
+)
+from google.ads.googleads.v20.services.types.customer_user_access_invitation_service import (
+    CustomerUserAccessInvitationOperation,
+    MutateCustomerUserAccessInvitationResponse,
+)
+from google.ads.googleads.v20.resources.types.customer_user_access_invitation import (
+    CustomerUserAccessInvitation,
+)
+
 # AccessRoleEnum is part of google.ads.googleads.v19.enums.types.access_role
 # but it's accessed via client.enums.AccessRoleEnum, so direct import for type hint might not be strictly needed for the parameter.
 # The field invitation.access_role expects an int (the enum value).
 
-def main(client: GoogleAdsClient, customer_id: str, email_address: str, access_role: str) -> None:
+
+def main(
+    client: GoogleAdsClient,
+    customer_id: str,
+    email_address: str,
+    access_role: str,
+) -> None:
     """The main method that creates all necessary entities for the example.
 
     Args:
@@ -39,19 +53,23 @@ def main(client: GoogleAdsClient, customer_id: str, email_address: str, access_r
         email_address: The email address for the user receiving the invitation.
         access_role: The desired access role for the invitee (e.g., "ADMIN", "STANDARD").
     """
-    service: CustomerUserAccessInvitationServiceClient = client.get_service("CustomerUserAccessInvitationService")
+    service: CustomerUserAccessInvitationServiceClient = client.get_service(
+        "CustomerUserAccessInvitationService"
+    )
     # [START invite_user_with_access_role]
-    invitation_operation: CustomerUserAccessInvitationOperation = client.get_type(
-        "CustomerUserAccessInvitationOperation"
+    invitation_operation: CustomerUserAccessInvitationOperation = (
+        client.get_type("CustomerUserAccessInvitationOperation")
     )
     invitation: CustomerUserAccessInvitation = invitation_operation.create
     invitation.email_address = email_address
     # The access_role field in the CustomerUserAccessInvitation message expects
     # an AccessRoleEnum value (which is an int).
     invitation.access_role = client.enums.AccessRoleEnum[access_role].value
 
-    response: MutateCustomerUserAccessInvitationResponse = service.mutate_customer_user_access_invitation(
-        customer_id=customer_id, operation=invitation_operation
+    response: MutateCustomerUserAccessInvitationResponse = (
+        service.mutate_customer_user_access_invitation(
+            customer_id=customer_id, operation=invitation_operation
+        )
     )
     print(
         "Customer user access invitation was sent for "