Rename "gaada" setting to "ads_assistant" (#1063)

Author: BenRKarl

google/ads/googleads/client.py

@@ -104,7 +104,9 @@ def __dir__(self) -> Tuple[str]:
 
         return self._enums
 
-    def __getattr__(self, name: str) -> Union[ProtoPlusMessageType, ProtobufMessageType]:
+    def __getattr__(
+        self, name: str
+    ) -> Union[ProtoPlusMessageType, ProtobufMessageType]:
         """Dynamically loads the given enum class instance.
 
         Args:
@@ -162,10 +164,10 @@ class GoogleAdsClient:
 
     @classmethod
     def copy_from(
-            cls,
-            destination: Union[ProtoPlusMessageType, ProtobufMessageType],
-            origin: Union[ProtoPlusMessageType, ProtobufMessageType]
-        ) -> Union[ProtoPlusMessageType, ProtobufMessageType]:
+        cls,
+        destination: Union[ProtoPlusMessageType, ProtobufMessageType],
+        origin: Union[ProtoPlusMessageType, ProtobufMessageType],
+    ) -> Union[ProtoPlusMessageType, ProtobufMessageType]:
         """Copies protobuf and proto-plus messages into one-another.
 
         This method consolidates the CopyFrom logic of protobuf and proto-plus
@@ -204,7 +206,7 @@ def _get_client_kwargs(cls, config_data: Dict[str, Any]) -> Dict[str, Any]:
             "use_cloud_org_for_api_access": config_data.get(
                 "use_cloud_org_for_api_access"
             ),
-            "gaada": config_data.get("gaada"),
+            "ads_assistant": config_data.get("ads_assistant"),
         }
 
     @classmethod
@@ -267,7 +269,9 @@ def load_from_string(
         Raises:
             ValueError: If the configuration lacks a required field.
         """
-        config_data: Dict[str, Any] = config.parse_yaml_document_to_dict(yaml_str)
+        config_data: Dict[str, Any] = config.parse_yaml_document_to_dict(
+            yaml_str
+        )
         kwargs: Dict[str, Any] = cls._get_client_kwargs(config_data)
         return cls(**dict(version=version, **kwargs))
 
@@ -329,7 +333,7 @@ def __init__(
         http_proxy: Union[str, None] = None,
         use_proto_plus: bool = False,
         use_cloud_org_for_api_access: Union[str, None] = None,
-        gaada: Union[str, None] = None,
+        ads_assistant: Union[str, None] = None,
     ):
         """Initializer for the GoogleAdsClient.
 
@@ -349,7 +353,7 @@ def __init__(
                 of developer token to determine your Google Ads API access
                 levels. Use this flag only if you are enrolled into a limited
                 pilot that supports this configuration.
-            gaada: a str specifying the Google Ads API Assistant version.
+            ads_assistant: a str specifying the Google Ads API Assistant version.
         """
         if logging_config:
             logging.config.dictConfig(logging_config)
@@ -366,7 +370,7 @@ def __init__(
             use_cloud_org_for_api_access
         )
         self.enums: _EnumGetter = _EnumGetter(self)
-        self.gaada: Union[str, None] = gaada
+        self._ads_assistant: Union[str, None] = ads_assistant
 
         # If given, write the http_proxy channel option for GRPC to use
         if http_proxy:
@@ -403,9 +407,7 @@ def get_service(
         # override any version specified as an argument.
         version = self.version if self.version else version
         # api_module = self._get_api_services_by_version(version)
-        services_path: str = (
-            f"google.ads.googleads.{version}.services.services"
-        )
+        services_path: str = f"google.ads.googleads.{version}.services.services"
         snaked: str = util.convert_upper_case_to_snake_case(name)
         interceptors = interceptors or []
 
@@ -446,14 +448,14 @@ def get_service(
                     self.login_customer_id,
                     self.linked_customer_id,
                     self.use_cloud_org_for_api_access,
-                    gaada=self.gaada,
+                    ads_assistant=self._ads_assistant,
                 ),
                 AsyncUnaryStreamMetadataInterceptor(
                     self.developer_token,
                     self.login_customer_id,
                     self.linked_customer_id,
                     self.use_cloud_org_for_api_access,
-                    gaada=self.gaada,
+                    ads_assistant=self._ads_assistant,
                 ),
                 AsyncUnaryUnaryLoggingInterceptor(_logger, version, endpoint),
                 AsyncUnaryStreamLoggingInterceptor(_logger, version, endpoint),
@@ -485,7 +487,7 @@ def get_service(
                     developer_token=self.developer_token,
                     login_customer_id=self.login_customer_id,
                     linked_customer_id=self.linked_customer_id,
-                    use_cloud_org_for_api_access=self.use_cloud_org_for_api_access
+                    use_cloud_org_for_api_access=self.use_cloud_org_for_api_access,
                 )
 
             return service_client_class(transport=service_transport)
@@ -496,18 +498,21 @@ def get_service(
             options=_GRPC_CHANNEL_OPTIONS,
         )
 
-        interceptors: List[Union[grpc.UnaryUnaryClientInterceptor, grpc.UnaryStreamClientInterceptor]] = interceptors + [
+        interceptors: List[
+            Union[
+                grpc.UnaryUnaryClientInterceptor,
+                grpc.UnaryStreamClientInterceptor,
+            ]
+        ] = interceptors + [
             MetadataInterceptor(
                 self.developer_token,
                 self.login_customer_id,
                 self.linked_customer_id,
                 self.use_cloud_org_for_api_access,
-                gaada=self.gaada,
+                ads_assistant=self._ads_assistant,
             ),
             LoggingInterceptor(_logger, version, endpoint),
-            ExceptionInterceptor(
-                version, use_proto_plus=self.use_proto_plus
-            ),
+            ExceptionInterceptor(version, use_proto_plus=self.use_proto_plus),
         ]
 
         channel: grpc.Channel = grpc.intercept_channel(channel, *interceptors)
@@ -525,12 +530,14 @@ def get_service(
                 developer_token=self.developer_token,
                 login_customer_id=self.login_customer_id,
                 linked_customer_id=self.linked_customer_id,
-                use_cloud_org_for_api_access=self.use_cloud_org_for_api_access
+                use_cloud_org_for_api_access=self.use_cloud_org_for_api_access,
             )
 
         return service_client_class(transport=service_transport)
 
-    def get_type(self, name: str, version: str = _DEFAULT_VERSION) -> Union[ProtoPlusMessageType, ProtobufMessageType]:
+    def get_type(
+        self, name: str, version: str = _DEFAULT_VERSION
+    ) -> Union[ProtoPlusMessageType, ProtobufMessageType]:
         """Returns the specified common, enum, error, or resource type.
 
         Args:

google/ads/googleads/config.py

@@ -21,7 +21,6 @@
 from typing import Any, Callable, List, Tuple, TypeVar, Union
 import yaml
 
-
 _logger = logging.getLogger(__name__)
 
 
@@ -35,7 +34,7 @@
     "http_proxy",
     "use_cloud_org_for_api_access",
     "use_application_default_credentials",
-    "gaada",
+    "ads_assistant",
 )
 _CONFIG_FILE_PATH_KEY = ("configuration_file_path",)
 _OAUTH2_INSTALLED_APP_KEYS = ("client_id", "client_secret", "refresh_token")
@@ -96,7 +95,9 @@ def parser_wrapper(*args: Any, **kwargs: Any) -> Any:
         parsed_config: dict[str, Any] = convert_login_customer_id_to_str(
             config_dict
         )
-        parsed_config: dict[str, Any] = convert_linked_customer_id_to_str(parsed_config)
+        parsed_config: dict[str, Any] = convert_linked_customer_id_to_str(
+            parsed_config
+        )
 
         config_keys: List[str] = parsed_config.keys()
 
@@ -106,7 +107,9 @@ def parser_wrapper(*args: Any, **kwargs: Any) -> Any:
             # that needs to be returned by this method.
             if type(logging_config) is not dict:
                 try:
-                    parsed_config["logging"]: dict[str, Any] = json.loads(logging_config)
+                    parsed_config["logging"]: dict[str, Any] = json.loads(
+                        logging_config
+                    )
                     # The logger is configured here in case deprecation warnings
                     # need to be logged further down in this method. The logger
                     # is otherwise configured by the GoogleAdsClient class.
@@ -159,7 +162,9 @@ def parser_wrapper(*args: Any, **kwargs: Any) -> Any:
             # the string "False" is truthy and can easily be incorrectly
             # converted to the boolean True.
             value: Union[str, bool] = parsed_config.get("use_proto_plus", False)
-            parsed_config["use_proto_plus"]: bool = disambiguate_string_bool(value)
+            parsed_config["use_proto_plus"]: bool = disambiguate_string_bool(
+                value
+            )
 
         if "use_application_default_credentials" in config_keys:
             # When loaded from YAML, YAML string or a dict, this value is
@@ -168,8 +173,12 @@ def parser_wrapper(*args: Any, **kwargs: Any) -> Any:
             # variable we need to manually change it to the bool False because
             # the string "False" is truthy and can easily be incorrectly
             # converted to the boolean True.
-            value: Union[str, bool] = parsed_config.get("use_application_default_credentials", False)
-            parsed_config["use_application_default_credentials"]: bool = disambiguate_string_bool(value)
+            value: Union[str, bool] = parsed_config.get(
+                "use_application_default_credentials", False
+            )
+            parsed_config["use_application_default_credentials"]: bool = (
+                disambiguate_string_bool(value)
+            )
 
         return parsed_config
 
@@ -380,7 +389,7 @@ def get_oauth2_required_service_account_keys() -> tuple[str, ...]:
 
 
 def convert_login_customer_id_to_str(
-    config_data: dict[str, Any]
+    config_data: dict[str, Any],
 ) -> dict[str, Any]:
     """Parses a config dict's login_customer_id attr value to a str.
 
@@ -403,7 +412,7 @@ def convert_login_customer_id_to_str(
 
 
 def convert_linked_customer_id_to_str(
-    config_data: dict[str, Any]
+    config_data: dict[str, Any],
 ) -> dict[str, Any]:
     """Parses a config dict's linked_customer_id attr value to a str.
 

google/ads/googleads/interceptors/metadata_interceptor.py

@@ -30,8 +30,11 @@
 from google.protobuf.message import Message as ProtobufMessageType
 import grpc
 
-from google.ads.googleads.interceptors import Interceptor, MetadataType, ContinuationType
-
+from google.ads.googleads.interceptors import (
+    Interceptor,
+    MetadataType,
+    ContinuationType,
+)
 
 # Determine which version of the package is installed.
 try:
@@ -47,20 +50,21 @@
 else:
     _PB_IMPL_HEADER = ""
 
+
 class MetadataInterceptor(
     Interceptor,
     grpc.UnaryUnaryClientInterceptor,
-    grpc.UnaryStreamClientInterceptor
+    grpc.UnaryStreamClientInterceptor,
 ):
     """An interceptor that appends custom metadata to requests."""
 
     def __init__(
         self,
         developer_token: str,
-        login_customer_id: Optional[str]= None,
+        login_customer_id: Optional[str] = None,
         linked_customer_id: Optional[str] = None,
         use_cloud_org_for_api_access: Optional[bool] = None,
-        gaada: Optional[str] = None,
+        ads_assistant: Optional[str] = None,
     ):
         """Initialization method for this class.
 
@@ -73,7 +77,7 @@ def __init__(
                 of developer token to determine your Google Ads API access
                 levels. Use this flag only if you are enrolled into a limited
                 pilot that supports this configuration
-            gaada: a str specifying the Google Ads API Assistant version.
+            ads_assistant: a str specifying the Google Ads API Assistant version.
         """
         self.developer_token_meta: Tuple[str, str] = (
             "developer-token",
@@ -89,13 +93,15 @@ def __init__(
             if linked_customer_id
             else None
         )
-        self.gaada: Optional[str] = gaada
-        self.use_cloud_org_for_api_access: Optional[
-            bool
-        ] = use_cloud_org_for_api_access
+        self.ads_assistant: Optional[str] = ads_assistant
+        self.use_cloud_org_for_api_access: Optional[bool] = (
+            use_cloud_org_for_api_access
+        )
 
     def _update_client_call_details_metadata(
-        self, client_call_details: grpc.ClientCallDetails, metadata: MetadataType
+        self,
+        client_call_details: grpc.ClientCallDetails,
+        metadata: MetadataType,
     ):
         """Updates the client call details with additional metadata.
 
@@ -107,12 +113,14 @@ def _update_client_call_details_metadata(
             An new instance of grpc.ClientCallDetails with additional metadata
             from the GoogleAdsClient.
         """
-        client_call_details: grpc.ClientCallDetails = self.get_client_call_details_instance(
-            client_call_details.method,
-            client_call_details.timeout,
-            metadata,
-            client_call_details.credentials,
-            getattr(client_call_details, "wait_for_ready", None),
+        client_call_details: grpc.ClientCallDetails = (
+            self.get_client_call_details_instance(
+                client_call_details.method,
+                client_call_details.timeout,
+                metadata,
+                client_call_details.credentials,
+                getattr(client_call_details, "wait_for_ready", None),
+            )
         )
 
         return client_call_details
@@ -158,16 +166,18 @@ def _intercept(
             if "x-goog-api-client" in metadatum_tuple:
                 metadatum: List[str] = list(metadatum_tuple)
 
-                if self.gaada:
-                    metadatum[1] += f" gaada/{self.gaada}"
+                if self.ads_assistant:
+                    metadatum[1] += f" gaada/{self.ads_assistant}"
 
                 if _PROTOBUF_VERSION:
                     # Convert the tuple to a list so it can be modified.
                     # Check that "pb" isn't already included in the user agent.
                     if "pb" not in metadatum[1]:
                         # Append the protobuf version key value pair to the end of
                         # the string.
-                        metadatum[1] += f" pb/{_PROTOBUF_VERSION}{_PB_IMPL_HEADER}"
+                        metadatum[
+                            1
+                        ] += f" pb/{_PROTOBUF_VERSION}{_PB_IMPL_HEADER}"
                         # Convert the metadatum back to a tuple.
                         metadatum_tuple: Tuple[str, str] = tuple(metadatum)
 
@@ -177,9 +187,10 @@ def _intercept(
                 # Exit the loop since we already found the user agent.
                 break
 
-
-        client_call_details: grpc.ClientCallDetails = self._update_client_call_details_metadata(
-            client_call_details, metadata
+        client_call_details: grpc.ClientCallDetails = (
+            self._update_client_call_details_metadata(
+                client_call_details, metadata
+            )
         )
 
         return continuation(client_call_details, request)
@@ -229,9 +240,7 @@ def intercept_unary_stream(
         return self._intercept(continuation, client_call_details, request)
 
 
-class _AsyncMetadataInterceptor(
-    MetadataInterceptor
-):
+class _AsyncMetadataInterceptor(MetadataInterceptor):
     """An interceptor that appends custom metadata to requests."""
 
     async def _intercept(
@@ -340,20 +349,23 @@ async def intercept_unary_stream(
         """
         return await self._intercept(continuation, client_call_details, request)
 
+
 class AsyncUnaryUnaryMetadataInterceptor(
     _AsyncMetadataInterceptor,
     grpc.aio.UnaryUnaryClientInterceptor,
 ):
     """An interceptor that appends custom metadata to Unary-Unary requests."""
 
+
 class AsyncUnaryStreamMetadataInterceptor(
     _AsyncMetadataInterceptor,
     grpc.aio.UnaryStreamClientInterceptor,
 ):
     """An interceptor that appends custom metadata to Unary-Stream requests."""
 
+
 __all__ = [
     "MetadataInterceptor",
     "AsyncUnaryUnaryMetadataInterceptor",
     "AsyncUnaryStreamMetadataInterceptor",
-]
+]