diff --git a/packages/google-shopping-merchant-reports/docs/index.rst b/packages/google-shopping-merchant-reports/docs/index.rst index 1d5a2062b7f5..4e776813be55 100644 --- a/packages/google-shopping-merchant-reports/docs/index.rst +++ b/packages/google-shopping-merchant-reports/docs/index.rst @@ -14,6 +14,14 @@ API Reference merchant_reports_v1beta/services_ merchant_reports_v1beta/types_ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_reports_v1/services_ + merchant_reports_v1/types_ + API Reference ------------- .. toctree:: diff --git a/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/report_service.rst b/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/report_service.rst new file mode 100644 index 000000000000..21c9f9032f80 --- /dev/null +++ b/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/report_service.rst @@ -0,0 +1,10 @@ +ReportService +------------------------------- + +.. automodule:: google.shopping.merchant_reports_v1.services.report_service + :members: + :inherited-members: + +.. automodule:: google.shopping.merchant_reports_v1.services.report_service.pagers + :members: + :inherited-members: diff --git a/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/services_.rst b/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/services_.rst new file mode 100644 index 000000000000..37dc2acc0680 --- /dev/null +++ b/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Shopping Merchant Reports v1 API +==================================================== +.. toctree:: + :maxdepth: 2 + + report_service diff --git a/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/types_.rst b/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/types_.rst new file mode 100644 index 000000000000..0de4a0746d64 --- /dev/null +++ b/packages/google-shopping-merchant-reports/docs/merchant_reports_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Shopping Merchant Reports v1 API +================================================= + +.. automodule:: google.shopping.merchant_reports_v1.types + :members: + :show-inheritance: diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/__init__.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/__init__.py new file mode 100644 index 000000000000..427316da4bc3 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/__init__.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.shopping.merchant_reports_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.report_service import ReportServiceAsyncClient, ReportServiceClient +from .types.reports import ( + BestSellersBrandView, + BestSellersProductClusterView, + CompetitiveVisibilityBenchmarkView, + CompetitiveVisibilityCompetitorView, + CompetitiveVisibilityTopMerchantView, + MarketingMethod, + NonProductPerformanceView, + PriceCompetitivenessProductView, + PriceInsightsProductView, + ProductPerformanceView, + ProductView, + RelativeDemand, + RelativeDemandChangeType, + ReportGranularity, + ReportRow, + SearchRequest, + SearchResponse, + TrafficSource, +) + +__all__ = ( + "ReportServiceAsyncClient", + "BestSellersBrandView", + "BestSellersProductClusterView", + "CompetitiveVisibilityBenchmarkView", + "CompetitiveVisibilityCompetitorView", + "CompetitiveVisibilityTopMerchantView", + "MarketingMethod", + "NonProductPerformanceView", + "PriceCompetitivenessProductView", + "PriceInsightsProductView", + "ProductPerformanceView", + "ProductView", + "RelativeDemand", + "RelativeDemandChangeType", + "ReportGranularity", + "ReportRow", + "ReportServiceClient", + "SearchRequest", + "SearchResponse", + "TrafficSource", +) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/gapic_metadata.json b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/gapic_metadata.json new file mode 100644 index 000000000000..46152fd967d4 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/gapic_metadata.json @@ -0,0 +1,43 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.shopping.merchant_reports_v1", + "protoPackage": "google.shopping.merchant.reports.v1", + "schema": "1.0", + "services": { + "ReportService": { + "clients": { + "grpc": { + "libraryClient": "ReportServiceClient", + "rpcs": { + "Search": { + "methods": [ + "search" + ] + } + } + }, + "grpc-async": { + "libraryClient": "ReportServiceAsyncClient", + "rpcs": { + "Search": { + "methods": [ + "search" + ] + } + } + }, + "rest": { + "libraryClient": "ReportServiceClient", + "rpcs": { + "Search": { + "methods": [ + "search" + ] + } + } + } + } + } + } +} diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/gapic_version.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/py.typed b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/py.typed new file mode 100644 index 000000000000..925c5df4dab6 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-reports package uses inline types. diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/__init__.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/__init__.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/__init__.py new file mode 100644 index 000000000000..c248e8ea702a --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .async_client import ReportServiceAsyncClient +from .client import ReportServiceClient + +__all__ = ( + "ReportServiceClient", + "ReportServiceAsyncClient", +) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/async_client.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/async_client.py new file mode 100644 index 000000000000..d9d1a353a2c6 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/async_client.py @@ -0,0 +1,434 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import logging as std_logging +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry_async as retries +from google.api_core.client_options import ClientOptions +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_reports_v1 import gapic_version as package_version + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_reports_v1.services.report_service import pagers +from google.shopping.merchant_reports_v1.types import reports + +from .client import ReportServiceClient +from .transports.base import DEFAULT_CLIENT_INFO, ReportServiceTransport +from .transports.grpc_asyncio import ReportServiceGrpcAsyncIOTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class ReportServiceAsyncClient: + """Service for retrieving reports and insights about your + products, their performance, and their competitive environment + on Google. + """ + + _client: ReportServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = ReportServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = ReportServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = ReportServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = ReportServiceClient._DEFAULT_UNIVERSE + + common_billing_account_path = staticmethod( + ReportServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + ReportServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(ReportServiceClient.common_folder_path) + parse_common_folder_path = staticmethod( + ReportServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + ReportServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + ReportServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod(ReportServiceClient.common_project_path) + parse_common_project_path = staticmethod( + ReportServiceClient.parse_common_project_path + ) + common_location_path = staticmethod(ReportServiceClient.common_location_path) + parse_common_location_path = staticmethod( + ReportServiceClient.parse_common_location_path + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + ReportServiceAsyncClient: The constructed client. + """ + return ReportServiceClient.from_service_account_info.__func__(ReportServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + ReportServiceAsyncClient: The constructed client. + """ + return ReportServiceClient.from_service_account_file.__func__(ReportServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[ClientOptions] = None + ): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return ReportServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> ReportServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ReportServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = ReportServiceClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[str, ReportServiceTransport, Callable[..., ReportServiceTransport]] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the report service async client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,ReportServiceTransport,Callable[..., ReportServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the ReportServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = ReportServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.reports_v1.ReportServiceAsyncClient`.", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "universeDomain": getattr( + self._client._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._client._transport, "_credentials") + else { + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "credentialsType": None, + }, + ) + + async def search( + self, + request: Optional[Union[reports.SearchRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.SearchAsyncPager: + r"""Retrieves a report defined by a search query. The response might + contain fewer rows than specified by ``page_size``. Rely on + ``next_page_token`` to determine if there are more rows to be + requested. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_reports_v1 + + async def sample_search(): + # Create a client + client = merchant_reports_v1.ReportServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reports_v1.SearchRequest( + parent="parent_value", + query="query_value", + ) + + # Make the request + page_result = client.search(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_reports_v1.types.SearchRequest, dict]]): + The request object. Request message for the ``ReportService.Search`` method. + parent (:class:`str`): + Required. Id of the account making + the call. Must be a standalone account + or an MCA subaccount. Format: + accounts/{account} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_reports_v1.services.report_service.pagers.SearchAsyncPager: + Response message for the ReportService.Search method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reports.SearchRequest): + request = reports.SearchRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.search] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.SearchAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "ReportServiceAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ("ReportServiceAsyncClient",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/client.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/client.py new file mode 100644 index 000000000000..84510a1ca1b7 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/client.py @@ -0,0 +1,840 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from http import HTTPStatus +import json +import logging as std_logging +import os +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) +import warnings + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_reports_v1 import gapic_version as package_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +from google.shopping.merchant_reports_v1.services.report_service import pagers +from google.shopping.merchant_reports_v1.types import reports + +from .transports.base import DEFAULT_CLIENT_INFO, ReportServiceTransport +from .transports.grpc import ReportServiceGrpcTransport +from .transports.grpc_asyncio import ReportServiceGrpcAsyncIOTransport +from .transports.rest import ReportServiceRestTransport + + +class ReportServiceClientMeta(type): + """Metaclass for the ReportService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = OrderedDict() # type: Dict[str, Type[ReportServiceTransport]] + _transport_registry["grpc"] = ReportServiceGrpcTransport + _transport_registry["grpc_asyncio"] = ReportServiceGrpcAsyncIOTransport + _transport_registry["rest"] = ReportServiceRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[ReportServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class ReportServiceClient(metaclass=ReportServiceClientMeta): + """Service for retrieving reports and insights about your + products, their performance, and their competitive environment + on Google. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "merchantapi.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + ReportServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + ReportServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> ReportServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ReportServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): + """Deprecated. Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + + warnings.warn( + "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning, + ) + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint( + api_override, client_cert_source, universe_domain, use_mtls_endpoint + ): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + _default_universe = ReportServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = ReportServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = ReportServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=universe_domain + ) + return api_endpoint + + @staticmethod + def _get_universe_domain( + client_universe_domain: Optional[str], universe_domain_env: Optional[str] + ) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = ReportServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + def _add_cred_info_for_auth_errors( + self, error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [ + HTTPStatus.UNAUTHORIZED, + HTTPStatus.FORBIDDEN, + HTTPStatus.NOT_FOUND, + ]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[str, ReportServiceTransport, Callable[..., ReportServiceTransport]] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the report service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,ReportServiceTransport,Callable[..., ReportServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the ReportServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast( + client_options_lib.ClientOptions, self._client_options + ) + + universe_domain_opt = getattr(self._client_options, "universe_domain", None) + + ( + self._use_client_cert, + self._use_mtls_endpoint, + self._universe_domain_env, + ) = ReportServiceClient._read_environment_variables() + self._client_cert_source = ReportServiceClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + self._universe_domain = ReportServiceClient._get_universe_domain( + universe_domain_opt, self._universe_domain_env + ) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError( + "client_options.api_key and credentials are mutually exclusive" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + transport_provided = isinstance(transport, ReportServiceTransport) + if transport_provided: + # transport is a ReportServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(ReportServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = ( + self._api_endpoint + or ReportServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint, + ) + ) + + if not transport_provided: + import google.auth._default # type: ignore + + if api_key_value and hasattr( + google.auth._default, "get_api_key_credentials" + ): + credentials = google.auth._default.get_api_key_credentials( + api_key_value + ) + + transport_init: Union[ + Type[ReportServiceTransport], Callable[..., ReportServiceTransport] + ] = ( + ReportServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., ReportServiceTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.reports_v1.ReportServiceClient`.", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "universeDomain": getattr( + self._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._transport, "_credentials") + else { + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "credentialsType": None, + }, + ) + + def search( + self, + request: Optional[Union[reports.SearchRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.SearchPager: + r"""Retrieves a report defined by a search query. The response might + contain fewer rows than specified by ``page_size``. Rely on + ``next_page_token`` to determine if there are more rows to be + requested. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_reports_v1 + + def sample_search(): + # Create a client + client = merchant_reports_v1.ReportServiceClient() + + # Initialize request argument(s) + request = merchant_reports_v1.SearchRequest( + parent="parent_value", + query="query_value", + ) + + # Make the request + page_result = client.search(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.shopping.merchant_reports_v1.types.SearchRequest, dict]): + The request object. Request message for the ``ReportService.Search`` method. + parent (str): + Required. Id of the account making + the call. Must be a standalone account + or an MCA subaccount. Format: + accounts/{account} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_reports_v1.services.report_service.pagers.SearchPager: + Response message for the ReportService.Search method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reports.SearchRequest): + request = reports.SearchRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.SearchPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "ReportServiceClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ("ReportServiceClient",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/pagers.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/pagers.py new file mode 100644 index 000000000000..ea48b62382d5 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/pagers.py @@ -0,0 +1,197 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import ( + Any, + AsyncIterator, + Awaitable, + Callable, + Iterator, + Optional, + Sequence, + Tuple, + Union, +) + +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import retry_async as retries_async + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] + OptionalAsyncRetry = Union[ + retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None + ] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_reports_v1.types import reports + + +class SearchPager: + """A pager for iterating through ``search`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_reports_v1.types.SearchResponse` object, and + provides an ``__iter__`` method to iterate through its + ``results`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``Search`` requests and continue to iterate + through the ``results`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_reports_v1.types.SearchResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., reports.SearchResponse], + request: reports.SearchRequest, + response: reports.SearchResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.shopping.merchant_reports_v1.types.SearchRequest): + The initial request object. + response (google.shopping.merchant_reports_v1.types.SearchResponse): + The initial response object. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reports.SearchRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reports.SearchResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __iter__(self) -> Iterator[reports.ReportRow]: + for page in self.pages: + yield from page.results + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class SearchAsyncPager: + """A pager for iterating through ``search`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_reports_v1.types.SearchResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``results`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``Search`` requests and continue to iterate + through the ``results`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_reports_v1.types.SearchResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[reports.SearchResponse]], + request: reports.SearchRequest, + response: reports.SearchResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.shopping.merchant_reports_v1.types.SearchRequest): + The initial request object. + response (google.shopping.merchant_reports_v1.types.SearchResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reports.SearchRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reports.SearchResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __aiter__(self) -> AsyncIterator[reports.ReportRow]: + async def async_generator(): + async for page in self.pages: + for response in page.results: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/README.rst b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/README.rst new file mode 100644 index 000000000000..3ff494d6f149 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`ReportServiceTransport` is the ABC for all transports. +- public child `ReportServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `ReportServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseReportServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `ReportServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/__init__.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/__init__.py new file mode 100644 index 000000000000..da3baf4ee507 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/__init__.py @@ -0,0 +1,36 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import ReportServiceTransport +from .grpc import ReportServiceGrpcTransport +from .grpc_asyncio import ReportServiceGrpcAsyncIOTransport +from .rest import ReportServiceRestInterceptor, ReportServiceRestTransport + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[ReportServiceTransport]] +_transport_registry["grpc"] = ReportServiceGrpcTransport +_transport_registry["grpc_asyncio"] = ReportServiceGrpcAsyncIOTransport +_transport_registry["rest"] = ReportServiceRestTransport + +__all__ = ( + "ReportServiceTransport", + "ReportServiceGrpcTransport", + "ReportServiceGrpcAsyncIOTransport", + "ReportServiceRestTransport", + "ReportServiceRestInterceptor", +) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/base.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/base.py new file mode 100644 index 000000000000..d0ff495f63e1 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/base.py @@ -0,0 +1,165 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_reports_v1 import gapic_version as package_version +from google.shopping.merchant_reports_v1.types import reports + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class ReportServiceTransport(abc.ABC): + """Abstract transport class for ReportService.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/content",) + + DEFAULT_HOST: str = "merchantapi.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.search: gapic_v1.method.wrap_method( + self.search, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def search( + self, + ) -> Callable[ + [reports.SearchRequest], + Union[reports.SearchResponse, Awaitable[reports.SearchResponse]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("ReportServiceTransport",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/grpc.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/grpc.py new file mode 100644 index 000000000000..4bf7f4f1d3a7 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/grpc.py @@ -0,0 +1,359 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import json +import logging as std_logging +import pickle +from typing import Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, grpc_helpers +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore + +from google.shopping.merchant_reports_v1.types import reports + +from .base import DEFAULT_CLIENT_INFO, ReportServiceTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class ReportServiceGrpcTransport(ReportServiceTransport): + """gRPC backend transport for ReportService. + + Service for retrieving reports and insights about your + products, their performance, and their competitive environment + on Google. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel( + self._grpc_channel, self._interceptor + ) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def search(self) -> Callable[[reports.SearchRequest], reports.SearchResponse]: + r"""Return a callable for the search method over gRPC. + + Retrieves a report defined by a search query. The response might + contain fewer rows than specified by ``page_size``. Rely on + ``next_page_token`` to determine if there are more rows to be + requested. + + Returns: + Callable[[~.SearchRequest], + ~.SearchResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "search" not in self._stubs: + self._stubs["search"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reports.v1.ReportService/Search", + request_serializer=reports.SearchRequest.serialize, + response_deserializer=reports.SearchResponse.deserialize, + ) + return self._stubs["search"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("ReportServiceGrpcTransport",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/grpc_asyncio.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..ee169d2447c8 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/grpc_asyncio.py @@ -0,0 +1,384 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import inspect +import json +import logging as std_logging +import pickle +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, grpc_helpers_async +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +from grpc.experimental import aio # type: ignore +import proto # type: ignore + +from google.shopping.merchant_reports_v1.types import reports + +from .base import DEFAULT_CLIENT_INFO, ReportServiceTransport +from .grpc import ReportServiceGrpcTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientAIOInterceptor( + grpc.aio.UnaryUnaryClientInterceptor +): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class ReportServiceGrpcAsyncIOTransport(ReportServiceTransport): + """gRPC AsyncIO backend transport for ReportService. + + Service for retrieving reports and insights about your + products, their performance, and their competitive environment + on Google. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = ( + "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + ) + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def search( + self, + ) -> Callable[[reports.SearchRequest], Awaitable[reports.SearchResponse]]: + r"""Return a callable for the search method over gRPC. + + Retrieves a report defined by a search query. The response might + contain fewer rows than specified by ``page_size``. Rely on + ``next_page_token`` to determine if there are more rows to be + requested. + + Returns: + Callable[[~.SearchRequest], + Awaitable[~.SearchResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "search" not in self._stubs: + self._stubs["search"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reports.v1.ReportService/Search", + request_serializer=reports.SearchRequest.serialize, + response_deserializer=reports.SearchResponse.deserialize, + ) + return self._stubs["search"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.search: self._wrap_method( + self.search, + default_timeout=None, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ("ReportServiceGrpcAsyncIOTransport",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/rest.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/rest.py new file mode 100644 index 000000000000..c21b19b99144 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/rest.py @@ -0,0 +1,390 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import dataclasses +import json # type: ignore +import logging +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, rest_helpers, rest_streaming +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +import google.protobuf +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.shopping.merchant_reports_v1.types import reports + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseReportServiceRestTransport + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class ReportServiceRestInterceptor: + """Interceptor for ReportService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the ReportServiceRestTransport. + + .. code-block:: python + class MyCustomReportServiceInterceptor(ReportServiceRestInterceptor): + def pre_search(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ReportServiceRestTransport(interceptor=MyCustomReportServiceInterceptor()) + client = ReportServiceClient(transport=transport) + + + """ + + def pre_search( + self, + request: reports.SearchRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[reports.SearchRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for search + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReportService server. + """ + return request, metadata + + def post_search(self, response: reports.SearchResponse) -> reports.SearchResponse: + """Post-rpc interceptor for search + + DEPRECATED. Please use the `post_search_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReportService server but before + it is returned to user code. This `post_search` interceptor runs + before the `post_search_with_metadata` interceptor. + """ + return response + + def post_search_with_metadata( + self, + response: reports.SearchResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[reports.SearchResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for search + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReportService server but before it is returned to user code. + + We recommend only using this `post_search_with_metadata` + interceptor in new development instead of the `post_search` interceptor. + When both interceptors are used, this `post_search_with_metadata` interceptor runs after the + `post_search` interceptor. The (possibly modified) response returned by + `post_search` will be passed to + `post_search_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class ReportServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ReportServiceRestInterceptor + + +class ReportServiceRestTransport(_BaseReportServiceRestTransport): + """REST backend synchronous transport for ReportService. + + Service for retrieving reports and insights about your + products, their performance, and their competitive environment + on Google. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[ReportServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ReportServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _Search(_BaseReportServiceRestTransport._BaseSearch, ReportServiceRestStub): + def __hash__(self): + return hash("ReportServiceRestTransport.Search") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__( + self, + request: reports.SearchRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reports.SearchResponse: + r"""Call the search method over HTTP. + + Args: + request (~.reports.SearchRequest): + The request object. Request message for the ``ReportService.Search`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reports.SearchResponse: + Response message for the ``ReportService.Search`` + method. + + """ + + http_options = ( + _BaseReportServiceRestTransport._BaseSearch._get_http_options() + ) + + request, metadata = self._interceptor.pre_search(request, metadata) + transcoded_request = ( + _BaseReportServiceRestTransport._BaseSearch._get_transcoded_request( + http_options, request + ) + ) + + body = _BaseReportServiceRestTransport._BaseSearch._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = ( + _BaseReportServiceRestTransport._BaseSearch._get_query_params_json( + transcoded_request + ) + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.reports_v1.ReportServiceClient.Search", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "rpcName": "Search", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReportServiceRestTransport._Search._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = reports.SearchResponse() + pb_resp = reports.SearchResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_search(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_search_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = reports.SearchResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.reports_v1.ReportServiceClient.search", + extra={ + "serviceName": "google.shopping.merchant.reports.v1.ReportService", + "rpcName": "Search", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def search(self) -> Callable[[reports.SearchRequest], reports.SearchResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._Search(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ReportServiceRestTransport",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/rest_base.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/rest_base.py new file mode 100644 index 000000000000..5db015bc45f3 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/services/report_service/transports/rest_base.py @@ -0,0 +1,148 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format + +from google.shopping.merchant_reports_v1.types import reports + +from .base import DEFAULT_CLIENT_INFO, ReportServiceTransport + + +class _BaseReportServiceRestTransport(ReportServiceTransport): + """Base REST backend transport for ReportService. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[Any]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + class _BaseSearch: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/reports/v1/{parent=accounts/*}/reports:search", + "body": "*", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reports.SearchRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReportServiceRestTransport._BaseSearch._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__ = ("_BaseReportServiceRestTransport",) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/__init__.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/__init__.py new file mode 100644 index 000000000000..30ac22fb5efe --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/__init__.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .reports import ( + BestSellersBrandView, + BestSellersProductClusterView, + CompetitiveVisibilityBenchmarkView, + CompetitiveVisibilityCompetitorView, + CompetitiveVisibilityTopMerchantView, + MarketingMethod, + NonProductPerformanceView, + PriceCompetitivenessProductView, + PriceInsightsProductView, + ProductPerformanceView, + ProductView, + RelativeDemand, + RelativeDemandChangeType, + ReportGranularity, + ReportRow, + SearchRequest, + SearchResponse, + TrafficSource, +) + +__all__ = ( + "BestSellersBrandView", + "BestSellersProductClusterView", + "CompetitiveVisibilityBenchmarkView", + "CompetitiveVisibilityCompetitorView", + "CompetitiveVisibilityTopMerchantView", + "MarketingMethod", + "NonProductPerformanceView", + "PriceCompetitivenessProductView", + "PriceInsightsProductView", + "ProductPerformanceView", + "ProductView", + "RelativeDemand", + "RelativeDemandChangeType", + "ReportGranularity", + "ReportRow", + "SearchRequest", + "SearchResponse", + "TrafficSource", +) diff --git a/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/reports.py b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/reports.py new file mode 100644 index 000000000000..a6cfe55f5958 --- /dev/null +++ b/packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/reports.py @@ -0,0 +1,2547 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +from google.protobuf import timestamp_pb2 # type: ignore +from google.shopping.type.types import types +from google.type import date_pb2 # type: ignore +import proto # type: ignore + +__protobuf__ = proto.module( + package="google.shopping.merchant.reports.v1", + manifest={ + "SearchRequest", + "SearchResponse", + "ReportRow", + "ProductPerformanceView", + "ProductView", + "PriceCompetitivenessProductView", + "PriceInsightsProductView", + "BestSellersProductClusterView", + "BestSellersBrandView", + "NonProductPerformanceView", + "CompetitiveVisibilityCompetitorView", + "CompetitiveVisibilityTopMerchantView", + "CompetitiveVisibilityBenchmarkView", + "MarketingMethod", + "ReportGranularity", + "RelativeDemand", + "RelativeDemandChangeType", + "TrafficSource", + }, +) + + +class SearchRequest(proto.Message): + r"""Request message for the ``ReportService.Search`` method. + + Attributes: + parent (str): + Required. Id of the account making the call. + Must be a standalone account or an MCA + subaccount. Format: accounts/{account} + query (str): + Required. Query that defines a report to be retrieved. + + For details on how to construct your query, see the `Query + Language + guide `__. For + the full list of available tables and fields, see the + `Available + fields `__. + page_size (int): + Optional. Number of ``ReportRows`` to retrieve in a single + page. Defaults to 1000. Values above 5000 are coerced to + 5000. + page_token (str): + Optional. Token of the page to retrieve. If not specified, + the first page of results is returned. In order to request + the next page of results, the value obtained from + ``next_page_token`` in the previous response should be used. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + query: str = proto.Field( + proto.STRING, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchResponse(proto.Message): + r"""Response message for the ``ReportService.Search`` method. + + Attributes: + results (MutableSequence[google.shopping.merchant_reports_v1.types.ReportRow]): + Rows that matched the search query. + next_page_token (str): + Token which can be sent as ``page_token`` to retrieve the + next page. If omitted, there are no subsequent pages. + """ + + @property + def raw_page(self): + return self + + results: MutableSequence["ReportRow"] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="ReportRow", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ReportRow(proto.Message): + r"""Result row returned from the search query. + + Only the message corresponding to the queried table is populated + in the response. Within the populated message, only the fields + requested explicitly in the query are populated. + + Attributes: + product_performance_view (google.shopping.merchant_reports_v1.types.ProductPerformanceView): + Fields available for query in ``product_performance_view`` + table. + non_product_performance_view (google.shopping.merchant_reports_v1.types.NonProductPerformanceView): + Fields available for query in + ``non_product_performance_view`` table. + product_view (google.shopping.merchant_reports_v1.types.ProductView): + Fields available for query in ``product_view`` table. + price_competitiveness_product_view (google.shopping.merchant_reports_v1.types.PriceCompetitivenessProductView): + Fields available for query in + ``price_competitiveness_product_view`` table. + price_insights_product_view (google.shopping.merchant_reports_v1.types.PriceInsightsProductView): + Fields available for query in + ``price_insights_product_view`` table. + best_sellers_product_cluster_view (google.shopping.merchant_reports_v1.types.BestSellersProductClusterView): + Fields available for query in + ``best_sellers_product_cluster_view`` table. + best_sellers_brand_view (google.shopping.merchant_reports_v1.types.BestSellersBrandView): + Fields available for query in ``best_sellers_brand_view`` + table. + competitive_visibility_competitor_view (google.shopping.merchant_reports_v1.types.CompetitiveVisibilityCompetitorView): + Fields available for query in + ``competitive_visibility_competitor_view`` table. + competitive_visibility_top_merchant_view (google.shopping.merchant_reports_v1.types.CompetitiveVisibilityTopMerchantView): + Fields available for query in + ``competitive_visibility_top_merchant_view`` table. + competitive_visibility_benchmark_view (google.shopping.merchant_reports_v1.types.CompetitiveVisibilityBenchmarkView): + Fields available for query in + ``competitive_visibility_benchmark_view`` table. + """ + + product_performance_view: "ProductPerformanceView" = proto.Field( + proto.MESSAGE, + number=1, + message="ProductPerformanceView", + ) + non_product_performance_view: "NonProductPerformanceView" = proto.Field( + proto.MESSAGE, + number=7, + message="NonProductPerformanceView", + ) + product_view: "ProductView" = proto.Field( + proto.MESSAGE, + number=2, + message="ProductView", + ) + price_competitiveness_product_view: "PriceCompetitivenessProductView" = proto.Field( + proto.MESSAGE, + number=3, + message="PriceCompetitivenessProductView", + ) + price_insights_product_view: "PriceInsightsProductView" = proto.Field( + proto.MESSAGE, + number=4, + message="PriceInsightsProductView", + ) + best_sellers_product_cluster_view: "BestSellersProductClusterView" = proto.Field( + proto.MESSAGE, + number=5, + message="BestSellersProductClusterView", + ) + best_sellers_brand_view: "BestSellersBrandView" = proto.Field( + proto.MESSAGE, + number=6, + message="BestSellersBrandView", + ) + competitive_visibility_competitor_view: "CompetitiveVisibilityCompetitorView" = ( + proto.Field( + proto.MESSAGE, + number=8, + message="CompetitiveVisibilityCompetitorView", + ) + ) + competitive_visibility_top_merchant_view: "CompetitiveVisibilityTopMerchantView" = ( + proto.Field( + proto.MESSAGE, + number=9, + message="CompetitiveVisibilityTopMerchantView", + ) + ) + competitive_visibility_benchmark_view: "CompetitiveVisibilityBenchmarkView" = ( + proto.Field( + proto.MESSAGE, + number=10, + message="CompetitiveVisibilityBenchmarkView", + ) + ) + + +class ProductPerformanceView(proto.Message): + r"""Fields available for query in ``product_performance_view`` table. + + Product performance data for your account, including performance + metrics (for example, ``clicks``) and dimensions according to which + performance metrics are segmented (for example, ``offer_id``). + Values of product dimensions, such as ``offer_id``, reflect the + state of a product at the time of the impression. + + Segment fields cannot be selected in queries without also selecting + at least one metric field. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + marketing_method (google.shopping.merchant_reports_v1.types.MarketingMethod.MarketingMethodEnum): + Marketing method to which metrics apply. + Segment. + + This field is a member of `oneof`_ ``_marketing_method``. + date (google.type.date_pb2.Date): + Date in the merchant timezone to which metrics apply. + Segment. + + Condition on ``date`` is required in the ``WHERE`` clause. + week (google.type.date_pb2.Date): + First day of the week (Monday) of the metrics + date in the merchant timezone. Segment. + customer_country_code (str): + Code of the country where the customer is + located at the time of the event. Represented in + the ISO 3166 format. Segment. + + If the customer country cannot be determined, a + special 'ZZ' code is returned. + + This field is a member of `oneof`_ ``_customer_country_code``. + offer_id (str): + Merchant-provided id of the product. Segment. + + This field is a member of `oneof`_ ``_offer_id``. + title (str): + Title of the product. Segment. + + This field is a member of `oneof`_ ``_title``. + brand (str): + Brand of the product. Segment. + + This field is a member of `oneof`_ ``_brand``. + category_l1 (str): + `Product category (1st + level) `__ + in Google's product taxonomy. Segment. + + This field is a member of `oneof`_ ``_category_l1``. + category_l2 (str): + `Product category (2nd + level) `__ + in Google's product taxonomy. Segment. + + This field is a member of `oneof`_ ``_category_l2``. + category_l3 (str): + `Product category (3rd + level) `__ + in Google's product taxonomy. Segment. + + This field is a member of `oneof`_ ``_category_l3``. + category_l4 (str): + `Product category (4th + level) `__ + in Google's product taxonomy. Segment. + + This field is a member of `oneof`_ ``_category_l4``. + category_l5 (str): + `Product category (5th + level) `__ + in Google's product taxonomy. Segment. + + This field is a member of `oneof`_ ``_category_l5``. + product_type_l1 (str): + `Product type (1st + level) `__ + in merchant's own product taxonomy. Segment. + + This field is a member of `oneof`_ ``_product_type_l1``. + product_type_l2 (str): + `Product type (2nd + level) `__ + in merchant's own product taxonomy. Segment. + + This field is a member of `oneof`_ ``_product_type_l2``. + product_type_l3 (str): + `Product type (3rd + level) `__ + in merchant's own product taxonomy. Segment. + + This field is a member of `oneof`_ ``_product_type_l3``. + product_type_l4 (str): + `Product type (4th + level) `__ + in merchant's own product taxonomy. Segment. + + This field is a member of `oneof`_ ``_product_type_l4``. + product_type_l5 (str): + `Product type (5th + level) `__ + in merchant's own product taxonomy. Segment. + + This field is a member of `oneof`_ ``_product_type_l5``. + custom_label0 (str): + Custom label 0 for custom grouping of + products. Segment. + + This field is a member of `oneof`_ ``_custom_label0``. + custom_label1 (str): + Custom label 1 for custom grouping of + products. Segment. + + This field is a member of `oneof`_ ``_custom_label1``. + custom_label2 (str): + Custom label 2 for custom grouping of + products. Segment. + + This field is a member of `oneof`_ ``_custom_label2``. + custom_label3 (str): + Custom label 3 for custom grouping of + products. Segment. + + This field is a member of `oneof`_ ``_custom_label3``. + custom_label4 (str): + Custom label 4 for custom grouping of + products. Segment. + + This field is a member of `oneof`_ ``_custom_label4``. + clicks (int): + Number of clicks. Metric. + + This field is a member of `oneof`_ ``_clicks``. + impressions (int): + Number of times merchant's products are + shown. Metric. + + This field is a member of `oneof`_ ``_impressions``. + click_through_rate (float): + Click-through rate - the number of clicks + merchant's products receive (clicks) divided by + the number of times the products are shown + (impressions). Metric. + + This field is a member of `oneof`_ ``_click_through_rate``. + conversions (float): + Number of conversions attributed to the product, reported on + the conversion date. Depending on the attribution model, a + conversion might be distributed across multiple clicks, + where each click gets its own credit assigned. This metric + is a sum of all such credits. Metric. + + Available only for the ``FREE`` traffic source. + + This field is a member of `oneof`_ ``_conversions``. + conversion_value (google.shopping.type.types.Price): + Value of conversions attributed to the product, reported on + the conversion date. Metric. + + Available only for the ``FREE`` traffic source. + conversion_rate (float): + Number of conversions divided by the number of clicks, + reported on the impression date. Metric. + + Available only for the ``FREE`` traffic source. + + This field is a member of `oneof`_ ``_conversion_rate``. + """ + + marketing_method: "MarketingMethod.MarketingMethodEnum" = proto.Field( + proto.ENUM, + number=1, + optional=True, + enum="MarketingMethod.MarketingMethodEnum", + ) + date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=2, + message=date_pb2.Date, + ) + week: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=3, + message=date_pb2.Date, + ) + customer_country_code: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + offer_id: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + title: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=7, + optional=True, + ) + category_l1: str = proto.Field( + proto.STRING, + number=8, + optional=True, + ) + category_l2: str = proto.Field( + proto.STRING, + number=9, + optional=True, + ) + category_l3: str = proto.Field( + proto.STRING, + number=10, + optional=True, + ) + category_l4: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + category_l5: str = proto.Field( + proto.STRING, + number=12, + optional=True, + ) + product_type_l1: str = proto.Field( + proto.STRING, + number=13, + optional=True, + ) + product_type_l2: str = proto.Field( + proto.STRING, + number=14, + optional=True, + ) + product_type_l3: str = proto.Field( + proto.STRING, + number=15, + optional=True, + ) + product_type_l4: str = proto.Field( + proto.STRING, + number=16, + optional=True, + ) + product_type_l5: str = proto.Field( + proto.STRING, + number=17, + optional=True, + ) + custom_label0: str = proto.Field( + proto.STRING, + number=18, + optional=True, + ) + custom_label1: str = proto.Field( + proto.STRING, + number=19, + optional=True, + ) + custom_label2: str = proto.Field( + proto.STRING, + number=20, + optional=True, + ) + custom_label3: str = proto.Field( + proto.STRING, + number=21, + optional=True, + ) + custom_label4: str = proto.Field( + proto.STRING, + number=22, + optional=True, + ) + clicks: int = proto.Field( + proto.INT64, + number=23, + optional=True, + ) + impressions: int = proto.Field( + proto.INT64, + number=24, + optional=True, + ) + click_through_rate: float = proto.Field( + proto.DOUBLE, + number=25, + optional=True, + ) + conversions: float = proto.Field( + proto.DOUBLE, + number=26, + optional=True, + ) + conversion_value: types.Price = proto.Field( + proto.MESSAGE, + number=27, + message=types.Price, + ) + conversion_rate: float = proto.Field( + proto.DOUBLE, + number=28, + optional=True, + ) + + +class ProductView(proto.Message): + r"""Fields available for query in ``product_view`` table. + + Products in the current inventory. Products in this table are the + same as in Products sub-API but not all product attributes from + Products sub-API are available for query in this table. In contrast + to Products sub-API, this table allows to filter the returned list + of products by product attributes. To retrieve a single product by + ``id`` or list all products, Products sub-API should be used. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + id (str): + REST ID of the product, in the form of + ``channel~languageCode~feedLabel~offerId``. Merchant API + methods that operate on products take this as their ``name`` + parameter. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_id``. + channel (google.shopping.type.types.Channel.ChannelEnum): + Channel of the product. Can be ``ONLINE`` or ``LOCAL``. + + This field is a member of `oneof`_ ``_channel``. + language_code (str): + Language code of the product in BCP 47 + format. + + This field is a member of `oneof`_ ``_language_code``. + feed_label (str): + Feed label of the product. + + This field is a member of `oneof`_ ``_feed_label``. + offer_id (str): + Merchant-provided id of the product. + + This field is a member of `oneof`_ ``_offer_id``. + title (str): + Title of the product. + + This field is a member of `oneof`_ ``_title``. + brand (str): + Brand of the product. + + This field is a member of `oneof`_ ``_brand``. + category_l1 (str): + Product category (1st level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l1``. + category_l2 (str): + Product category (2nd level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l2``. + category_l3 (str): + Product category (3rd level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l3``. + category_l4 (str): + Product category (4th level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l4``. + category_l5 (str): + Product category (5th level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l5``. + product_type_l1 (str): + Product type (1st level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l1``. + product_type_l2 (str): + Product type (2nd level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l2``. + product_type_l3 (str): + Product type (3rd level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l3``. + product_type_l4 (str): + Product type (4th level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l4``. + product_type_l5 (str): + Product type (5th level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l5``. + price (google.shopping.type.types.Price): + Product price. Absent if the information + about the price of the product is not available. + condition (str): + `Condition `__ + of the product. + + This field is a member of `oneof`_ ``_condition``. + availability (str): + `Availability `__ + of the product. + + This field is a member of `oneof`_ ``_availability``. + shipping_label (str): + Normalized `shipping + label `__ + specified in the data source. + + This field is a member of `oneof`_ ``_shipping_label``. + gtin (MutableSequence[str]): + List of Global Trade Item Numbers (GTINs) of + the product. + item_group_id (str): + Item group id provided by the merchant for + grouping variants together. + + This field is a member of `oneof`_ ``_item_group_id``. + thumbnail_link (str): + Link to the processed image of the product, + hosted on the Google infrastructure. + + This field is a member of `oneof`_ ``_thumbnail_link``. + creation_time (google.protobuf.timestamp_pb2.Timestamp): + The time the merchant created the product in + timestamp seconds. + expiration_date (google.type.date_pb2.Date): + Expiration date for the product, specified on + insertion. + aggregated_reporting_context_status (google.shopping.merchant_reports_v1.types.ProductView.AggregatedReportingContextStatus): + Aggregated status. + + This field is a member of `oneof`_ ``_aggregated_reporting_context_status``. + item_issues (MutableSequence[google.shopping.merchant_reports_v1.types.ProductView.ItemIssue]): + List of item issues for the product. + + **This field cannot be used for sorting the results.** + + **Only selected attributes of this field (for example, + ``item_issues.severity.aggregated_severity``) can be used + for filtering the results.** + click_potential (google.shopping.merchant_reports_v1.types.ProductView.ClickPotential): + Estimated performance potential compared to + highest performing products of the merchant. + click_potential_rank (int): + Rank of the product based on its click potential. A product + with ``click_potential_rank`` 1 has the highest click + potential among the merchant's products that fulfill the + search query conditions. + + This field is a member of `oneof`_ ``_click_potential_rank``. + """ + + class AggregatedReportingContextStatus(proto.Enum): + r"""Status of the product aggregated for all reporting contexts. + + Here's an example of how the aggregated status is computed: + + ``` + Free listings \| Shopping ads \| Status + --------------|--------------|------------------------------ + Approved \| Approved \| ELIGIBLE Approved \| Pending \| ELIGIBLE + Approved \| Disapproved \| ELIGIBLE_LIMITED Pending \| Pending \| + PENDING Disapproved \| Disapproved \| NOT_ELIGIBLE_OR_DISAPPROVED + ``` + + Values: + AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED (0): + Not specified. + NOT_ELIGIBLE_OR_DISAPPROVED (1): + Product is not eligible or is disapproved for + all reporting contexts. + PENDING (2): + Product's status is pending in all reporting + contexts. + ELIGIBLE_LIMITED (3): + Product is eligible for some (but not all) + reporting contexts. + ELIGIBLE (4): + Product is eligible for all reporting + contexts. + """ + AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED = 0 + NOT_ELIGIBLE_OR_DISAPPROVED = 1 + PENDING = 2 + ELIGIBLE_LIMITED = 3 + ELIGIBLE = 4 + + class ClickPotential(proto.Enum): + r"""A product's `click + potential `__ + estimates its performance potential compared to highest performing + products of the merchant. Click potential of a product helps + merchants to prioritize which products to fix and helps them + understand how products are performing against their potential. + + Values: + CLICK_POTENTIAL_UNSPECIFIED (0): + Unknown predicted clicks impact. + LOW (1): + Potential to receive a low number of clicks + compared to the highest performing products of + the merchant. + MEDIUM (2): + Potential to receive a moderate number of + clicks compared to the highest performing + products of the merchant. + HIGH (3): + Potential to receive a similar number of + clicks as the highest performing products of the + merchant. + """ + CLICK_POTENTIAL_UNSPECIFIED = 0 + LOW = 1 + MEDIUM = 2 + HIGH = 3 + + class ItemIssue(proto.Message): + r"""Item issue associated with the product. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + type_ (google.shopping.merchant_reports_v1.types.ProductView.ItemIssue.ItemIssueType): + Item issue type. + severity (google.shopping.merchant_reports_v1.types.ProductView.ItemIssue.ItemIssueSeverity): + Item issue severity. + resolution (google.shopping.merchant_reports_v1.types.ProductView.ItemIssue.ItemIssueResolution): + Item issue resolution. + + This field is a member of `oneof`_ ``_resolution``. + """ + + class ItemIssueResolution(proto.Enum): + r"""How to resolve the issue. + + Values: + ITEM_ISSUE_RESOLUTION_UNSPECIFIED (0): + Not specified. + MERCHANT_ACTION (1): + The merchant has to fix the issue. + PENDING_PROCESSING (2): + The issue will be resolved automatically (for + example, image crawl) or through a Google + review. No merchant action is required now. + Resolution might lead to another issue (for + example, if crawl fails). + """ + ITEM_ISSUE_RESOLUTION_UNSPECIFIED = 0 + MERCHANT_ACTION = 1 + PENDING_PROCESSING = 2 + + class ItemIssueType(proto.Message): + r"""Issue type. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + code (str): + Error code of the issue, equivalent to the ``code`` of + `Product + issues `__. + + This field is a member of `oneof`_ ``_code``. + canonical_attribute (str): + Canonical attribute name for + attribute-specific issues. + + This field is a member of `oneof`_ ``_canonical_attribute``. + """ + + code: str = proto.Field( + proto.STRING, + number=1, + optional=True, + ) + canonical_attribute: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + + class ItemIssueSeverity(proto.Message): + r"""How the issue affects the serving of the product. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + severity_per_reporting_context (MutableSequence[google.shopping.merchant_reports_v1.types.ProductView.ItemIssue.ItemIssueSeverity.IssueSeverityPerReportingContext]): + Issue severity per reporting context. + aggregated_severity (google.shopping.merchant_reports_v1.types.ProductView.ItemIssue.ItemIssueSeverity.AggregatedIssueSeverity): + Aggregated severity of the issue for all reporting contexts + it affects. + + **This field can be used for filtering the results.** + + This field is a member of `oneof`_ ``_aggregated_severity``. + """ + + class AggregatedIssueSeverity(proto.Enum): + r"""Issue severity aggregated for all reporting contexts. + + Values: + AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED (0): + Not specified. + DISAPPROVED (1): + Issue disapproves the product in at least one + reporting context. + DEMOTED (2): + Issue demotes the product in all reporting + contexts it affects. + PENDING (3): + Issue resolution is ``PENDING_PROCESSING``. + """ + AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED = 0 + DISAPPROVED = 1 + DEMOTED = 2 + PENDING = 3 + + class IssueSeverityPerReportingContext(proto.Message): + r"""Issue severity per reporting context. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + reporting_context (google.shopping.type.types.ReportingContext.ReportingContextEnum): + Reporting context the issue applies to. + + This field is a member of `oneof`_ ``_reporting_context``. + disapproved_countries (MutableSequence[str]): + List of disapproved countries in the + reporting context, represented in ISO 3166 + format. + demoted_countries (MutableSequence[str]): + List of demoted countries in the reporting + context, represented in ISO 3166 format. + """ + + reporting_context: types.ReportingContext.ReportingContextEnum = ( + proto.Field( + proto.ENUM, + number=1, + optional=True, + enum=types.ReportingContext.ReportingContextEnum, + ) + ) + disapproved_countries: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + demoted_countries: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + severity_per_reporting_context: MutableSequence[ + "ProductView.ItemIssue.ItemIssueSeverity.IssueSeverityPerReportingContext" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="ProductView.ItemIssue.ItemIssueSeverity.IssueSeverityPerReportingContext", + ) + aggregated_severity: "ProductView.ItemIssue.ItemIssueSeverity.AggregatedIssueSeverity" = proto.Field( + proto.ENUM, + number=2, + optional=True, + enum="ProductView.ItemIssue.ItemIssueSeverity.AggregatedIssueSeverity", + ) + + type_: "ProductView.ItemIssue.ItemIssueType" = proto.Field( + proto.MESSAGE, + number=1, + message="ProductView.ItemIssue.ItemIssueType", + ) + severity: "ProductView.ItemIssue.ItemIssueSeverity" = proto.Field( + proto.MESSAGE, + number=2, + message="ProductView.ItemIssue.ItemIssueSeverity", + ) + resolution: "ProductView.ItemIssue.ItemIssueResolution" = proto.Field( + proto.ENUM, + number=3, + optional=True, + enum="ProductView.ItemIssue.ItemIssueResolution", + ) + + id: str = proto.Field( + proto.STRING, + number=1, + optional=True, + ) + channel: types.Channel.ChannelEnum = proto.Field( + proto.ENUM, + number=28, + optional=True, + enum=types.Channel.ChannelEnum, + ) + language_code: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + feed_label: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + offer_id: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + title: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + category_l1: str = proto.Field( + proto.STRING, + number=7, + optional=True, + ) + category_l2: str = proto.Field( + proto.STRING, + number=8, + optional=True, + ) + category_l3: str = proto.Field( + proto.STRING, + number=9, + optional=True, + ) + category_l4: str = proto.Field( + proto.STRING, + number=10, + optional=True, + ) + category_l5: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + product_type_l1: str = proto.Field( + proto.STRING, + number=12, + optional=True, + ) + product_type_l2: str = proto.Field( + proto.STRING, + number=13, + optional=True, + ) + product_type_l3: str = proto.Field( + proto.STRING, + number=14, + optional=True, + ) + product_type_l4: str = proto.Field( + proto.STRING, + number=15, + optional=True, + ) + product_type_l5: str = proto.Field( + proto.STRING, + number=16, + optional=True, + ) + price: types.Price = proto.Field( + proto.MESSAGE, + number=17, + message=types.Price, + ) + condition: str = proto.Field( + proto.STRING, + number=18, + optional=True, + ) + availability: str = proto.Field( + proto.STRING, + number=19, + optional=True, + ) + shipping_label: str = proto.Field( + proto.STRING, + number=20, + optional=True, + ) + gtin: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=21, + ) + item_group_id: str = proto.Field( + proto.STRING, + number=22, + optional=True, + ) + thumbnail_link: str = proto.Field( + proto.STRING, + number=23, + optional=True, + ) + creation_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=24, + message=timestamp_pb2.Timestamp, + ) + expiration_date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=25, + message=date_pb2.Date, + ) + aggregated_reporting_context_status: AggregatedReportingContextStatus = proto.Field( + proto.ENUM, + number=26, + optional=True, + enum=AggregatedReportingContextStatus, + ) + item_issues: MutableSequence[ItemIssue] = proto.RepeatedField( + proto.MESSAGE, + number=27, + message=ItemIssue, + ) + click_potential: ClickPotential = proto.Field( + proto.ENUM, + number=29, + enum=ClickPotential, + ) + click_potential_rank: int = proto.Field( + proto.INT64, + number=30, + optional=True, + ) + + +class PriceCompetitivenessProductView(proto.Message): + r"""Fields available for query in ``price_competitiveness_product_view`` + table. + + `Price + competitiveness `__ + report. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + report_country_code (str): + Country of the price benchmark. Represented in the ISO 3166 + format. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_report_country_code``. + id (str): + REST ID of the product, in the form of + ``channel~languageCode~feedLabel~offerId``. Can be used to + join data with the ``product_view`` table. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_id``. + offer_id (str): + Merchant-provided id of the product. + + This field is a member of `oneof`_ ``_offer_id``. + title (str): + Title of the product. + + This field is a member of `oneof`_ ``_title``. + brand (str): + Brand of the product. + + This field is a member of `oneof`_ ``_brand``. + category_l1 (str): + Product category (1st level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l1``. + category_l2 (str): + Product category (2nd level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l2``. + category_l3 (str): + Product category (3rd level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l3``. + category_l4 (str): + Product category (4th level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l4``. + category_l5 (str): + Product category (5th level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l5``. + product_type_l1 (str): + Product type (1st level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l1``. + product_type_l2 (str): + Product type (2nd level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l2``. + product_type_l3 (str): + Product type (3rd level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l3``. + product_type_l4 (str): + Product type (4th level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l4``. + product_type_l5 (str): + Product type (5th level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l5``. + price (google.shopping.type.types.Price): + Current price of the product. + benchmark_price (google.shopping.type.types.Price): + Latest available price benchmark for the + product's catalog in the benchmark country. + """ + + report_country_code: str = proto.Field( + proto.STRING, + number=1, + optional=True, + ) + id: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + offer_id: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + title: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + category_l1: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + category_l2: str = proto.Field( + proto.STRING, + number=7, + optional=True, + ) + category_l3: str = proto.Field( + proto.STRING, + number=8, + optional=True, + ) + category_l4: str = proto.Field( + proto.STRING, + number=9, + optional=True, + ) + category_l5: str = proto.Field( + proto.STRING, + number=10, + optional=True, + ) + product_type_l1: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + product_type_l2: str = proto.Field( + proto.STRING, + number=12, + optional=True, + ) + product_type_l3: str = proto.Field( + proto.STRING, + number=13, + optional=True, + ) + product_type_l4: str = proto.Field( + proto.STRING, + number=14, + optional=True, + ) + product_type_l5: str = proto.Field( + proto.STRING, + number=15, + optional=True, + ) + price: types.Price = proto.Field( + proto.MESSAGE, + number=16, + message=types.Price, + ) + benchmark_price: types.Price = proto.Field( + proto.MESSAGE, + number=17, + message=types.Price, + ) + + +class PriceInsightsProductView(proto.Message): + r"""Fields available for query in ``price_insights_product_view`` table. + + `Price + insights `__ + report. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + id (str): + REST ID of the product, in the form of + ``channel~languageCode~feedLabel~offerId``. Can be used to + join data with the ``product_view`` table. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_id``. + offer_id (str): + Merchant-provided id of the product. + + This field is a member of `oneof`_ ``_offer_id``. + title (str): + Title of the product. + + This field is a member of `oneof`_ ``_title``. + brand (str): + Brand of the product. + + This field is a member of `oneof`_ ``_brand``. + category_l1 (str): + Product category (1st level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l1``. + category_l2 (str): + Product category (2nd level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l2``. + category_l3 (str): + Product category (3rd level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l3``. + category_l4 (str): + Product category (4th level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l4``. + category_l5 (str): + Product category (5th level) in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l5``. + product_type_l1 (str): + Product type (1st level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l1``. + product_type_l2 (str): + Product type (2nd level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l2``. + product_type_l3 (str): + Product type (3rd level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l3``. + product_type_l4 (str): + Product type (4th level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l4``. + product_type_l5 (str): + Product type (5th level) in merchant's own `product + taxonomy `__. + + This field is a member of `oneof`_ ``_product_type_l5``. + price (google.shopping.type.types.Price): + Current price of the product. + suggested_price (google.shopping.type.types.Price): + Latest suggested price for the product. + predicted_impressions_change_fraction (float): + Predicted change in impressions as a fraction + after introducing the suggested price compared + to current active price. For example, 0.05 is a + 5% predicted increase in impressions. + + This field is a member of `oneof`_ ``_predicted_impressions_change_fraction``. + predicted_clicks_change_fraction (float): + Predicted change in clicks as a fraction + after introducing the suggested price compared + to current active price. For example, 0.05 is a + 5% predicted increase in clicks. + + This field is a member of `oneof`_ ``_predicted_clicks_change_fraction``. + predicted_conversions_change_fraction (float): + Predicted change in conversions as a fraction + after introducing the suggested price compared + to current active price. For example, 0.05 is a + 5% predicted increase in conversions). + + This field is a member of `oneof`_ ``_predicted_conversions_change_fraction``. + effectiveness (google.shopping.merchant_reports_v1.types.PriceInsightsProductView.Effectiveness): + The predicted effectiveness of applying the + price suggestion, bucketed. + """ + + class Effectiveness(proto.Enum): + r"""Predicted effectiveness bucket. + + Effectiveness indicates which products would benefit most from price + changes. This rating takes into consideration the performance boost + predicted by adjusting the sale price and the difference between + your current price and the suggested price. Price suggestions with + ``HIGH`` effectiveness are predicted to drive the largest increase + in performance. + + Values: + EFFECTIVENESS_UNSPECIFIED (0): + Effectiveness is unknown. + LOW (1): + Effectiveness is low. + MEDIUM (2): + Effectiveness is medium. + HIGH (3): + Effectiveness is high. + """ + EFFECTIVENESS_UNSPECIFIED = 0 + LOW = 1 + MEDIUM = 2 + HIGH = 3 + + id: str = proto.Field( + proto.STRING, + number=1, + optional=True, + ) + offer_id: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + title: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + category_l1: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + category_l2: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + category_l3: str = proto.Field( + proto.STRING, + number=7, + optional=True, + ) + category_l4: str = proto.Field( + proto.STRING, + number=8, + optional=True, + ) + category_l5: str = proto.Field( + proto.STRING, + number=9, + optional=True, + ) + product_type_l1: str = proto.Field( + proto.STRING, + number=10, + optional=True, + ) + product_type_l2: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + product_type_l3: str = proto.Field( + proto.STRING, + number=12, + optional=True, + ) + product_type_l4: str = proto.Field( + proto.STRING, + number=13, + optional=True, + ) + product_type_l5: str = proto.Field( + proto.STRING, + number=14, + optional=True, + ) + price: types.Price = proto.Field( + proto.MESSAGE, + number=15, + message=types.Price, + ) + suggested_price: types.Price = proto.Field( + proto.MESSAGE, + number=16, + message=types.Price, + ) + predicted_impressions_change_fraction: float = proto.Field( + proto.DOUBLE, + number=17, + optional=True, + ) + predicted_clicks_change_fraction: float = proto.Field( + proto.DOUBLE, + number=18, + optional=True, + ) + predicted_conversions_change_fraction: float = proto.Field( + proto.DOUBLE, + number=19, + optional=True, + ) + effectiveness: Effectiveness = proto.Field( + proto.ENUM, + number=22, + enum=Effectiveness, + ) + + +class BestSellersProductClusterView(proto.Message): + r"""Fields available for query in ``best_sellers_product_cluster_view`` + table. + + `Best + sellers `__ + report with top product clusters. A product cluster is a grouping + for different offers and variants that represent the same product, + for example, Google Pixel 7. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + report_date (google.type.date_pb2.Date): + Report date. The value of this field can only be one of the + following: + + - The first day of the week (Monday) for weekly reports, + - The first day of the month for monthly reports. + + Required in the ``SELECT`` clause. If a ``WHERE`` condition + on ``report_date`` is not specified in the query, the latest + available weekly or monthly report is returned. + report_granularity (google.shopping.merchant_reports_v1.types.ReportGranularity.ReportGranularityEnum): + Granularity of the report. The ranking can be done over a + week or a month timeframe. + + Required in the ``SELECT`` clause. Condition on + ``report_granularity`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_granularity``. + report_country_code (str): + Country where the ranking is calculated. Represented in the + ISO 3166 format. + + Required in the ``SELECT`` clause. Condition on + ``report_country_code`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_country_code``. + report_category_id (int): + Google product category ID to calculate the ranking for, + represented in `Google's product + taxonomy `__. + + Required in the ``SELECT`` clause. If a ``WHERE`` condition + on ``report_category_id`` is not specified in the query, + rankings for all top-level categories are returned. + + This field is a member of `oneof`_ ``_report_category_id``. + title (str): + Title of the product cluster. + + This field is a member of `oneof`_ ``_title``. + brand (str): + Brand of the product cluster. + + This field is a member of `oneof`_ ``_brand``. + category_l1 (str): + Product category (1st level) of the product cluster, + represented in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l1``. + category_l2 (str): + Product category (2nd level) of the product cluster, + represented in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l2``. + category_l3 (str): + Product category (3rd level) of the product cluster, + represented in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l3``. + category_l4 (str): + Product category (4th level) of the product cluster, + represented in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l4``. + category_l5 (str): + Product category (5th level) of the product cluster, + represented in `Google's product + taxonomy `__. + + This field is a member of `oneof`_ ``_category_l5``. + variant_gtins (MutableSequence[str]): + GTINs of example variants of the product + cluster. + inventory_status (google.shopping.merchant_reports_v1.types.BestSellersProductClusterView.InventoryStatus): + Whether the product cluster is ``IN_STOCK`` in your product + data source in at least one of the countries, + ``OUT_OF_STOCK`` in your product data source in all + countries, or ``NOT_IN_INVENTORY`` at all. + + The field doesn't take the Best sellers report country + filter into account. + + This field is a member of `oneof`_ ``_inventory_status``. + brand_inventory_status (google.shopping.merchant_reports_v1.types.BestSellersProductClusterView.InventoryStatus): + Whether there is at least one product of the brand currently + ``IN_STOCK`` in your product data source in at least one of + the countries, all products are ``OUT_OF_STOCK`` in your + product data source in all countries, or + ``NOT_IN_INVENTORY``. + + The field doesn't take the Best sellers report country + filter into account. + + This field is a member of `oneof`_ ``_brand_inventory_status``. + rank (int): + Popularity of the product cluster on Ads and + organic surfaces, in the selected category and + country, based on the estimated number of units + sold. + + This field is a member of `oneof`_ ``_rank``. + previous_rank (int): + Popularity rank in the previous week or + month. + + This field is a member of `oneof`_ ``_previous_rank``. + relative_demand (google.shopping.merchant_reports_v1.types.RelativeDemand.RelativeDemandEnum): + Estimated demand in relation to the product + cluster with the highest popularity rank in the + same category and country. + + This field is a member of `oneof`_ ``_relative_demand``. + previous_relative_demand (google.shopping.merchant_reports_v1.types.RelativeDemand.RelativeDemandEnum): + Estimated demand in relation to the product + cluster with the highest popularity rank in the + same category and country in the previous week + or month. + + This field is a member of `oneof`_ ``_previous_relative_demand``. + relative_demand_change (google.shopping.merchant_reports_v1.types.RelativeDemandChangeType.RelativeDemandChangeTypeEnum): + Change in the estimated demand. Whether it + rose, sank or remained flat. + + This field is a member of `oneof`_ ``_relative_demand_change``. + """ + + class InventoryStatus(proto.Enum): + r"""Status of the product cluster or brand in your inventory. + + Values: + INVENTORY_STATUS_UNSPECIFIED (0): + Not specified. + IN_STOCK (1): + You have a product for this product cluster + or brand in stock. + OUT_OF_STOCK (2): + You have a product for this product cluster + or brand in inventory but it is currently out of + stock. + NOT_IN_INVENTORY (3): + You do not have a product for this product + cluster or brand in inventory. + """ + INVENTORY_STATUS_UNSPECIFIED = 0 + IN_STOCK = 1 + OUT_OF_STOCK = 2 + NOT_IN_INVENTORY = 3 + + report_date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=1, + message=date_pb2.Date, + ) + report_granularity: "ReportGranularity.ReportGranularityEnum" = proto.Field( + proto.ENUM, + number=2, + optional=True, + enum="ReportGranularity.ReportGranularityEnum", + ) + report_country_code: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + report_category_id: int = proto.Field( + proto.INT64, + number=4, + optional=True, + ) + title: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=7, + optional=True, + ) + category_l1: str = proto.Field( + proto.STRING, + number=8, + optional=True, + ) + category_l2: str = proto.Field( + proto.STRING, + number=9, + optional=True, + ) + category_l3: str = proto.Field( + proto.STRING, + number=10, + optional=True, + ) + category_l4: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + category_l5: str = proto.Field( + proto.STRING, + number=12, + optional=True, + ) + variant_gtins: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=13, + ) + inventory_status: InventoryStatus = proto.Field( + proto.ENUM, + number=14, + optional=True, + enum=InventoryStatus, + ) + brand_inventory_status: InventoryStatus = proto.Field( + proto.ENUM, + number=15, + optional=True, + enum=InventoryStatus, + ) + rank: int = proto.Field( + proto.INT64, + number=16, + optional=True, + ) + previous_rank: int = proto.Field( + proto.INT64, + number=17, + optional=True, + ) + relative_demand: "RelativeDemand.RelativeDemandEnum" = proto.Field( + proto.ENUM, + number=18, + optional=True, + enum="RelativeDemand.RelativeDemandEnum", + ) + previous_relative_demand: "RelativeDemand.RelativeDemandEnum" = proto.Field( + proto.ENUM, + number=19, + optional=True, + enum="RelativeDemand.RelativeDemandEnum", + ) + relative_demand_change: "RelativeDemandChangeType.RelativeDemandChangeTypeEnum" = ( + proto.Field( + proto.ENUM, + number=20, + optional=True, + enum="RelativeDemandChangeType.RelativeDemandChangeTypeEnum", + ) + ) + + +class BestSellersBrandView(proto.Message): + r"""Fields available for query in ``best_sellers_brand_view`` table. + + `Best + sellers `__ + report with top brands. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + report_date (google.type.date_pb2.Date): + Report date. The value of this field can only be one of the + following: + + - The first day of the week (Monday) for weekly reports, + - The first day of the month for monthly reports. + + Required in the ``SELECT`` clause. If a ``WHERE`` condition + on ``report_date`` is not specified in the query, the latest + available weekly or monthly report is returned. + report_granularity (google.shopping.merchant_reports_v1.types.ReportGranularity.ReportGranularityEnum): + Granularity of the report. The ranking can be done over a + week or a month timeframe. + + Required in the ``SELECT`` clause. Condition on + ``report_granularity`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_granularity``. + report_country_code (str): + Country where the ranking is calculated. Represented in the + ISO 3166 format. + + Required in the ``SELECT`` clause. Condition on + ``report_country_code`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_country_code``. + report_category_id (int): + Google product category ID to calculate the ranking for, + represented in `Google's product + taxonomy `__. + + Required in the ``SELECT`` clause. If a ``WHERE`` condition + on ``report_category_id`` is not specified in the query, + rankings for all top-level categories are returned. + + This field is a member of `oneof`_ ``_report_category_id``. + brand (str): + Name of the brand. + + This field is a member of `oneof`_ ``_brand``. + rank (int): + Popularity of the brand on Ads and organic + surfaces, in the selected category and country, + based on the estimated number of units sold. + + This field is a member of `oneof`_ ``_rank``. + previous_rank (int): + Popularity rank in the previous week or + month. + + This field is a member of `oneof`_ ``_previous_rank``. + relative_demand (google.shopping.merchant_reports_v1.types.RelativeDemand.RelativeDemandEnum): + Estimated demand in relation to the brand + with the highest popularity rank in the same + category and country. + + This field is a member of `oneof`_ ``_relative_demand``. + previous_relative_demand (google.shopping.merchant_reports_v1.types.RelativeDemand.RelativeDemandEnum): + Estimated demand in relation to the brand + with the highest popularity rank in the same + category and country in the previous week or + month. + + This field is a member of `oneof`_ ``_previous_relative_demand``. + relative_demand_change (google.shopping.merchant_reports_v1.types.RelativeDemandChangeType.RelativeDemandChangeTypeEnum): + Change in the estimated demand. Whether it + rose, sank or remained flat. + + This field is a member of `oneof`_ ``_relative_demand_change``. + """ + + report_date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=1, + message=date_pb2.Date, + ) + report_granularity: "ReportGranularity.ReportGranularityEnum" = proto.Field( + proto.ENUM, + number=2, + optional=True, + enum="ReportGranularity.ReportGranularityEnum", + ) + report_country_code: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + report_category_id: int = proto.Field( + proto.INT64, + number=4, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + rank: int = proto.Field( + proto.INT64, + number=7, + optional=True, + ) + previous_rank: int = proto.Field( + proto.INT64, + number=8, + optional=True, + ) + relative_demand: "RelativeDemand.RelativeDemandEnum" = proto.Field( + proto.ENUM, + number=9, + optional=True, + enum="RelativeDemand.RelativeDemandEnum", + ) + previous_relative_demand: "RelativeDemand.RelativeDemandEnum" = proto.Field( + proto.ENUM, + number=10, + optional=True, + enum="RelativeDemand.RelativeDemandEnum", + ) + relative_demand_change: "RelativeDemandChangeType.RelativeDemandChangeTypeEnum" = ( + proto.Field( + proto.ENUM, + number=11, + optional=True, + enum="RelativeDemandChangeType.RelativeDemandChangeTypeEnum", + ) + ) + + +class NonProductPerformanceView(proto.Message): + r"""Fields available for query in ``non_product_performance_view`` + table. + + Performance data on images and online store links leading to your + non-product pages. This includes performance metrics (for example, + ``clicks``) and dimensions according to which performance metrics + are segmented (for example, ``date``). + + Segment fields cannot be selected in queries without also selecting + at least one metric field. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + date (google.type.date_pb2.Date): + Date in the merchant timezone to which metrics apply. + Segment. + + Condition on ``date`` is required in the ``WHERE`` clause. + week (google.type.date_pb2.Date): + First day of the week (Monday) of the metrics + date in the merchant timezone. Segment. + clicks (int): + Number of clicks on images and online store + links leading to your non-product pages. Metric. + + This field is a member of `oneof`_ ``_clicks``. + impressions (int): + Number of times images and online store links + leading to your non-product pages were shown. + Metric. + + This field is a member of `oneof`_ ``_impressions``. + click_through_rate (float): + Click-through rate - the number of clicks (``clicks``) + divided by the number of impressions (``impressions``) of + images and online store links leading to your non-product + pages. Metric. + + This field is a member of `oneof`_ ``_click_through_rate``. + """ + + date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=1, + message=date_pb2.Date, + ) + week: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=2, + message=date_pb2.Date, + ) + clicks: int = proto.Field( + proto.INT64, + number=3, + optional=True, + ) + impressions: int = proto.Field( + proto.INT64, + number=4, + optional=True, + ) + click_through_rate: float = proto.Field( + proto.DOUBLE, + number=5, + optional=True, + ) + + +class CompetitiveVisibilityCompetitorView(proto.Message): + r"""Fields available for query in + ``competitive_visibility_competitor_view`` table. + + `Competitive + visibility `__ + report with businesses with similar visibility. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + date (google.type.date_pb2.Date): + Date of this row. + + A condition on ``date`` is required in the ``WHERE`` clause. + domain (str): + Domain of your competitor or your domain, if + 'is_your_domain' is true. + + Required in the ``SELECT`` clause. Cannot be filtered on in + the 'WHERE' clause. + + This field is a member of `oneof`_ ``_domain``. + is_your_domain (bool): + True if this row contains data for your + domain. + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_is_your_domain``. + report_country_code (str): + Country where impressions appeared. + + Required in the ``SELECT`` clause. A condition on + ``report_country_code`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_country_code``. + report_category_id (int): + Google product category ID to calculate the report for, + represented in `Google's product + taxonomy `__. + + Required in the ``SELECT`` clause. A condition on + ``report_category_id`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_category_id``. + traffic_source (google.shopping.merchant_reports_v1.types.TrafficSource.TrafficSourceEnum): + Traffic source of impressions. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_traffic_source``. + rank (int): + Position of the domain in the similar businesses ranking for + the selected keys (``date``, ``report_category_id``, + ``report_country_code``, ``traffic_source``) based on + impressions. 1 is the highest. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_rank``. + ads_organic_ratio (float): + [Ads / organic ratio] + (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio) + shows how often the domain receives impressions from + Shopping ads compared to organic traffic. The number is + rounded and bucketed. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_ads_organic_ratio``. + page_overlap_rate (float): + [Page overlap rate] + (https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-overlap-rate) + shows how frequently competing retailers’ offers are shown + together with your offers on the same page. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_page_overlap_rate``. + higher_position_rate (float): + [Higher position rate] + (https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-position-rate) + shows how often a competitor’s offer got placed in a higher + position on the page than your offer. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_higher_position_rate``. + relative_visibility (float): + [Relative visibility] + (https://support.google.com/merchants/answer/11366442#zippy=%2Crelative-visibility) + shows how often your competitors’ offers are shown compared + to your offers. In other words, this is the number of + displayed impressions of a competitor retailer divided by + the number of your displayed impressions during a selected + time range for a selected product category and country. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_relative_visibility``. + """ + + date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=1, + message=date_pb2.Date, + ) + domain: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + is_your_domain: bool = proto.Field( + proto.BOOL, + number=3, + optional=True, + ) + report_country_code: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + report_category_id: int = proto.Field( + proto.INT64, + number=5, + optional=True, + ) + traffic_source: "TrafficSource.TrafficSourceEnum" = proto.Field( + proto.ENUM, + number=6, + optional=True, + enum="TrafficSource.TrafficSourceEnum", + ) + rank: int = proto.Field( + proto.INT64, + number=7, + optional=True, + ) + ads_organic_ratio: float = proto.Field( + proto.DOUBLE, + number=8, + optional=True, + ) + page_overlap_rate: float = proto.Field( + proto.DOUBLE, + number=9, + optional=True, + ) + higher_position_rate: float = proto.Field( + proto.DOUBLE, + number=10, + optional=True, + ) + relative_visibility: float = proto.Field( + proto.DOUBLE, + number=11, + optional=True, + ) + + +class CompetitiveVisibilityTopMerchantView(proto.Message): + r"""Fields available for query in + ``competitive_visibility_top_merchant_view`` table. + + `Competitive + visibility `__ + report with business with highest visibility. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + date (google.type.date_pb2.Date): + Date of this row. + + Cannot be selected in the ``SELECT`` clause. A condition on + ``date`` is required in the ``WHERE`` clause. + domain (str): + Domain of your competitor or your domain, if + 'is_your_domain' is true. + + Required in the ``SELECT`` clause. Cannot be filtered on in + the 'WHERE' clause. + + This field is a member of `oneof`_ ``_domain``. + is_your_domain (bool): + True if this row contains data for your + domain. + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_is_your_domain``. + report_country_code (str): + Country where impressions appeared. + + Required in the ``SELECT`` clause. A condition on + ``report_country_code`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_country_code``. + report_category_id (int): + Google product category ID to calculate the report for, + represented in `Google's product + taxonomy `__. + + Required in the ``SELECT`` clause. A condition on + ``report_category_id`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_category_id``. + traffic_source (google.shopping.merchant_reports_v1.types.TrafficSource.TrafficSourceEnum): + Traffic source of impressions. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_traffic_source``. + rank (int): + Position of the domain in the top merchants ranking for the + selected keys (``date``, ``report_category_id``, + ``report_country_code``, ``traffic_source``) based on + impressions. 1 is the highest. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_rank``. + ads_organic_ratio (float): + [Ads / organic ratio] + (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio) + shows how often the domain receives impressions from + Shopping ads compared to organic traffic. The number is + rounded and bucketed. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_ads_organic_ratio``. + page_overlap_rate (float): + [Page overlap rate] + (https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-overlap-rate) + shows how frequently competing retailers’ offers are shown + together with your offers on the same page. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_page_overlap_rate``. + higher_position_rate (float): + [Higher position rate] + (https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-position-rate) + shows how often a competitor’s offer got placed in a higher + position on the page than your offer. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_higher_position_rate``. + """ + + date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=1, + message=date_pb2.Date, + ) + domain: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + is_your_domain: bool = proto.Field( + proto.BOOL, + number=3, + optional=True, + ) + report_country_code: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + report_category_id: int = proto.Field( + proto.INT64, + number=5, + optional=True, + ) + traffic_source: "TrafficSource.TrafficSourceEnum" = proto.Field( + proto.ENUM, + number=6, + optional=True, + enum="TrafficSource.TrafficSourceEnum", + ) + rank: int = proto.Field( + proto.INT64, + number=7, + optional=True, + ) + ads_organic_ratio: float = proto.Field( + proto.DOUBLE, + number=8, + optional=True, + ) + page_overlap_rate: float = proto.Field( + proto.DOUBLE, + number=9, + optional=True, + ) + higher_position_rate: float = proto.Field( + proto.DOUBLE, + number=10, + optional=True, + ) + + +class CompetitiveVisibilityBenchmarkView(proto.Message): + r"""Fields available for query in + ``competitive_visibility_benchmark_view`` table. + + `Competitive + visibility `__ + report with the category benchmark. + + Values are only set for fields requested explicitly in the request's + search query. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + date (google.type.date_pb2.Date): + Date of this row. + + Required in the ``SELECT`` clause. A condition on ``date`` + is required in the ``WHERE`` clause. + report_country_code (str): + Country where impressions appeared. + + Required in the ``SELECT`` clause. A condition on + ``report_country_code`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_country_code``. + report_category_id (int): + Google product category ID to calculate the report for, + represented in `Google's product + taxonomy `__. + + Required in the ``SELECT`` clause. A condition on + ``report_category_id`` is required in the ``WHERE`` clause. + + This field is a member of `oneof`_ ``_report_category_id``. + traffic_source (google.shopping.merchant_reports_v1.types.TrafficSource.TrafficSourceEnum): + Traffic source of impressions. + + Required in the ``SELECT`` clause. + + This field is a member of `oneof`_ ``_traffic_source``. + your_domain_visibility_trend (float): + Change in visibility based on impressions for + your domain with respect to the start of the + selected time range (or first day with non-zero + impressions). + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_your_domain_visibility_trend``. + category_benchmark_visibility_trend (float): + Change in visibility based on impressions + with respect to the start of the selected time + range (or first day with non-zero impressions) + for a combined set of merchants with highest + visibility approximating the market. + + Cannot be filtered on in the 'WHERE' clause. + + This field is a member of `oneof`_ ``_category_benchmark_visibility_trend``. + """ + + date: date_pb2.Date = proto.Field( + proto.MESSAGE, + number=1, + message=date_pb2.Date, + ) + report_country_code: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + report_category_id: int = proto.Field( + proto.INT64, + number=3, + optional=True, + ) + traffic_source: "TrafficSource.TrafficSourceEnum" = proto.Field( + proto.ENUM, + number=4, + optional=True, + enum="TrafficSource.TrafficSourceEnum", + ) + your_domain_visibility_trend: float = proto.Field( + proto.DOUBLE, + number=5, + optional=True, + ) + category_benchmark_visibility_trend: float = proto.Field( + proto.DOUBLE, + number=6, + optional=True, + ) + + +class MarketingMethod(proto.Message): + r"""Marketing method used to promote your products on Google + (organic versus ads). + + """ + + class MarketingMethodEnum(proto.Enum): + r"""Marketing method values. + + Values: + MARKETING_METHOD_ENUM_UNSPECIFIED (0): + Not specified. + ORGANIC (1): + Organic marketing. + ADS (2): + Ads-based marketing. + """ + MARKETING_METHOD_ENUM_UNSPECIFIED = 0 + ORGANIC = 1 + ADS = 2 + + +class ReportGranularity(proto.Message): + r"""Granularity of the Best sellers report. Best sellers reports + are computed over a week and a month timeframe. + + """ + + class ReportGranularityEnum(proto.Enum): + r"""Report granularity values. + + Values: + REPORT_GRANULARITY_ENUM_UNSPECIFIED (0): + Not specified. + WEEKLY (1): + Report is computed over a week timeframe. + MONTHLY (2): + Report is computed over a month timeframe. + """ + REPORT_GRANULARITY_ENUM_UNSPECIFIED = 0 + WEEKLY = 1 + MONTHLY = 2 + + +class RelativeDemand(proto.Message): + r"""Relative demand of a product cluster or brand in the Best + sellers report. + + """ + + class RelativeDemandEnum(proto.Enum): + r"""Relative demand values. + + Values: + RELATIVE_DEMAND_ENUM_UNSPECIFIED (0): + Not specified. + VERY_LOW (10): + Demand is 0-5% of the demand of the highest + ranked product cluster or brand. + LOW (20): + Demand is 6-10% of the demand of the highest + ranked product cluster or brand. + MEDIUM (30): + Demand is 11-20% of the demand of the highest + ranked product cluster or brand. + HIGH (40): + Demand is 21-50% of the demand of the highest + ranked product cluster or brand. + VERY_HIGH (50): + Demand is 51-100% of the demand of the + highest ranked product cluster or brand. + """ + RELATIVE_DEMAND_ENUM_UNSPECIFIED = 0 + VERY_LOW = 10 + LOW = 20 + MEDIUM = 30 + HIGH = 40 + VERY_HIGH = 50 + + +class RelativeDemandChangeType(proto.Message): + r"""Relative demand of a product cluster or brand in the Best + sellers report compared to the previous time period. + + """ + + class RelativeDemandChangeTypeEnum(proto.Enum): + r"""Relative demand change type values. + + Values: + RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED (0): + Not specified. + SINKER (1): + Relative demand is lower than the previous + time period. + FLAT (2): + Relative demand is equal to the previous time + period. + RISER (3): + Relative demand is higher than the previous + time period. + """ + RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED = 0 + SINKER = 1 + FLAT = 2 + RISER = 3 + + +class TrafficSource(proto.Message): + r"""Traffic source of impressions in the Competitive visibility + report. + + """ + + class TrafficSourceEnum(proto.Enum): + r"""Traffic source values. + + Values: + TRAFFIC_SOURCE_ENUM_UNSPECIFIED (0): + Not specified. + ORGANIC (1): + Organic traffic. + ADS (2): + Traffic from ads. + ALL (3): + Organic and ads traffic. + """ + TRAFFIC_SOURCE_ENUM_UNSPECIFIED = 0 + ORGANIC = 1 + ADS = 2 + ALL = 3 + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-shopping-merchant-reports/samples/generated_samples/merchantapi_v1_generated_report_service_search_async.py b/packages/google-shopping-merchant-reports/samples/generated_samples/merchantapi_v1_generated_report_service_search_async.py new file mode 100644 index 000000000000..c6b478f7bab0 --- /dev/null +++ b/packages/google-shopping-merchant-reports/samples/generated_samples/merchantapi_v1_generated_report_service_search_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Search +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-reports + + +# [START merchantapi_v1_generated_ReportService_Search_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_reports_v1 + + +async def sample_search(): + # Create a client + client = merchant_reports_v1.ReportServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reports_v1.SearchRequest( + parent="parent_value", + query="query_value", + ) + + # Make the request + page_result = client.search(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END merchantapi_v1_generated_ReportService_Search_async] diff --git a/packages/google-shopping-merchant-reports/samples/generated_samples/merchantapi_v1_generated_report_service_search_sync.py b/packages/google-shopping-merchant-reports/samples/generated_samples/merchantapi_v1_generated_report_service_search_sync.py new file mode 100644 index 000000000000..6a62182505b2 --- /dev/null +++ b/packages/google-shopping-merchant-reports/samples/generated_samples/merchantapi_v1_generated_report_service_search_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Search +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-reports + + +# [START merchantapi_v1_generated_ReportService_Search_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_reports_v1 + + +def sample_search(): + # Create a client + client = merchant_reports_v1.ReportServiceClient() + + # Initialize request argument(s) + request = merchant_reports_v1.SearchRequest( + parent="parent_value", + query="query_value", + ) + + # Make the request + page_result = client.search(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END merchantapi_v1_generated_ReportService_Search_sync] diff --git a/packages/google-shopping-merchant-reports/samples/generated_samples/snippet_metadata_google.shopping.merchant.reports.v1.json b/packages/google-shopping-merchant-reports/samples/generated_samples/snippet_metadata_google.shopping.merchant.reports.v1.json new file mode 100644 index 000000000000..65c12618cd02 --- /dev/null +++ b/packages/google-shopping-merchant-reports/samples/generated_samples/snippet_metadata_google.shopping.merchant.reports.v1.json @@ -0,0 +1,176 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.shopping.merchant.reports.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-shopping-merchant-reports", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_reports_v1.ReportServiceAsyncClient", + "shortName": "ReportServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_reports_v1.ReportServiceAsyncClient.search", + "method": { + "fullName": "google.shopping.merchant.reports.v1.ReportService.Search", + "service": { + "fullName": "google.shopping.merchant.reports.v1.ReportService", + "shortName": "ReportService" + }, + "shortName": "Search" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reports_v1.types.SearchRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_reports_v1.services.report_service.pagers.SearchAsyncPager", + "shortName": "search" + }, + "description": "Sample for Search", + "file": "merchantapi_v1_generated_report_service_search_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ReportService_Search_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_report_service_search_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_reports_v1.ReportServiceClient", + "shortName": "ReportServiceClient" + }, + "fullName": "google.shopping.merchant_reports_v1.ReportServiceClient.search", + "method": { + "fullName": "google.shopping.merchant.reports.v1.ReportService.Search", + "service": { + "fullName": "google.shopping.merchant.reports.v1.ReportService", + "shortName": "ReportService" + }, + "shortName": "Search" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reports_v1.types.SearchRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_reports_v1.services.report_service.pagers.SearchPager", + "shortName": "search" + }, + "description": "Sample for Search", + "file": "merchantapi_v1_generated_report_service_search_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ReportService_Search_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_report_service_search_sync.py" + } + ] +} diff --git a/packages/google-shopping-merchant-reports/scripts/fixup_merchant_reports_v1_keywords.py b/packages/google-shopping-merchant-reports/scripts/fixup_merchant_reports_v1_keywords.py new file mode 100644 index 000000000000..6977b0864793 --- /dev/null +++ b/packages/google-shopping-merchant-reports/scripts/fixup_merchant_reports_v1_keywords.py @@ -0,0 +1,176 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class merchant_reportsCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'search': ('parent', 'query', 'page_size', 'page_token', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=merchant_reportsCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the merchant_reports client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/packages/google-shopping-merchant-reports/tests/unit/gapic/merchant_reports_v1/__init__.py b/packages/google-shopping-merchant-reports/tests/unit/gapic/merchant_reports_v1/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/packages/google-shopping-merchant-reports/tests/unit/gapic/merchant_reports_v1/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/packages/google-shopping-merchant-reports/tests/unit/gapic/merchant_reports_v1/test_report_service.py b/packages/google-shopping-merchant-reports/tests/unit/gapic/merchant_reports_v1/test_report_service.py new file mode 100644 index 000000000000..5f2c93e15c8b --- /dev/null +++ b/packages/google-shopping-merchant-reports/tests/unit/gapic/merchant_reports_v1/test_report_service.py @@ -0,0 +1,2829 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os + +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +from collections.abc import AsyncIterable, Iterable +import json +import math + +from google.api_core import api_core_version +from google.protobuf import json_format +import grpc +from grpc.experimental import aio +from proto.marshal.rules import wrappers +from proto.marshal.rules.dates import DurationRule, TimestampRule +import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session + +try: + from google.auth.aio import credentials as ga_credentials_async + + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +import google.auth +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account + +from google.shopping.merchant_reports_v1.services.report_service import ( + ReportServiceAsyncClient, + ReportServiceClient, + pagers, + transports, +) +from google.shopping.merchant_reports_v1.types import reports + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return ( + "test.{UNIVERSE_DOMAIN}" + if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) + else client._DEFAULT_ENDPOINT_TEMPLATE + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert ReportServiceClient._get_default_mtls_endpoint(None) is None + assert ( + ReportServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + ReportServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + ReportServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + ReportServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + ReportServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + ) + + +def test__read_environment_variables(): + assert ReportServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert ReportServiceClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert ReportServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + ReportServiceClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert ReportServiceClient._read_environment_variables() == ( + False, + "never", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert ReportServiceClient._read_environment_variables() == ( + False, + "always", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert ReportServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + ReportServiceClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert ReportServiceClient._read_environment_variables() == ( + False, + "auto", + "foo.com", + ) + + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert ReportServiceClient._get_client_cert_source(None, False) is None + assert ( + ReportServiceClient._get_client_cert_source(mock_provided_cert_source, False) + is None + ) + assert ( + ReportServiceClient._get_client_cert_source(mock_provided_cert_source, True) + == mock_provided_cert_source + ) + + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", return_value=True + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_default_cert_source, + ): + assert ( + ReportServiceClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + ReportServiceClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + ReportServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceClient), +) +@mock.patch.object( + ReportServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = ReportServiceClient._DEFAULT_UNIVERSE + default_endpoint = ReportServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = ReportServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + assert ( + ReportServiceClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + ReportServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == ReportServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + ReportServiceClient._get_api_endpoint(None, None, default_universe, "auto") + == default_endpoint + ) + assert ( + ReportServiceClient._get_api_endpoint(None, None, default_universe, "always") + == ReportServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + ReportServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == ReportServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + ReportServiceClient._get_api_endpoint(None, None, mock_universe, "never") + == mock_endpoint + ) + assert ( + ReportServiceClient._get_api_endpoint(None, None, default_universe, "never") + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + ReportServiceClient._get_api_endpoint( + None, mock_client_cert_source, mock_universe, "auto" + ) + assert ( + str(excinfo.value) + == "mTLS is not supported in any universe other than googleapis.com." + ) + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert ( + ReportServiceClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + ReportServiceClient._get_universe_domain(None, universe_domain_env) + == universe_domain_env + ) + assert ( + ReportServiceClient._get_universe_domain(None, None) + == ReportServiceClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + ReportServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +@pytest.mark.parametrize( + "error_code,cred_info_json,show_cred_info", + [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False), + ], +) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = ReportServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + + +@pytest.mark.parametrize("error_code", [401, 403, 404, 500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = ReportServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (ReportServiceClient, "grpc"), + (ReportServiceAsyncClient, "grpc_asyncio"), + (ReportServiceClient, "rest"), + ], +) +def test_report_service_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.ReportServiceGrpcTransport, "grpc"), + (transports.ReportServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ReportServiceRestTransport, "rest"), + ], +) +def test_report_service_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (ReportServiceClient, "grpc"), + (ReportServiceAsyncClient, "grpc_asyncio"), + (ReportServiceClient, "rest"), + ], +) +def test_report_service_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +def test_report_service_client_get_transport_class(): + transport = ReportServiceClient.get_transport_class() + available_transports = [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceRestTransport, + ] + assert transport in available_transports + + transport = ReportServiceClient.get_transport_class("grpc") + assert transport == transports.ReportServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (ReportServiceClient, transports.ReportServiceGrpcTransport, "grpc"), + ( + ReportServiceAsyncClient, + transports.ReportServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (ReportServiceClient, transports.ReportServiceRestTransport, "rest"), + ], +) +@mock.patch.object( + ReportServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceClient), +) +@mock.patch.object( + ReportServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceAsyncClient), +) +def test_report_service_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(ReportServiceClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(ReportServiceClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + (ReportServiceClient, transports.ReportServiceGrpcTransport, "grpc", "true"), + ( + ReportServiceAsyncClient, + transports.ReportServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + (ReportServiceClient, transports.ReportServiceGrpcTransport, "grpc", "false"), + ( + ReportServiceAsyncClient, + transports.ReportServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + (ReportServiceClient, transports.ReportServiceRestTransport, "rest", "true"), + (ReportServiceClient, transports.ReportServiceRestTransport, "rest", "false"), + ], +) +@mock.patch.object( + ReportServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceClient), +) +@mock.patch.object( + ReportServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_report_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class", [ReportServiceClient, ReportServiceAsyncClient] +) +@mock.patch.object( + ReportServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(ReportServiceClient), +) +@mock.patch.object( + ReportServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(ReportServiceAsyncClient), +) +def test_report_service_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + +@pytest.mark.parametrize( + "client_class", [ReportServiceClient, ReportServiceAsyncClient] +) +@mock.patch.object( + ReportServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceClient), +) +@mock.patch.object( + ReportServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ReportServiceAsyncClient), +) +def test_report_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = ReportServiceClient._DEFAULT_UNIVERSE + default_endpoint = ReportServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = ReportServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ): + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=api_override + ) + client = client_class( + client_options=options, + credentials=ga_credentials.AnonymousCredentials(), + ) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + else: + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == ( + mock_endpoint if universe_exists else default_endpoint + ) + assert client.universe_domain == ( + mock_universe if universe_exists else default_universe + ) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (ReportServiceClient, transports.ReportServiceGrpcTransport, "grpc"), + ( + ReportServiceAsyncClient, + transports.ReportServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (ReportServiceClient, transports.ReportServiceRestTransport, "rest"), + ], +) +def test_report_service_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + ReportServiceClient, + transports.ReportServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + ReportServiceAsyncClient, + transports.ReportServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + (ReportServiceClient, transports.ReportServiceRestTransport, "rest", None), + ], +) +def test_report_service_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +def test_report_service_client_client_options_from_dict(): + with mock.patch( + "google.shopping.merchant_reports_v1.services.report_service.transports.ReportServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = ReportServiceClient( + client_options={"api_endpoint": "squid.clam.whelk"} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + ReportServiceClient, + transports.ReportServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + ReportServiceAsyncClient, + transports.ReportServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_report_service_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/content",), + scopes=None, + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + reports.SearchRequest, + dict, + ], +) +def test_search(request_type, transport: str = "grpc"): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = reports.SearchResponse( + next_page_token="next_page_token_value", + ) + response = client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reports.SearchRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchPager) + assert response.next_page_token == "next_page_token_value" + + +def test_search_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reports.SearchRequest( + parent="parent_value", + query="query_value", + page_token="page_token_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.search(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reports.SearchRequest( + parent="parent_value", + query="query_value", + page_token="page_token_value", + ) + + +def test_search_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.search in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.search] = mock_rpc + request = {} + client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.search(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_search_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.search + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.search + ] = mock_rpc + + request = {} + await client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.search(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_search_async( + transport: str = "grpc_asyncio", request_type=reports.SearchRequest +): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reports.SearchResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reports.SearchRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_search_async_from_dict(): + await test_search_async(request_type=dict) + + +def test_search_field_headers(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reports.SearchRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + call.return_value = reports.SearchResponse() + client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_search_field_headers_async(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = reports.SearchRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reports.SearchResponse() + ) + await client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_search_flattened(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = reports.SearchResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_search_flattened_error(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.search( + reports.SearchRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_search_flattened_async(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = reports.SearchResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reports.SearchResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_search_flattened_error_async(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search( + reports.SearchRequest(), + parent="parent_value", + ) + + +def test_search_pager(transport_name: str = "grpc"): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + reports.ReportRow(), + ], + next_page_token="abc", + ), + reports.SearchResponse( + results=[], + next_page_token="def", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + ], + next_page_token="ghi", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.search(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reports.ReportRow) for i in results) + + +def test_search_pages(transport_name: str = "grpc"): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + reports.ReportRow(), + ], + next_page_token="abc", + ), + reports.SearchResponse( + results=[], + next_page_token="def", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + ], + next_page_token="ghi", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + ], + ), + RuntimeError, + ) + pages = list(client.search(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_search_async_pager(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + reports.ReportRow(), + ], + next_page_token="abc", + ), + reports.SearchResponse( + results=[], + next_page_token="def", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + ], + next_page_token="ghi", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + ], + ), + RuntimeError, + ) + async_pager = await client.search( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, reports.ReportRow) for i in responses) + + +@pytest.mark.asyncio +async def test_search_async_pages(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + reports.ReportRow(), + ], + next_page_token="abc", + ), + reports.SearchResponse( + results=[], + next_page_token="def", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + ], + next_page_token="ghi", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in (await client.search(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_search_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.search in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.search] = mock_rpc + + request = {} + client.search(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.search(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_search_rest_required_fields(request_type=reports.SearchRequest): + transport_class = transports.ReportServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["query"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + jsonified_request["query"] = "query_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + assert "query" in jsonified_request + assert jsonified_request["query"] == "query_value" + + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reports.SearchResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reports.SearchResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.search(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_search_rest_unset_required_fields(): + transport = transports.ReportServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.search._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "query", + ) + ) + ) + + +def test_search_rest_flattened(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = reports.SearchResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "accounts/sample1"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reports.SearchResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.search(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/reports/v1/{parent=accounts/*}/reports:search" % client.transport._host, + args[1], + ) + + +def test_search_rest_flattened_error(transport: str = "rest"): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.search( + reports.SearchRequest(), + parent="parent_value", + ) + + +def test_search_rest_pager(transport: str = "rest"): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + reports.ReportRow(), + ], + next_page_token="abc", + ), + reports.SearchResponse( + results=[], + next_page_token="def", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + ], + next_page_token="ghi", + ), + reports.SearchResponse( + results=[ + reports.ReportRow(), + reports.ReportRow(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reports.SearchResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "accounts/sample1"} + + pager = client.search(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reports.ReportRow) for i in results) + + pages = list(client.search(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ReportServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ReportServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReportServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ReportServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ReportServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ReportServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ReportServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReportServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReportServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ReportServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReportServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ReportServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceGrpcAsyncIOTransport, + transports.ReportServiceRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_kind_grpc(): + transport = ReportServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_empty_call_grpc(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + call.return_value = reports.SearchResponse() + client.search(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reports.SearchRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = ReportServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_search_empty_call_grpc_asyncio(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reports.SearchResponse( + next_page_token="next_page_token_value", + ) + ) + await client.search(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reports.SearchRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = ReportServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_search_rest_bad_request(request_type=reports.SearchRequest): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "accounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.search(request) + + +@pytest.mark.parametrize( + "request_type", + [ + reports.SearchRequest, + dict, + ], +) +def test_search_rest_call_success(request_type): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "accounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = reports.SearchResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reports.SearchResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.search(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_rest_interceptors(null_interceptor): + transport = transports.ReportServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReportServiceRestInterceptor(), + ) + client = ReportServiceClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ReportServiceRestInterceptor, "post_search" + ) as post, mock.patch.object( + transports.ReportServiceRestInterceptor, "post_search_with_metadata" + ) as post_with_metadata, mock.patch.object( + transports.ReportServiceRestInterceptor, "pre_search" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reports.SearchRequest.pb(reports.SearchRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reports.SearchResponse.to_json(reports.SearchResponse()) + req.return_value.content = return_value + + request = reports.SearchRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reports.SearchResponse() + post_with_metadata.return_value = reports.SearchResponse(), metadata + + client.search( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_initialize_client_w_rest(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_empty_call_rest(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.search), "__call__") as call: + client.search(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reports.SearchRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ReportServiceGrpcTransport, + ) + + +def test_report_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ReportServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_report_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.shopping.merchant_reports_v1.services.report_service.transports.ReportServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.ReportServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ("search",) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_report_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.shopping.merchant_reports_v1.services.report_service.transports.ReportServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReportServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id="octopus", + ) + + +def test_report_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.shopping.merchant_reports_v1.services.report_service.transports.ReportServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReportServiceTransport() + adc.assert_called_once() + + +def test_report_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + ReportServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceGrpcAsyncIOTransport, + ], +) +def test_report_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceGrpcAsyncIOTransport, + transports.ReportServiceRestTransport, + ], +) +def test_report_service_transport_auth_gdch_credentials(transport_class): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, "default", autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with(e) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.ReportServiceGrpcTransport, grpc_helpers), + (transports.ReportServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_report_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/content",), + scopes=["1", "2"], + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceGrpcAsyncIOTransport, + ], +) +def test_report_service_grpc_transport_client_cert_source_for_mtls(transport_class): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_report_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.ReportServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_report_service_host_no_port(transport_name): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_report_service_host_with_port(transport_name): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "merchantapi.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_report_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ReportServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ReportServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.search._session + session2 = client2.transport.search._session + assert session1 != session2 + + +def test_report_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ReportServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_report_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ReportServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceGrpcAsyncIOTransport, + ], +) +def test_report_service_transport_channel_mtls_with_client_cert_source(transport_class): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReportServiceGrpcTransport, + transports.ReportServiceGrpcAsyncIOTransport, + ], +) +def test_report_service_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = ReportServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = ReportServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = ReportServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = ReportServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = ReportServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = ReportServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = ReportServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = ReportServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = ReportServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format( + project=project, + ) + actual = ReportServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = ReportServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = ReportServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = ReportServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = ReportServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = ReportServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.ReportServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.ReportServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = ReportServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = ReportServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + with mock.patch.object( + type(getattr(client.transport, "_session")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "rest", + "grpc", + ] + for transport in transports: + client = ReportServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + (ReportServiceClient, transports.ReportServiceGrpcTransport), + (ReportServiceAsyncClient, transports.ReportServiceGrpcAsyncIOTransport), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/scripts/client-post-processing/doc-formatting.yaml b/scripts/client-post-processing/doc-formatting.yaml index b7fde0c0775d..1b37cfab0b1a 100644 --- a/scripts/client-post-processing/doc-formatting.yaml +++ b/scripts/client-post-processing/doc-formatting.yaml @@ -403,6 +403,7 @@ replacements: - paths: [ packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1alpha/types/reports.py, packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1beta/types/reports.py, + packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1/types/reports.py, ] before: | Here's an example of how the aggregated status is computed:\n @@ -422,7 +423,7 @@ replacements: PENDING Disapproved \| Disapproved \| NOT_ELIGIBLE_OR_DISAPPROVED ```\n Values: - count: 2 + count: 3 - paths: [ packages/google-cloud-monitoring/google/cloud/monitoring_v3/types/metric_service.py ]