diff --git a/librarian.yaml b/librarian.yaml index e861d394feaf..37681484abcc 100644 --- a/librarian.yaml +++ b/librarian.yaml @@ -2608,9 +2608,12 @@ libraries: - name: google-shopping-merchant-reviews version: 0.6.1 apis: + - path: google/shopping/merchant/reviews/v1 - path: google/shopping/merchant/reviews/v1beta python: opt_args_by_api: + google/shopping/merchant/reviews/v1: + - proto-plus-deps=google.shopping.type google/shopping/merchant/reviews/v1beta: - proto-plus-deps=google.shopping.type default_version: v1beta diff --git a/packages/google-shopping-merchant-reviews/.repo-metadata.json b/packages/google-shopping-merchant-reviews/.repo-metadata.json index 21da3475824d..906feac50217 100644 --- a/packages/google-shopping-merchant-reviews/.repo-metadata.json +++ b/packages/google-shopping-merchant-reviews/.repo-metadata.json @@ -9,7 +9,7 @@ "language": "python", "library_type": "GAPIC_AUTO", "name": "google-shopping-merchant-reviews", - "name_pretty": "Shopping Merchant Reviews", + "name_pretty": "Merchant", "product_documentation": "https://developers.google.com/merchant/api", "release_level": "preview", "repo": "googleapis/google-cloud-python" diff --git a/packages/google-shopping-merchant-reviews/README.rst b/packages/google-shopping-merchant-reviews/README.rst index d63aae4e0dd6..38ed6b9dde22 100644 --- a/packages/google-shopping-merchant-reviews/README.rst +++ b/packages/google-shopping-merchant-reviews/README.rst @@ -1,9 +1,9 @@ -Python Client for Shopping Merchant Reviews -=========================================== +Python Client for Merchant +========================== |preview| |pypi| |versions| -`Shopping Merchant Reviews`_: Programmatically manage your Merchant Center Accounts. +`Merchant`_: Programmatically manage your Merchant Center Accounts. - `Client Library Documentation`_ - `Product Documentation`_ @@ -14,7 +14,7 @@ Python Client for Shopping Merchant Reviews :target: https://pypi.org/project/google-shopping-merchant-reviews/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-shopping-merchant-reviews.svg :target: https://pypi.org/project/google-shopping-merchant-reviews/ -.. _Shopping Merchant Reviews: https://developers.google.com/merchant/api +.. _Merchant: https://developers.google.com/merchant/api .. _Client Library Documentation: https://googleapis.dev/python/google-shopping-merchant-reviews/latest .. _Product Documentation: https://developers.google.com/merchant/api @@ -25,12 +25,12 @@ In order to use this library, you first need to go through the following steps: 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ -3. `Enable the Shopping Merchant Reviews.`_ +3. `Enable the Merchant.`_ 4. `Set up Authentication.`_ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Enable the Shopping Merchant Reviews.: https://developers.google.com/merchant/api +.. _Enable the Merchant.: https://developers.google.com/merchant/api .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html Installation @@ -98,14 +98,14 @@ Windows Next Steps ~~~~~~~~~~ -- Read the `Client Library Documentation`_ for Shopping Merchant Reviews +- Read the `Client Library Documentation`_ for Merchant to see other available methods on the client. -- Read the `Shopping Merchant Reviews Product documentation`_ to learn +- Read the `Merchant Product documentation`_ to learn more about the product and see How-to Guides. - View this `README`_ to see the full list of Cloud APIs that we cover. -.. _Shopping Merchant Reviews Product documentation: https://developers.google.com/merchant/api +.. _Merchant Product documentation: https://developers.google.com/merchant/api .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst Logging diff --git a/packages/google-shopping-merchant-reviews/docs/README.rst b/packages/google-shopping-merchant-reviews/docs/README.rst index d63aae4e0dd6..38ed6b9dde22 100644 --- a/packages/google-shopping-merchant-reviews/docs/README.rst +++ b/packages/google-shopping-merchant-reviews/docs/README.rst @@ -1,9 +1,9 @@ -Python Client for Shopping Merchant Reviews -=========================================== +Python Client for Merchant +========================== |preview| |pypi| |versions| -`Shopping Merchant Reviews`_: Programmatically manage your Merchant Center Accounts. +`Merchant`_: Programmatically manage your Merchant Center Accounts. - `Client Library Documentation`_ - `Product Documentation`_ @@ -14,7 +14,7 @@ Python Client for Shopping Merchant Reviews :target: https://pypi.org/project/google-shopping-merchant-reviews/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-shopping-merchant-reviews.svg :target: https://pypi.org/project/google-shopping-merchant-reviews/ -.. _Shopping Merchant Reviews: https://developers.google.com/merchant/api +.. _Merchant: https://developers.google.com/merchant/api .. _Client Library Documentation: https://googleapis.dev/python/google-shopping-merchant-reviews/latest .. _Product Documentation: https://developers.google.com/merchant/api @@ -25,12 +25,12 @@ In order to use this library, you first need to go through the following steps: 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ -3. `Enable the Shopping Merchant Reviews.`_ +3. `Enable the Merchant.`_ 4. `Set up Authentication.`_ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Enable the Shopping Merchant Reviews.: https://developers.google.com/merchant/api +.. _Enable the Merchant.: https://developers.google.com/merchant/api .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html Installation @@ -98,14 +98,14 @@ Windows Next Steps ~~~~~~~~~~ -- Read the `Client Library Documentation`_ for Shopping Merchant Reviews +- Read the `Client Library Documentation`_ for Merchant to see other available methods on the client. -- Read the `Shopping Merchant Reviews Product documentation`_ to learn +- Read the `Merchant Product documentation`_ to learn more about the product and see How-to Guides. - View this `README`_ to see the full list of Cloud APIs that we cover. -.. _Shopping Merchant Reviews Product documentation: https://developers.google.com/merchant/api +.. _Merchant Product documentation: https://developers.google.com/merchant/api .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst Logging diff --git a/packages/google-shopping-merchant-reviews/docs/index.rst b/packages/google-shopping-merchant-reviews/docs/index.rst index 45be05b786dc..a8054c34afea 100644 --- a/packages/google-shopping-merchant-reviews/docs/index.rst +++ b/packages/google-shopping-merchant-reviews/docs/index.rst @@ -2,6 +2,9 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of Merchant. +By default, you will get version ``merchant_reviews_v1beta``. + API Reference ------------- @@ -11,6 +14,14 @@ API Reference merchant_reviews_v1beta/services_ merchant_reviews_v1beta/types_ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_reviews_v1/services_ + merchant_reviews_v1/types_ + Changelog --------- diff --git a/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/product_reviews_service.rst b/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/product_reviews_service.rst new file mode 100644 index 000000000000..14585d955fcc --- /dev/null +++ b/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/product_reviews_service.rst @@ -0,0 +1,10 @@ +ProductReviewsService +--------------------------------------- + +.. automodule:: google.shopping.merchant_reviews_v1.services.product_reviews_service + :members: + :inherited-members: + +.. automodule:: google.shopping.merchant_reviews_v1.services.product_reviews_service.pagers + :members: + :inherited-members: diff --git a/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/services_.rst b/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/services_.rst new file mode 100644 index 000000000000..93c81232f0f9 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Shopping Merchant Reviews v1 API +==================================================== +.. toctree:: + :maxdepth: 2 + + product_reviews_service diff --git a/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/types_.rst b/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/types_.rst new file mode 100644 index 000000000000..cde969f8398d --- /dev/null +++ b/packages/google-shopping-merchant-reviews/docs/merchant_reviews_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Shopping Merchant Reviews v1 API +================================================= + +.. automodule:: google.shopping.merchant_reviews_v1.types + :members: + :show-inheritance: diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/__init__.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/__init__.py new file mode 100644 index 000000000000..ba4e6c336bea --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/__init__.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 google.api_core as api_core + +from google.shopping.merchant_reviews_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + +# PEP 0810: Explicit Lazy Imports +# Python 3.15+ natively intercepts and defers these imports. +# Developers can disable this behavior and force eager imports. +# For more information, see: +# https://docs.python.org/3.15/library/sys.html#sys.set_lazy_imports_filter +# Older Python versions safely ignore this variable. +__lazy_modules__ = { + "google.shopping.merchant_reviews_v1.services.product_reviews_service", + "google.shopping.merchant_reviews_v1.types.productreviews", + "google.shopping.merchant_reviews_v1.types.productreviews_common", +} + + +from .services.product_reviews_service import ( + ProductReviewsServiceAsyncClient, + ProductReviewsServiceClient, +) +from .types.productreviews import ( + DeleteProductReviewRequest, + GetProductReviewRequest, + InsertProductReviewRequest, + ListProductReviewsRequest, + ListProductReviewsResponse, + ProductReview, +) +from .types.productreviews_common import ProductReviewAttributes, ProductReviewStatus + +__all__ = ( + "ProductReviewsServiceAsyncClient", + "DeleteProductReviewRequest", + "GetProductReviewRequest", + "InsertProductReviewRequest", + "ListProductReviewsRequest", + "ListProductReviewsResponse", + "ProductReview", + "ProductReviewAttributes", + "ProductReviewStatus", + "ProductReviewsServiceClient", +) + +api_core.check_python_version("google.shopping.merchant_reviews_v1") +api_core.check_dependency_versions("google.shopping.merchant_reviews_v1") diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/_compat.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/_compat.py new file mode 100644 index 000000000000..3d3bdf9e2c91 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/_compat.py @@ -0,0 +1,262 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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. +# +"""A compatibility module for older versions of google-api-core.""" + +import json +import os +from typing import Any, Dict, List, Optional, Tuple +from urllib.parse import urlparse, urlunparse + +from google.api_core import path_template +from google.api_core.universe import EmptyUniverseError +from google.auth.exceptions import MutualTLSChannelError +from google.protobuf import json_format + +try: + # note: `#type: ignore` is added because the return type for `should_use_client_cert` + # is different than that of the fallback implementation below. This will be removed once + # we bump the minimum supported version of google-auth. + from google.auth.transport.mtls import should_use_client_cert # type: ignore +except ImportError: # pragma: NO COVER + + def should_use_client_cert(): + """Returns whether client certificate should be used for mTLS.""" + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be" + " either `true` or `false`" + ) + return use_client_cert == "true" + + +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 = should_use_client_cert() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + 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, use_mtls_endpoint, universe_domain_env + + +DEFAULT_UNIVERSE = "googleapis.com" + +try: + from google.api_core.universe import get_default_mtls_endpoint +except ImportError: # pragma: NO COVER + + def get_default_mtls_endpoint(api_endpoint: Optional[str]) -> Optional[str]: + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Other URLs (including those that do not match these domain suffixes or + already contain '.mtls.') are passed through as-is. + + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + + Returns: + Optional[str]: converted mTLS api endpoint. + """ + if not api_endpoint or ".mtls." in api_endpoint.lower(): + return api_endpoint + + has_scheme = "://" in api_endpoint + if not has_scheme: + parsed = urlparse("//" + api_endpoint) + else: + parsed = urlparse(api_endpoint) + + host = parsed.hostname + if not host: + return api_endpoint + + port = f":{parsed.port}" if parsed.port else "" + + lowered_host = host.lower() + suffix_sandbox = ".sandbox.googleapis.com" + suffix_google = ".googleapis.com" + if lowered_host.endswith(suffix_sandbox): + new_host = host[: -len(suffix_sandbox)] + ".mtls.sandbox.googleapis.com" + elif lowered_host.endswith(suffix_google): + new_host = host[: -len(suffix_google)] + ".mtls.googleapis.com" + else: + return api_endpoint + + netloc = new_host + port + new_parsed = parsed._replace(netloc=netloc) + + if not has_scheme: + return urlunparse(new_parsed)[2:] + else: + return urlunparse(new_parsed) + + +try: + from google.api_core.universe import get_api_endpoint +except ImportError: # pragma: NO COVER + + def get_api_endpoint( + api_override: Optional[str], + universe_domain: str, + default_universe: str, + default_mtls_endpoint: Optional[str], + default_endpoint_template: str, + use_mtls: bool, + ) -> str: + """Return the API endpoint used by the client. + + Args: + api_override (Optional[str]): The API endpoint override. If specified, + this is always returned. + universe_domain (str): The universe domain used by the client. + default_universe (str): The default universe domain. + default_mtls_endpoint (Optional[str]): The default mTLS endpoint. + default_endpoint_template (str): The default endpoint template containing + a placeholder `{UNIVERSE_DOMAIN}`. + use_mtls (bool): Whether to use the mTLS endpoint. + + Returns: + str: The API endpoint to be used by the client. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mTLS is requested but + not supported in the configured universe domain. + ValueError: If mTLS is requested but no mTLS endpoint is available. + """ + if api_override is not None: + return api_override + + if use_mtls: + if universe_domain.lower() != default_universe.lower(): + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {default_universe}." + ) + if not default_mtls_endpoint: + raise ValueError("mTLS endpoint is not available.") + return default_mtls_endpoint + else: + return default_endpoint_template.format(UNIVERSE_DOMAIN=universe_domain) + + +try: + from google.api_core.universe import get_universe_domain +except ImportError: # pragma: NO COVER + + def get_universe_domain( + *potential_universes: Optional[str], + default_universe: str, + ) -> str: + """Return the universe domain used by the client. + + Args: + *potential_universes (Optional[str]): Potential universe domains in order of preference. + default_universe (str): The default universe domain. + + Returns: + str: The universe domain to be used by the client. + + Raises: + EmptyUniverseError: If the resolved universe domain is an empty string. + """ + resolved = next( + (x.strip() for x in potential_universes if x is not None), + default_universe, + ) + + if not resolved: + raise EmptyUniverseError() + return resolved + + +try: + from google.api_core.rest_helpers import transcode_request # type: ignore +except ImportError: # pragma: NO COVER + + def transcode_request( + http_options: List[Dict[str, str]], + request: Any, + required_fields_default_values: Optional[Dict[str, Any]] = None, + rest_numeric_enums: bool = False, + ) -> Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]: + """Transcodes a request into HTTP method, URI, body, and query parameters. + + Args: + http_options (List[Dict[str, str]]): List of HTTP transcoding rules. + request (Any): The protobuf or proto-plus request message. + required_fields_default_values (Optional[Dict[str, Any]]): Dictionary + of required fields default values to merge into query parameters if missing. + rest_numeric_enums (bool): Whether to encode enums as integers. + + Returns: + Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]: A tuple containing: + - The raw transcoded request dictionary (containing keys like 'uri', 'method'). + - The serialized request body JSON string, or None if no body. + - The query parameters dictionary. + """ + if request is None: + raise TypeError("request cannot be None") + + # Convert proto-plus message to its underlying protobuf message if needed + pb_request = getattr(request, "_pb", request) + + transcoded_request = path_template.transcode(http_options, pb_request) + + body_json = None + if transcoded_request.get("body") is not None: + body_json = json_format.MessageToJson( + transcoded_request["body"], + use_integers_for_enums=rest_numeric_enums, + ) + + query_params_json = {} + if transcoded_request.get("query_params") is not None: + query_params_json = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=rest_numeric_enums, + ) + ) + + # If required_fields_default_values is provided, we merge default values for missing + # required fields into the query parameters. + if required_fields_default_values: + for k, v in required_fields_default_values.items(): + if k not in query_params_json: + query_params_json[k] = v + + if rest_numeric_enums: + query_params_json["$alt"] = "json;enum-encoding=int" + + return transcoded_request, body_json, query_params_json diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/gapic_metadata.json b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/gapic_metadata.json new file mode 100644 index 000000000000..c6b07687d9d2 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/gapic_metadata.json @@ -0,0 +1,88 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.shopping.merchant_reviews_v1", + "protoPackage": "google.shopping.merchant.reviews.v1", + "schema": "1.0", + "services": { + "ProductReviewsService": { + "clients": { + "grpc": { + "libraryClient": "ProductReviewsServiceClient", + "rpcs": { + "DeleteProductReview": { + "methods": [ + "delete_product_review" + ] + }, + "GetProductReview": { + "methods": [ + "get_product_review" + ] + }, + "InsertProductReview": { + "methods": [ + "insert_product_review" + ] + }, + "ListProductReviews": { + "methods": [ + "list_product_reviews" + ] + } + } + }, + "grpc-async": { + "libraryClient": "ProductReviewsServiceAsyncClient", + "rpcs": { + "DeleteProductReview": { + "methods": [ + "delete_product_review" + ] + }, + "GetProductReview": { + "methods": [ + "get_product_review" + ] + }, + "InsertProductReview": { + "methods": [ + "insert_product_review" + ] + }, + "ListProductReviews": { + "methods": [ + "list_product_reviews" + ] + } + } + }, + "rest": { + "libraryClient": "ProductReviewsServiceClient", + "rpcs": { + "DeleteProductReview": { + "methods": [ + "delete_product_review" + ] + }, + "GetProductReview": { + "methods": [ + "get_product_review" + ] + }, + "InsertProductReview": { + "methods": [ + "insert_product_review" + ] + }, + "ListProductReviews": { + "methods": [ + "list_product_reviews" + ] + } + } + } + } + } + } +} diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/gapic_version.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/gapic_version.py new file mode 100644 index 000000000000..4c89af3224e4 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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.6.1" # {x-release-please-version} diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/py.typed b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/py.typed new file mode 100644 index 000000000000..effd746b771d --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-reviews package uses inline types. diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/__init__.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/__init__.py new file mode 100644 index 000000000000..32b36c5c4fe0 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/__init__.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/__init__.py new file mode 100644 index 000000000000..6110af3df1e5 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 ProductReviewsServiceAsyncClient +from .client import ProductReviewsServiceClient + +__all__ = ( + "ProductReviewsServiceClient", + "ProductReviewsServiceAsyncClient", +) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/async_client.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/async_client.py new file mode 100644 index 000000000000..05c7acac496f --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/async_client.py @@ -0,0 +1,757 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 logging as std_logging +import re +from collections import OrderedDict +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) + +import google.protobuf +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 + +from google.shopping.merchant_reviews_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.type.types import types + +from google.shopping.merchant_reviews_v1.services.product_reviews_service import pagers +from google.shopping.merchant_reviews_v1.types import ( + productreviews, + productreviews_common, +) + +from .client import ProductReviewsServiceClient +from .transports.base import DEFAULT_CLIENT_INFO, ProductReviewsServiceTransport +from .transports.grpc_asyncio import ProductReviewsServiceGrpcAsyncIOTransport + +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 ProductReviewsServiceAsyncClient: + """Service to manage product reviews.""" + + _client: ProductReviewsServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = ProductReviewsServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = ProductReviewsServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = ProductReviewsServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = ProductReviewsServiceClient._DEFAULT_UNIVERSE + + product_review_path = staticmethod(ProductReviewsServiceClient.product_review_path) + parse_product_review_path = staticmethod( + ProductReviewsServiceClient.parse_product_review_path + ) + common_billing_account_path = staticmethod( + ProductReviewsServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + ProductReviewsServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(ProductReviewsServiceClient.common_folder_path) + parse_common_folder_path = staticmethod( + ProductReviewsServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + ProductReviewsServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + ProductReviewsServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod(ProductReviewsServiceClient.common_project_path) + parse_common_project_path = staticmethod( + ProductReviewsServiceClient.parse_common_project_path + ) + common_location_path = staticmethod( + ProductReviewsServiceClient.common_location_path + ) + parse_common_location_path = staticmethod( + ProductReviewsServiceClient.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: + ProductReviewsServiceAsyncClient: The constructed client. + """ + sa_info_func = ( + ProductReviewsServiceClient.from_service_account_info.__func__ # type: ignore + ) + return sa_info_func(ProductReviewsServiceAsyncClient, info, *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: + ProductReviewsServiceAsyncClient: The constructed client. + """ + sa_file_func = ( + ProductReviewsServiceClient.from_service_account_file.__func__ # type: ignore + ) + return sa_file_func(ProductReviewsServiceAsyncClient, filename, *args, **kwargs) + + 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 ProductReviewsServiceClient.get_mtls_endpoint_and_cert_source( + client_options + ) # type: ignore + + @property + def transport(self) -> ProductReviewsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ProductReviewsServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self) -> str: + """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 = ProductReviewsServiceClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + ProductReviewsServiceTransport, + Callable[..., ProductReviewsServiceTransport], + ] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the product reviews 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,ProductReviewsServiceTransport,Callable[..., ProductReviewsServiceTransport]]]): + 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 ProductReviewsServiceTransport 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 = ProductReviewsServiceClient( + 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.reviews_v1.ProductReviewsServiceAsyncClient`.", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "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.reviews.v1.ProductReviewsService", + "credentialsType": None, + }, + ) + + async def get_product_review( + self, + request: Optional[Union[productreviews.GetProductReviewRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ProductReview: + r"""Gets a product review. + + .. 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_reviews_v1 + + async def sample_get_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.GetProductReviewRequest( + name="name_value", + ) + + # Make the request + response = await client.get_product_review(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_reviews_v1.types.GetProductReviewRequest, dict]]): + The request object. Request message for the + GetProductReview method. + name (:class:`str`): + Required. The ID of the merchant + review. Format: + accounts/{account}/productReviews/{productReview} + + This corresponds to the ``name`` 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_reviews_v1.types.ProductReview: + A review for a product. For more information, see + [Introduction to Product Review + Feeds](https://developers.google.com/product-review-feeds) + + """ + # 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 = [name] + 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, productreviews.GetProductReviewRequest): + request = productreviews.GetProductReviewRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.get_product_review + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_product_reviews( + self, + request: Optional[Union[productreviews.ListProductReviewsRequest, 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.ListProductReviewsAsyncPager: + r"""Lists product reviews. + + .. 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_reviews_v1 + + async def sample_list_product_reviews(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.ListProductReviewsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_product_reviews(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_reviews_v1.types.ListProductReviewsRequest, dict]]): + The request object. Request message for the + ListProductReviews method. + parent (:class:`str`): + Required. The account to list product + reviews for. 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_reviews_v1.services.product_reviews_service.pagers.ListProductReviewsAsyncPager: + response message for the + ListProductReviews 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, productreviews.ListProductReviewsRequest): + request = productreviews.ListProductReviewsRequest(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.list_product_reviews + ] + + # 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.ListProductReviewsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def insert_product_review( + self, + request: Optional[ + Union[productreviews.InsertProductReviewRequest, dict] + ] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ProductReview: + r"""Inserts a product review. + + .. 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_reviews_v1 + + async def sample_insert_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + product_review = merchant_reviews_v1.ProductReview() + product_review.product_review_id = "product_review_id_value" + + request = merchant_reviews_v1.InsertProductReviewRequest( + parent="parent_value", + product_review=product_review, + data_source="data_source_value", + ) + + # Make the request + response = await client.insert_product_review(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_reviews_v1.types.InsertProductReviewRequest, dict]]): + The request object. Request message for the ``InsertProductReview`` method. + 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_reviews_v1.types.ProductReview: + A review for a product. For more information, see + [Introduction to Product Review + Feeds](https://developers.google.com/product-review-feeds) + + """ + # Create or coerce a protobuf request object. + # - 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, productreviews.InsertProductReviewRequest): + request = productreviews.InsertProductReviewRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.insert_product_review + ] + + # 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, + ) + + # Done; return the response. + return response + + async def delete_product_review( + self, + request: Optional[ + Union[productreviews.DeleteProductReviewRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a product review. + + .. 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_reviews_v1 + + async def sample_delete_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.DeleteProductReviewRequest( + name="name_value", + ) + + # Make the request + await client.delete_product_review(request=request) + + Args: + request (Optional[Union[google.shopping.merchant_reviews_v1.types.DeleteProductReviewRequest, dict]]): + The request object. Request message for the ``DeleteProductReview`` method. + name (:class:`str`): + Required. The ID of the Product + review. Format: + accounts/{account}/productReviews/{productReview} + + This corresponds to the ``name`` 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`. + """ + # 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 = [name] + 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, productreviews.DeleteProductReviewRequest): + request = productreviews.DeleteProductReviewRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.delete_product_review + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def __aenter__(self) -> "ProductReviewsServiceAsyncClient": + 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__ +) +DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ("ProductReviewsServiceAsyncClient",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/client.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/client.py new file mode 100644 index 000000000000..10bb66631726 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/client.py @@ -0,0 +1,1041 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 os +import re +import warnings +from collections import OrderedDict +from http import HTTPStatus +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) + +import google.protobuf +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 + +from google.shopping.merchant_reviews_v1 import gapic_version as package_version +from google.shopping.merchant_reviews_v1._compat import ( + get_api_endpoint, + get_default_mtls_endpoint, + get_universe_domain, + read_environment_variables, + should_use_client_cert, +) + +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.type.types import types + +from google.shopping.merchant_reviews_v1.services.product_reviews_service import pagers +from google.shopping.merchant_reviews_v1.types import ( + productreviews, + productreviews_common, +) + +from .transports.base import DEFAULT_CLIENT_INFO, ProductReviewsServiceTransport +from .transports.grpc import ProductReviewsServiceGrpcTransport +from .transports.grpc_asyncio import ProductReviewsServiceGrpcAsyncIOTransport +from .transports.rest import ProductReviewsServiceRestTransport + + +class ProductReviewsServiceClientMeta(type): + """Metaclass for the ProductReviewsService 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[ProductReviewsServiceTransport]] + _transport_registry["grpc"] = ProductReviewsServiceGrpcTransport + _transport_registry["grpc_asyncio"] = ProductReviewsServiceGrpcAsyncIOTransport + _transport_registry["rest"] = ProductReviewsServiceRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[ProductReviewsServiceTransport]: + """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 ProductReviewsServiceClient(metaclass=ProductReviewsServiceClientMeta): + """Service to manage product reviews.""" + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "merchantapi.googleapis.com" + DEFAULT_MTLS_ENDPOINT = get_default_mtls_endpoint(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: + ProductReviewsServiceClient: 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: + ProductReviewsServiceClient: 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) -> ProductReviewsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ProductReviewsServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def product_review_path( + account: str, + productreview: str, + ) -> str: + """Returns a fully-qualified product_review string.""" + return "accounts/{account}/productReviews/{productreview}".format( + account=account, + productreview=productreview, + ) + + @staticmethod + def parse_product_review_path(path: str) -> Dict[str, str]: + """Parses a product_review path into its component segments.""" + m = re.match( + r"^accounts/(?P.+?)/productReviews/(?P.+?)$", path + ) + return m.groupdict() if m else {} + + @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 = should_use_client_cert() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + 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: + 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 # type: ignore + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @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 + + 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) -> str: + """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, + ProductReviewsServiceTransport, + Callable[..., ProductReviewsServiceTransport], + ] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the product reviews 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,ProductReviewsServiceTransport,Callable[..., ProductReviewsServiceTransport]]]): + 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 ProductReviewsServiceTransport 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 = ( + read_environment_variables() + ) + self._client_cert_source = ProductReviewsServiceClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + self._universe_domain = get_universe_domain( + universe_domain_opt, + self._universe_domain_env, + default_universe=ProductReviewsServiceClient._DEFAULT_UNIVERSE, + ) + self._api_endpoint: str = "" # 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, ProductReviewsServiceTransport) + if transport_provided: + # transport is a ProductReviewsServiceTransport 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(ProductReviewsServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = self._api_endpoint or get_api_endpoint( + api_override=self._client_options.api_endpoint, + universe_domain=self._universe_domain, + default_universe=ProductReviewsServiceClient._DEFAULT_UNIVERSE, + default_mtls_endpoint=ProductReviewsServiceClient.DEFAULT_MTLS_ENDPOINT, + default_endpoint_template=ProductReviewsServiceClient._DEFAULT_ENDPOINT_TEMPLATE, + use_mtls=self._use_mtls_endpoint == "always" + or (self._use_mtls_endpoint == "auto" and self._client_cert_source), + ) + + 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[ProductReviewsServiceTransport], + Callable[..., ProductReviewsServiceTransport], + ] = ( + ProductReviewsServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., ProductReviewsServiceTransport], 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.reviews_v1.ProductReviewsServiceClient`.", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "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.reviews.v1.ProductReviewsService", + "credentialsType": None, + }, + ) + + def get_product_review( + self, + request: Optional[Union[productreviews.GetProductReviewRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ProductReview: + r"""Gets a product review. + + .. 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_reviews_v1 + + def sample_get_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.GetProductReviewRequest( + name="name_value", + ) + + # Make the request + response = client.get_product_review(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_reviews_v1.types.GetProductReviewRequest, dict]): + The request object. Request message for the + GetProductReview method. + name (str): + Required. The ID of the merchant + review. Format: + accounts/{account}/productReviews/{productReview} + + This corresponds to the ``name`` 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_reviews_v1.types.ProductReview: + A review for a product. For more information, see + [Introduction to Product Review + Feeds](https://developers.google.com/product-review-feeds) + + """ + # 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 = [name] + 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, productreviews.GetProductReviewRequest): + request = productreviews.GetProductReviewRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_product_review] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_product_reviews( + self, + request: Optional[Union[productreviews.ListProductReviewsRequest, 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.ListProductReviewsPager: + r"""Lists product reviews. + + .. 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_reviews_v1 + + def sample_list_product_reviews(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.ListProductReviewsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_product_reviews(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.shopping.merchant_reviews_v1.types.ListProductReviewsRequest, dict]): + The request object. Request message for the + ListProductReviews method. + parent (str): + Required. The account to list product + reviews for. 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_reviews_v1.services.product_reviews_service.pagers.ListProductReviewsPager: + response message for the + ListProductReviews 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, productreviews.ListProductReviewsRequest): + request = productreviews.ListProductReviewsRequest(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.list_product_reviews] + + # 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.ListProductReviewsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def insert_product_review( + self, + request: Optional[ + Union[productreviews.InsertProductReviewRequest, dict] + ] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ProductReview: + r"""Inserts a product review. + + .. 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_reviews_v1 + + def sample_insert_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + product_review = merchant_reviews_v1.ProductReview() + product_review.product_review_id = "product_review_id_value" + + request = merchant_reviews_v1.InsertProductReviewRequest( + parent="parent_value", + product_review=product_review, + data_source="data_source_value", + ) + + # Make the request + response = client.insert_product_review(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_reviews_v1.types.InsertProductReviewRequest, dict]): + The request object. Request message for the ``InsertProductReview`` 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: + google.shopping.merchant_reviews_v1.types.ProductReview: + A review for a product. For more information, see + [Introduction to Product Review + Feeds](https://developers.google.com/product-review-feeds) + + """ + # Create or coerce a protobuf request object. + # - 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, productreviews.InsertProductReviewRequest): + request = productreviews.InsertProductReviewRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.insert_product_review] + + # 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, + ) + + # Done; return the response. + return response + + def delete_product_review( + self, + request: Optional[ + Union[productreviews.DeleteProductReviewRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a product review. + + .. 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_reviews_v1 + + def sample_delete_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.DeleteProductReviewRequest( + name="name_value", + ) + + # Make the request + client.delete_product_review(request=request) + + Args: + request (Union[google.shopping.merchant_reviews_v1.types.DeleteProductReviewRequest, dict]): + The request object. Request message for the ``DeleteProductReview`` method. + name (str): + Required. The ID of the Product + review. Format: + accounts/{account}/productReviews/{productReview} + + This corresponds to the ``name`` 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`. + """ + # 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 = [name] + 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, productreviews.DeleteProductReviewRequest): + request = productreviews.DeleteProductReviewRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_product_review] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def __enter__(self) -> "ProductReviewsServiceClient": + 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__ +) +DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ("ProductReviewsServiceClient",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/pagers.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/pagers.py new file mode 100644 index 000000000000..ef47bad2cd9c --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/pagers.py @@ -0,0 +1,197 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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_reviews_v1.types import productreviews + + +class ListProductReviewsPager: + """A pager for iterating through ``list_product_reviews`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_reviews_v1.types.ListProductReviewsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``product_reviews`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListProductReviews`` requests and continue to iterate + through the ``product_reviews`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_reviews_v1.types.ListProductReviewsResponse` + 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[..., productreviews.ListProductReviewsResponse], + request: productreviews.ListProductReviewsRequest, + response: productreviews.ListProductReviewsResponse, + *, + 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_reviews_v1.types.ListProductReviewsRequest): + The initial request object. + response (google.shopping.merchant_reviews_v1.types.ListProductReviewsResponse): + 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 = productreviews.ListProductReviewsRequest(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[productreviews.ListProductReviewsResponse]: + 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[productreviews.ProductReview]: + for page in self.pages: + yield from page.product_reviews + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListProductReviewsAsyncPager: + """A pager for iterating through ``list_product_reviews`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_reviews_v1.types.ListProductReviewsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``product_reviews`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListProductReviews`` requests and continue to iterate + through the ``product_reviews`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_reviews_v1.types.ListProductReviewsResponse` + 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[productreviews.ListProductReviewsResponse]], + request: productreviews.ListProductReviewsRequest, + response: productreviews.ListProductReviewsResponse, + *, + 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_reviews_v1.types.ListProductReviewsRequest): + The initial request object. + response (google.shopping.merchant_reviews_v1.types.ListProductReviewsResponse): + 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 = productreviews.ListProductReviewsRequest(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[productreviews.ListProductReviewsResponse]: + 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[productreviews.ProductReview]: + async def async_generator(): + async for page in self.pages: + for response in page.product_reviews: + 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-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/README.rst b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/README.rst new file mode 100644 index 000000000000..3f3dc5bbce21 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/README.rst @@ -0,0 +1,10 @@ + +transport inheritance structure +_______________________________ + +``ProductReviewsServiceTransport`` is the ABC for all transports. + +- public child ``ProductReviewsServiceGrpcTransport`` for sync gRPC transport (defined in ``grpc.py``). +- public child ``ProductReviewsServiceGrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``). +- private child ``_BaseProductReviewsServiceRestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``). +- public child ``ProductReviewsServiceRestTransport`` 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-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/__init__.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/__init__.py new file mode 100644 index 000000000000..ee9968a340aa --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/__init__.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 ProductReviewsServiceTransport +from .grpc import ProductReviewsServiceGrpcTransport +from .grpc_asyncio import ProductReviewsServiceGrpcAsyncIOTransport +from .rest import ( + ProductReviewsServiceRestInterceptor, + ProductReviewsServiceRestTransport, +) + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[ProductReviewsServiceTransport]] +_transport_registry["grpc"] = ProductReviewsServiceGrpcTransport +_transport_registry["grpc_asyncio"] = ProductReviewsServiceGrpcAsyncIOTransport +_transport_registry["rest"] = ProductReviewsServiceRestTransport + +__all__ = ( + "ProductReviewsServiceTransport", + "ProductReviewsServiceGrpcTransport", + "ProductReviewsServiceGrpcAsyncIOTransport", + "ProductReviewsServiceRestTransport", + "ProductReviewsServiceRestInterceptor", +) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/base.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/base.py new file mode 100644 index 000000000000..2327e86eb28b --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/base.py @@ -0,0 +1,219 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 +import google.auth # type: ignore +import google.protobuf +import google.protobuf.empty_pb2 as empty_pb2 # type: ignore +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.oauth2 import service_account # type: ignore + +from google.shopping.merchant_reviews_v1 import gapic_version as package_version +from google.shopping.merchant_reviews_v1.types import productreviews + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) +DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class ProductReviewsServiceTransport(abc.ABC): + """Abstract transport class for ProductReviewsService.""" + + 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]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. This argument will be + removed in the next major version of this library. + 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. + api_audience (Optional[str]): The intended audience for the API calls + to the service that will be set when using certain 3rd party + authentication flows. Audience is typically a resource identifier. + If not set, the host value will be used as a default. + """ + + # 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=scopes, + quota_project_id=quota_project_id, + default_scopes=self.AUTH_SCOPES, + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default( + scopes=scopes, + quota_project_id=quota_project_id, + default_scopes=self.AUTH_SCOPES, + ) + # 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 + + self._wrapped_methods: Dict[Callable, Callable] = {} + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.get_product_review: gapic_v1.method.wrap_method( + self.get_product_review, + default_timeout=None, + client_info=client_info, + ), + self.list_product_reviews: gapic_v1.method.wrap_method( + self.list_product_reviews, + default_timeout=None, + client_info=client_info, + ), + self.insert_product_review: gapic_v1.method.wrap_method( + self.insert_product_review, + default_timeout=None, + client_info=client_info, + ), + self.delete_product_review: gapic_v1.method.wrap_method( + self.delete_product_review, + 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 get_product_review( + self, + ) -> Callable[ + [productreviews.GetProductReviewRequest], + Union[productreviews.ProductReview, Awaitable[productreviews.ProductReview]], + ]: + raise NotImplementedError() + + @property + def list_product_reviews( + self, + ) -> Callable[ + [productreviews.ListProductReviewsRequest], + Union[ + productreviews.ListProductReviewsResponse, + Awaitable[productreviews.ListProductReviewsResponse], + ], + ]: + raise NotImplementedError() + + @property + def insert_product_review( + self, + ) -> Callable[ + [productreviews.InsertProductReviewRequest], + Union[productreviews.ProductReview, Awaitable[productreviews.ProductReview]], + ]: + raise NotImplementedError() + + @property + def delete_product_review( + self, + ) -> Callable[ + [productreviews.DeleteProductReviewRequest], + Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("ProductReviewsServiceTransport",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/grpc.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/grpc.py new file mode 100644 index 000000000000..c8a922379703 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/grpc.py @@ -0,0 +1,448 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +import google.auth # type: ignore +import google.protobuf.empty_pb2 as empty_pb2 # type: ignore +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore +from google.api_core import gapic_v1, grpc_helpers +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 + +from google.shopping.merchant_reviews_v1.types import productreviews + +from .base import DEFAULT_CLIENT_INFO, ProductReviewsServiceTransport + +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)!r}" + + 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.reviews.v1.ProductReviewsService", + "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)!r}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class ProductReviewsServiceGrpcTransport(ProductReviewsServiceTransport): + """gRPC backend transport for ProductReviewsService. + + Service to manage product reviews. + + 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]): Deprecated. 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. + This argument will be removed in the next major version of this library. + 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. + api_audience (Optional[str]): The intended audience for the API calls + to the service that will be set when using certain 3rd party + authentication flows. Audience is typically a resource identifier. + If not set, the host value will be used as a default. + + 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]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. This argument will be + removed in the next major version of this library. + 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 get_product_review( + self, + ) -> Callable[ + [productreviews.GetProductReviewRequest], productreviews.ProductReview + ]: + r"""Return a callable for the get product review method over gRPC. + + Gets a product review. + + Returns: + Callable[[~.GetProductReviewRequest], + ~.ProductReview]: + 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 "get_product_review" not in self._stubs: + self._stubs["get_product_review"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/GetProductReview", + request_serializer=productreviews.GetProductReviewRequest.serialize, + response_deserializer=productreviews.ProductReview.deserialize, + ) + return self._stubs["get_product_review"] + + @property + def list_product_reviews( + self, + ) -> Callable[ + [productreviews.ListProductReviewsRequest], + productreviews.ListProductReviewsResponse, + ]: + r"""Return a callable for the list product reviews method over gRPC. + + Lists product reviews. + + Returns: + Callable[[~.ListProductReviewsRequest], + ~.ListProductReviewsResponse]: + 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 "list_product_reviews" not in self._stubs: + self._stubs["list_product_reviews"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/ListProductReviews", + request_serializer=productreviews.ListProductReviewsRequest.serialize, + response_deserializer=productreviews.ListProductReviewsResponse.deserialize, + ) + return self._stubs["list_product_reviews"] + + @property + def insert_product_review( + self, + ) -> Callable[ + [productreviews.InsertProductReviewRequest], productreviews.ProductReview + ]: + r"""Return a callable for the insert product review method over gRPC. + + Inserts a product review. + + Returns: + Callable[[~.InsertProductReviewRequest], + ~.ProductReview]: + 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 "insert_product_review" not in self._stubs: + self._stubs["insert_product_review"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/InsertProductReview", + request_serializer=productreviews.InsertProductReviewRequest.serialize, + response_deserializer=productreviews.ProductReview.deserialize, + ) + return self._stubs["insert_product_review"] + + @property + def delete_product_review( + self, + ) -> Callable[[productreviews.DeleteProductReviewRequest], empty_pb2.Empty]: + r"""Return a callable for the delete product review method over gRPC. + + Deletes a product review. + + Returns: + Callable[[~.DeleteProductReviewRequest], + ~.Empty]: + 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 "delete_product_review" not in self._stubs: + self._stubs["delete_product_review"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/DeleteProductReview", + request_serializer=productreviews.DeleteProductReviewRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_product_review"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("ProductReviewsServiceGrpcTransport",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/grpc_asyncio.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..2d1c796505f4 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/grpc_asyncio.py @@ -0,0 +1,490 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +import google.protobuf.empty_pb2 as empty_pb2 # type: ignore +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore +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 +from grpc.experimental import aio # type: ignore + +from google.shopping.merchant_reviews_v1.types import productreviews + +from .base import DEFAULT_CLIENT_INFO, ProductReviewsServiceTransport +from .grpc import ProductReviewsServiceGrpcTransport + +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)!r}" + + 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.reviews.v1.ProductReviewsService", + "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)!r}" + 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.reviews.v1.ProductReviewsService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class ProductReviewsServiceGrpcAsyncIOTransport(ProductReviewsServiceTransport): + """gRPC AsyncIO backend transport for ProductReviewsService. + + Service to manage product reviews. + + 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]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. This argument will be + removed in the next major version of this library. + 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]): Deprecated. 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. + This argument will be removed in the next major version of this library. + 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. + api_audience (Optional[str]): The intended audience for the API calls + to the service that will be set when using certain 3rd party + authentication flows. Audience is typically a resource identifier. + If not set, the host value will be used as a default. + + 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 get_product_review( + self, + ) -> Callable[ + [productreviews.GetProductReviewRequest], + Awaitable[productreviews.ProductReview], + ]: + r"""Return a callable for the get product review method over gRPC. + + Gets a product review. + + Returns: + Callable[[~.GetProductReviewRequest], + Awaitable[~.ProductReview]]: + 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 "get_product_review" not in self._stubs: + self._stubs["get_product_review"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/GetProductReview", + request_serializer=productreviews.GetProductReviewRequest.serialize, + response_deserializer=productreviews.ProductReview.deserialize, + ) + return self._stubs["get_product_review"] + + @property + def list_product_reviews( + self, + ) -> Callable[ + [productreviews.ListProductReviewsRequest], + Awaitable[productreviews.ListProductReviewsResponse], + ]: + r"""Return a callable for the list product reviews method over gRPC. + + Lists product reviews. + + Returns: + Callable[[~.ListProductReviewsRequest], + Awaitable[~.ListProductReviewsResponse]]: + 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 "list_product_reviews" not in self._stubs: + self._stubs["list_product_reviews"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/ListProductReviews", + request_serializer=productreviews.ListProductReviewsRequest.serialize, + response_deserializer=productreviews.ListProductReviewsResponse.deserialize, + ) + return self._stubs["list_product_reviews"] + + @property + def insert_product_review( + self, + ) -> Callable[ + [productreviews.InsertProductReviewRequest], + Awaitable[productreviews.ProductReview], + ]: + r"""Return a callable for the insert product review method over gRPC. + + Inserts a product review. + + Returns: + Callable[[~.InsertProductReviewRequest], + Awaitable[~.ProductReview]]: + 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 "insert_product_review" not in self._stubs: + self._stubs["insert_product_review"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/InsertProductReview", + request_serializer=productreviews.InsertProductReviewRequest.serialize, + response_deserializer=productreviews.ProductReview.deserialize, + ) + return self._stubs["insert_product_review"] + + @property + def delete_product_review( + self, + ) -> Callable[ + [productreviews.DeleteProductReviewRequest], Awaitable[empty_pb2.Empty] + ]: + r"""Return a callable for the delete product review method over gRPC. + + Deletes a product review. + + Returns: + Callable[[~.DeleteProductReviewRequest], + Awaitable[~.Empty]]: + 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 "delete_product_review" not in self._stubs: + self._stubs["delete_product_review"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.reviews.v1.ProductReviewsService/DeleteProductReview", + request_serializer=productreviews.DeleteProductReviewRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_product_review"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.get_product_review: self._wrap_method( + self.get_product_review, + default_timeout=None, + client_info=client_info, + ), + self.list_product_reviews: self._wrap_method( + self.list_product_reviews, + default_timeout=None, + client_info=client_info, + ), + self.insert_product_review: self._wrap_method( + self.insert_product_review, + default_timeout=None, + client_info=client_info, + ), + self.delete_product_review: self._wrap_method( + self.delete_product_review, + 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__ = ("ProductReviewsServiceGrpcAsyncIOTransport",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/rest.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/rest.py new file mode 100644 index 000000000000..35acf8a73968 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/rest.py @@ -0,0 +1,983 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 +import warnings +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + +import google.protobuf +import google.protobuf.empty_pb2 as empty_pb2 # type: ignore +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 +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.shopping.merchant_reviews_v1._compat import transcode_request +from google.shopping.merchant_reviews_v1.types import productreviews + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseProductReviewsServiceRestTransport + +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}", +) + +DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class ProductReviewsServiceRestInterceptor: + """Interceptor for ProductReviewsService. + + 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 ProductReviewsServiceRestTransport. + + .. code-block:: python + class MyCustomProductReviewsServiceInterceptor(ProductReviewsServiceRestInterceptor): + def pre_delete_product_review(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_product_review(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_product_review(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_insert_product_review(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_insert_product_review(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_product_reviews(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_product_reviews(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ProductReviewsServiceRestTransport(interceptor=MyCustomProductReviewsServiceInterceptor()) + client = ProductReviewsServiceClient(transport=transport) + + + """ + + def pre_delete_product_review( + self, + request: productreviews.DeleteProductReviewRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + productreviews.DeleteProductReviewRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for delete_product_review + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductReviewsService server. + """ + return request, metadata + + def pre_get_product_review( + self, + request: productreviews.GetProductReviewRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + productreviews.GetProductReviewRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_product_review + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductReviewsService server. + """ + return request, metadata + + def post_get_product_review( + self, response: productreviews.ProductReview + ) -> productreviews.ProductReview: + """Post-rpc interceptor for get_product_review + + DEPRECATED. Please use the `post_get_product_review_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ProductReviewsService server but before + it is returned to user code. This `post_get_product_review` interceptor runs + before the `post_get_product_review_with_metadata` interceptor. + """ + return response + + def post_get_product_review_with_metadata( + self, + response: productreviews.ProductReview, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[productreviews.ProductReview, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_product_review + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ProductReviewsService server but before it is returned to user code. + + We recommend only using this `post_get_product_review_with_metadata` + interceptor in new development instead of the `post_get_product_review` interceptor. + When both interceptors are used, this `post_get_product_review_with_metadata` interceptor runs after the + `post_get_product_review` interceptor. The (possibly modified) response returned by + `post_get_product_review` will be passed to + `post_get_product_review_with_metadata`. + """ + return response, metadata + + def pre_insert_product_review( + self, + request: productreviews.InsertProductReviewRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + productreviews.InsertProductReviewRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for insert_product_review + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductReviewsService server. + """ + return request, metadata + + def post_insert_product_review( + self, response: productreviews.ProductReview + ) -> productreviews.ProductReview: + """Post-rpc interceptor for insert_product_review + + DEPRECATED. Please use the `post_insert_product_review_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ProductReviewsService server but before + it is returned to user code. This `post_insert_product_review` interceptor runs + before the `post_insert_product_review_with_metadata` interceptor. + """ + return response + + def post_insert_product_review_with_metadata( + self, + response: productreviews.ProductReview, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[productreviews.ProductReview, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for insert_product_review + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ProductReviewsService server but before it is returned to user code. + + We recommend only using this `post_insert_product_review_with_metadata` + interceptor in new development instead of the `post_insert_product_review` interceptor. + When both interceptors are used, this `post_insert_product_review_with_metadata` interceptor runs after the + `post_insert_product_review` interceptor. The (possibly modified) response returned by + `post_insert_product_review` will be passed to + `post_insert_product_review_with_metadata`. + """ + return response, metadata + + def pre_list_product_reviews( + self, + request: productreviews.ListProductReviewsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + productreviews.ListProductReviewsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for list_product_reviews + + Override in a subclass to manipulate the request or metadata + before they are sent to the ProductReviewsService server. + """ + return request, metadata + + def post_list_product_reviews( + self, response: productreviews.ListProductReviewsResponse + ) -> productreviews.ListProductReviewsResponse: + """Post-rpc interceptor for list_product_reviews + + DEPRECATED. Please use the `post_list_product_reviews_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ProductReviewsService server but before + it is returned to user code. This `post_list_product_reviews` interceptor runs + before the `post_list_product_reviews_with_metadata` interceptor. + """ + return response + + def post_list_product_reviews_with_metadata( + self, + response: productreviews.ListProductReviewsResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + productreviews.ListProductReviewsResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for list_product_reviews + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ProductReviewsService server but before it is returned to user code. + + We recommend only using this `post_list_product_reviews_with_metadata` + interceptor in new development instead of the `post_list_product_reviews` interceptor. + When both interceptors are used, this `post_list_product_reviews_with_metadata` interceptor runs after the + `post_list_product_reviews` interceptor. The (possibly modified) response returned by + `post_list_product_reviews` will be passed to + `post_list_product_reviews_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class ProductReviewsServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ProductReviewsServiceRestInterceptor + + +class ProductReviewsServiceRestTransport(_BaseProductReviewsServiceRestTransport): + """REST backend synchronous transport for ProductReviewsService. + + Service to manage product reviews. + + 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[ProductReviewsServiceRestInterceptor] = 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]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. This argument will be + removed in the next major version of this library. + 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. + interceptor (Optional[ProductReviewsServiceRestInterceptor]): Interceptor used + to manipulate requests, request metadata, and responses. + api_audience (Optional[str]): The intended audience for the API calls + to the service that will be set when using certain 3rd party + authentication flows. Audience is typically a resource identifier. + If not set, the host value will be used as a default. + """ + # 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 ProductReviewsServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteProductReview( + _BaseProductReviewsServiceRestTransport._BaseDeleteProductReview, + ProductReviewsServiceRestStub, + ): + def __hash__(self): + return hash("ProductReviewsServiceRestTransport.DeleteProductReview") + + @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), + ) + return response + + def __call__( + self, + request: productreviews.DeleteProductReviewRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ): + r"""Call the delete product review method over HTTP. + + Args: + request (~.productreviews.DeleteProductReviewRequest): + The request object. Request message for the ``DeleteProductReview`` 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`. + """ + + http_options = _BaseProductReviewsServiceRestTransport._BaseDeleteProductReview._get_http_options() + request, metadata = self._interceptor.pre_delete_product_review( + request, metadata + ) + transcoded_request, body, query_params = transcode_request( + http_options, + request, + required_fields_default_values=getattr( + _BaseProductReviewsServiceRestTransport._BaseDeleteProductReview, + "_BaseDeleteProductReview__REQUIRED_FIELDS_DEFAULT_VALUES", + None, + ), + rest_numeric_enums=True, + ) + + 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.reviews_v1.ProductReviewsServiceClient.DeleteProductReview", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "DeleteProductReview", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ProductReviewsServiceRestTransport._DeleteProductReview._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetProductReview( + _BaseProductReviewsServiceRestTransport._BaseGetProductReview, + ProductReviewsServiceRestStub, + ): + def __hash__(self): + return hash("ProductReviewsServiceRestTransport.GetProductReview") + + @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), + ) + return response + + def __call__( + self, + request: productreviews.GetProductReviewRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ProductReview: + r"""Call the get product review method over HTTP. + + Args: + request (~.productreviews.GetProductReviewRequest): + The request object. Request message for the + GetProductReview 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: + ~.productreviews.ProductReview: + A review for a product. For more information, see + `Introduction to Product Review + Feeds `__ + + """ + + http_options = _BaseProductReviewsServiceRestTransport._BaseGetProductReview._get_http_options() + request, metadata = self._interceptor.pre_get_product_review( + request, metadata + ) + transcoded_request, body, query_params = transcode_request( + http_options, + request, + required_fields_default_values=getattr( + _BaseProductReviewsServiceRestTransport._BaseGetProductReview, + "_BaseGetProductReview__REQUIRED_FIELDS_DEFAULT_VALUES", + None, + ), + rest_numeric_enums=True, + ) + + 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.reviews_v1.ProductReviewsServiceClient.GetProductReview", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "GetProductReview", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ProductReviewsServiceRestTransport._GetProductReview._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + ) + + # 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 = productreviews.ProductReview() + pb_resp = productreviews.ProductReview.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_product_review(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_get_product_review_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = productreviews.ProductReview.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.reviews_v1.ProductReviewsServiceClient.get_product_review", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "GetProductReview", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _InsertProductReview( + _BaseProductReviewsServiceRestTransport._BaseInsertProductReview, + ProductReviewsServiceRestStub, + ): + def __hash__(self): + return hash("ProductReviewsServiceRestTransport.InsertProductReview") + + @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: productreviews.InsertProductReviewRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ProductReview: + r"""Call the insert product review method over HTTP. + + Args: + request (~.productreviews.InsertProductReviewRequest): + The request object. Request message for the ``InsertProductReview`` 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: + ~.productreviews.ProductReview: + A review for a product. For more information, see + `Introduction to Product Review + Feeds `__ + + """ + + http_options = _BaseProductReviewsServiceRestTransport._BaseInsertProductReview._get_http_options() + request, metadata = self._interceptor.pre_insert_product_review( + request, metadata + ) + transcoded_request, body, query_params = transcode_request( + http_options, + request, + required_fields_default_values=getattr( + _BaseProductReviewsServiceRestTransport._BaseInsertProductReview, + "_BaseInsertProductReview__REQUIRED_FIELDS_DEFAULT_VALUES", + None, + ), + rest_numeric_enums=True, + ) + + 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.reviews_v1.ProductReviewsServiceClient.InsertProductReview", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "InsertProductReview", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ProductReviewsServiceRestTransport._InsertProductReview._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 = productreviews.ProductReview() + pb_resp = productreviews.ProductReview.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_insert_product_review(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_insert_product_review_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = productreviews.ProductReview.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.reviews_v1.ProductReviewsServiceClient.insert_product_review", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "InsertProductReview", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListProductReviews( + _BaseProductReviewsServiceRestTransport._BaseListProductReviews, + ProductReviewsServiceRestStub, + ): + def __hash__(self): + return hash("ProductReviewsServiceRestTransport.ListProductReviews") + + @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), + ) + return response + + def __call__( + self, + request: productreviews.ListProductReviewsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> productreviews.ListProductReviewsResponse: + r"""Call the list product reviews method over HTTP. + + Args: + request (~.productreviews.ListProductReviewsRequest): + The request object. Request message for the + ListProductReviews 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: + ~.productreviews.ListProductReviewsResponse: + response message for the + ListProductReviews method. + + """ + + http_options = _BaseProductReviewsServiceRestTransport._BaseListProductReviews._get_http_options() + request, metadata = self._interceptor.pre_list_product_reviews( + request, metadata + ) + transcoded_request, body, query_params = transcode_request( + http_options, + request, + required_fields_default_values=getattr( + _BaseProductReviewsServiceRestTransport._BaseListProductReviews, + "_BaseListProductReviews__REQUIRED_FIELDS_DEFAULT_VALUES", + None, + ), + rest_numeric_enums=True, + ) + + 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.reviews_v1.ProductReviewsServiceClient.ListProductReviews", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "ListProductReviews", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ProductReviewsServiceRestTransport._ListProductReviews._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + ) + + # 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 = productreviews.ListProductReviewsResponse() + pb_resp = productreviews.ListProductReviewsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_product_reviews(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_product_reviews_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + productreviews.ListProductReviewsResponse.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.reviews_v1.ProductReviewsServiceClient.list_product_reviews", + extra={ + "serviceName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "rpcName": "ListProductReviews", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def delete_product_review( + self, + ) -> Callable[[productreviews.DeleteProductReviewRequest], empty_pb2.Empty]: + # 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._DeleteProductReview(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_product_review( + self, + ) -> Callable[ + [productreviews.GetProductReviewRequest], productreviews.ProductReview + ]: + # 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._GetProductReview(self._session, self._host, self._interceptor) # type: ignore + + @property + def insert_product_review( + self, + ) -> Callable[ + [productreviews.InsertProductReviewRequest], productreviews.ProductReview + ]: + # 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._InsertProductReview(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_product_reviews( + self, + ) -> Callable[ + [productreviews.ListProductReviewsRequest], + productreviews.ListProductReviewsResponse, + ]: + # 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._ListProductReviews(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("ProductReviewsServiceRestTransport",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/rest_base.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/rest_base.py new file mode 100644 index 000000000000..d52d4263ee08 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/services/product_reviews_service/transports/rest_base.py @@ -0,0 +1,159 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 + +import google.protobuf.empty_pb2 as empty_pb2 # type: ignore +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format + +from google.shopping.merchant_reviews_v1.types import productreviews + +from .base import DEFAULT_CLIENT_INFO, ProductReviewsServiceTransport + + +class _BaseProductReviewsServiceRestTransport(ProductReviewsServiceTransport): + """Base REST backend transport for ProductReviewsService. + + 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 _BaseDeleteProductReview: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/reviews/v1/{name=accounts/*/productReviews/*}", + }, + ] + return http_options + + class _BaseGetProductReview: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/reviews/v1/{name=accounts/*/productReviews/*}", + }, + ] + return http_options + + class _BaseInsertProductReview: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "dataSource": "", + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/reviews/v1/{parent=accounts/*}/productReviews:insert", + "body": "product_review", + }, + ] + return http_options + + class _BaseListProductReviews: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/reviews/v1/{parent=accounts/*}/productReviews", + }, + ] + return http_options + + +__all__ = ("_BaseProductReviewsServiceRestTransport",) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/__init__.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/__init__.py new file mode 100644 index 000000000000..9971d2f80b3b --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 .productreviews import ( + DeleteProductReviewRequest, + GetProductReviewRequest, + InsertProductReviewRequest, + ListProductReviewsRequest, + ListProductReviewsResponse, + ProductReview, +) +from .productreviews_common import ( + ProductReviewAttributes, + ProductReviewStatus, +) + +__all__ = ( + "DeleteProductReviewRequest", + "GetProductReviewRequest", + "InsertProductReviewRequest", + "ListProductReviewsRequest", + "ListProductReviewsResponse", + "ProductReview", + "ProductReviewAttributes", + "ProductReviewStatus", +) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/productreviews.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/productreviews.py new file mode 100644 index 000000000000..9a5f2a19b77a --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/productreviews.py @@ -0,0 +1,221 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 + +import proto # type: ignore +from google.shopping.type.types import types + +from google.shopping.merchant_reviews_v1.types import productreviews_common + +__protobuf__ = proto.module( + package="google.shopping.merchant.reviews.v1", + manifest={ + "GetProductReviewRequest", + "DeleteProductReviewRequest", + "ListProductReviewsRequest", + "InsertProductReviewRequest", + "ListProductReviewsResponse", + "ProductReview", + }, +) + + +class GetProductReviewRequest(proto.Message): + r"""Request message for the GetProductReview method. + + Attributes: + name (str): + Required. The ID of the merchant review. + Format: + accounts/{account}/productReviews/{productReview} + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteProductReviewRequest(proto.Message): + r"""Request message for the ``DeleteProductReview`` method. + + Attributes: + name (str): + Required. The ID of the Product review. + Format: + accounts/{account}/productReviews/{productReview} + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListProductReviewsRequest(proto.Message): + r"""Request message for the ListProductReviews method. + + Attributes: + parent (str): + Required. The account to list product reviews + for. Format: accounts/{account} + page_size (int): + Optional. The maximum number of products to + return. The service may return fewer than this + value. + page_token (str): + Optional. A page token, received from a previous + ``ListProductReviews`` call. Provide this to retrieve the + subsequent page. + + When paginating, all other parameters provided to + ``ListProductReviews`` must match the call that provided the + page token. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class InsertProductReviewRequest(proto.Message): + r"""Request message for the ``InsertProductReview`` method. + + Attributes: + parent (str): + Required. The account where the product + review will be inserted. Format: + accounts/{account} + product_review (google.shopping.merchant_reviews_v1.types.ProductReview): + Required. The product review to insert. + data_source (str): + Required. Format: + ``accounts/{account}/dataSources/{datasource}``. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + product_review: "ProductReview" = proto.Field( + proto.MESSAGE, + number=2, + message="ProductReview", + ) + data_source: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListProductReviewsResponse(proto.Message): + r"""response message for the ListProductReviews method. + + Attributes: + product_reviews (MutableSequence[google.shopping.merchant_reviews_v1.types.ProductReview]): + The product review. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + product_reviews: MutableSequence["ProductReview"] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="ProductReview", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ProductReview(proto.Message): + r"""A review for a product. For more information, see `Introduction to + Product Review + Feeds `__ + + Attributes: + name (str): + Identifier. The name of the product review. Format: + ``"{productreview.name=accounts/{account}/productReviews/{productReview}}"`` + product_review_id (str): + Required. The permanent, unique identifier + for the product review in the publisher’s + system. + product_review_attributes (google.shopping.merchant_reviews_v1.types.ProductReviewAttributes): + Optional. A list of product review + attributes. + custom_attributes (MutableSequence[google.shopping.type.types.CustomAttribute]): + Optional. A list of custom + (merchant-provided) attributes. + data_source (str): + Output only. The primary data source of the + product review. + product_review_status (google.shopping.merchant_reviews_v1.types.ProductReviewStatus): + Output only. The status of a product review, + data validation issues, that is, information + about a product review computed asynchronously. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + product_review_id: str = proto.Field( + proto.STRING, + number=2, + ) + product_review_attributes: productreviews_common.ProductReviewAttributes = ( + proto.Field( + proto.MESSAGE, + number=3, + message=productreviews_common.ProductReviewAttributes, + ) + ) + custom_attributes: MutableSequence[types.CustomAttribute] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message=types.CustomAttribute, + ) + data_source: str = proto.Field( + proto.STRING, + number=5, + ) + product_review_status: productreviews_common.ProductReviewStatus = proto.Field( + proto.MESSAGE, + number=6, + message=productreviews_common.ProductReviewStatus, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/productreviews_common.py b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/productreviews_common.py new file mode 100644 index 000000000000..2336007c33e4 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/google/shopping/merchant_reviews_v1/types/productreviews_common.py @@ -0,0 +1,544 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 + +import google.protobuf.timestamp_pb2 as timestamp_pb2 # type: ignore +import proto # type: ignore +from google.shopping.type.types import types + +__protobuf__ = proto.module( + package="google.shopping.merchant.reviews.v1", + manifest={ + "ProductReviewAttributes", + "ProductReviewStatus", + }, +) + + +class ProductReviewAttributes(proto.Message): + r"""Attributes. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + aggregator_name (str): + Optional. The name of the aggregator of the + product reviews. + A publisher may use a reviews aggregator to + manage reviews and provide the feeds. This + element indicates the use of an aggregator and + contains information about the aggregator. + + This field is a member of `oneof`_ ``_aggregator_name``. + subclient_name (str): + Optional. The name of the subclient of the + product reviews. + The subclient is an identifier of the product + review source. It should be equivalent to the + directory provided in the file data source path. + + This field is a member of `oneof`_ ``_subclient_name``. + publisher_name (str): + Optional. The name of the publisher of the + product reviews. + The information about the publisher, which may + be a retailer, manufacturer, reviews service + company, or any entity that publishes product + reviews. + + This field is a member of `oneof`_ ``_publisher_name``. + publisher_favicon (str): + Optional. A link to the company favicon of + the publisher. The image dimensions should be + favicon size: 16x16 pixels. The image format + should be GIF, JPG or PNG. + + This field is a member of `oneof`_ ``_publisher_favicon``. + reviewer_id (str): + Optional. The author of the product review. + + A permanent, unique identifier for the author of + the review in the publisher's system. + + This field is a member of `oneof`_ ``_reviewer_id``. + reviewer_is_anonymous (bool): + Optional. Set to true if the reviewer should + remain anonymous. + + This field is a member of `oneof`_ ``_reviewer_is_anonymous``. + reviewer_username (str): + Optional. The name of the reviewer of the + product review. + + This field is a member of `oneof`_ ``_reviewer_username``. + review_language (str): + Optional. The language of the review defined + by BCP-47 language code. + + This field is a member of `oneof`_ ``_review_language``. + review_country (str): + Optional. The country of the review defined + by ISO 3166-1 Alpha-2 Country Code. + + This field is a member of `oneof`_ ``_review_country``. + review_time (google.protobuf.timestamp_pb2.Timestamp): + Required. The timestamp indicating when the + review was written. + title (str): + Optional. The title of the review. + + This field is a member of `oneof`_ ``_title``. + content (str): + Optional. The content of the review. If + empty, the content might still get populated + from pros and cons. + + This field is a member of `oneof`_ ``_content``. + pros (MutableSequence[str]): + Optional. Contains the advantages based on + the opinion of the reviewer. Omit boilerplate + text like "pro:" unless it was written by the + reviewer. + cons (MutableSequence[str]): + Optional. Contains the disadvantages based on + the opinion of the reviewer. Omit boilerplate + text like "con:" unless it was written by the + reviewer. + review_link (google.shopping.merchant_reviews_v1.types.ProductReviewAttributes.ReviewLink): + Optional. The URI of the review landing page. + reviewer_image_links (MutableSequence[str]): + Optional. A URI to an image of the reviewed + product created by the review author. The URI + does not have to end with an image file + extension. + min_rating (int): + Optional. Contains the ratings associated + with the review. The minimum possible number for + the rating. This should be the worst possible + rating and should not be a value for no rating. + + This field is a member of `oneof`_ ``_min_rating``. + max_rating (int): + Optional. The maximum possible number for the + rating. The value of the max rating must be + greater than the value of the min attribute. + + This field is a member of `oneof`_ ``_max_rating``. + rating (float): + Optional. The reviewer's overall rating of + the product. + + This field is a member of `oneof`_ ``_rating``. + product_names (MutableSequence[str]): + Optional. Descriptive name of a product. + product_links (MutableSequence[str]): + Optional. The URI of the product. This URI can have the same + value as the ``review_link`` element, if the review URI and + the product URI are the same. + asins (MutableSequence[str]): + Optional. Contains ASINs (Amazon Standard + Identification Numbers) associated with a + product. + gtins (MutableSequence[str]): + Optional. Contains GTINs (global trade item + numbers) associated with a product. Sub-types of + GTINs (e.g. UPC, EAN, ISBN, JAN) are supported. + mpns (MutableSequence[str]): + Optional. Contains MPNs (manufacturer part + numbers) associated with a product. + skus (MutableSequence[str]): + Optional. Contains SKUs (stock keeping units) + associated with a product. Often this matches + the product Offer Id in the product feed. + brands (MutableSequence[str]): + Optional. Contains brand names associated + with a product. + is_spam (bool): + Optional. Indicates whether the review is + marked as spam in the publisher's system. + + This field is a member of `oneof`_ ``_is_spam``. + is_verified_purchase (bool): + Optional. Indicates whether the reviewer's + purchase is verified. + + This field is a member of `oneof`_ ``_is_verified_purchase``. + is_incentivized_review (bool): + Optional. Indicates whether the review is + incentivized. + + This field is a member of `oneof`_ ``_is_incentivized_review``. + collection_method (google.shopping.merchant_reviews_v1.types.ProductReviewAttributes.CollectionMethod): + Optional. The method used to collect the + review. + transaction_id (str): + Optional. A permanent, unique identifier for + the transaction associated with the review in + the publisher's system. This ID can be used to + indicate that multiple reviews are associated + with the same transaction. + """ + + class CollectionMethod(proto.Enum): + r"""The method used to collect the review. + + Values: + COLLECTION_METHOD_UNSPECIFIED (0): + Collection method unspecified. + UNSOLICITED (1): + The user was not responding to a specific + solicitation when they submitted the review. + POST_FULFILLMENT (2): + The user submitted the review in response to + a solicitation after fulfillment of the user's + order. + """ + + COLLECTION_METHOD_UNSPECIFIED = 0 + UNSOLICITED = 1 + POST_FULFILLMENT = 2 + + class ReviewLink(proto.Message): + r"""The URI of the review landing page. + + Attributes: + type_ (google.shopping.merchant_reviews_v1.types.ProductReviewAttributes.ReviewLink.Type): + Optional. Type of the review URI. + link (str): + Optional. The URI of the review landing page. For example: + ``http://www.example.com/review_5.html``. + """ + + class Type(proto.Enum): + r"""Type of the review URI. + + Values: + TYPE_UNSPECIFIED (0): + Type unspecified. + SINGLETON (1): + The review page contains only this single + review. + GROUP (2): + The review page contains a group of reviews + including this review. + """ + + TYPE_UNSPECIFIED = 0 + SINGLETON = 1 + GROUP = 2 + + type_: "ProductReviewAttributes.ReviewLink.Type" = proto.Field( + proto.ENUM, + number=1, + enum="ProductReviewAttributes.ReviewLink.Type", + ) + link: str = proto.Field( + proto.STRING, + number=2, + ) + + aggregator_name: str = proto.Field( + proto.STRING, + number=1, + optional=True, + ) + subclient_name: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + publisher_name: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + publisher_favicon: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + reviewer_id: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + reviewer_is_anonymous: bool = proto.Field( + proto.BOOL, + number=6, + optional=True, + ) + reviewer_username: str = proto.Field( + proto.STRING, + number=7, + optional=True, + ) + review_language: str = proto.Field( + proto.STRING, + number=8, + optional=True, + ) + review_country: str = proto.Field( + proto.STRING, + number=9, + optional=True, + ) + review_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=10, + message=timestamp_pb2.Timestamp, + ) + title: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + content: str = proto.Field( + proto.STRING, + number=12, + optional=True, + ) + pros: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=13, + ) + cons: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=14, + ) + review_link: ReviewLink = proto.Field( + proto.MESSAGE, + number=15, + message=ReviewLink, + ) + reviewer_image_links: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=16, + ) + min_rating: int = proto.Field( + proto.INT64, + number=17, + optional=True, + ) + max_rating: int = proto.Field( + proto.INT64, + number=18, + optional=True, + ) + rating: float = proto.Field( + proto.DOUBLE, + number=19, + optional=True, + ) + product_names: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=20, + ) + product_links: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=21, + ) + asins: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=22, + ) + gtins: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=23, + ) + mpns: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=24, + ) + skus: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=25, + ) + brands: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=26, + ) + is_spam: bool = proto.Field( + proto.BOOL, + number=27, + optional=True, + ) + is_verified_purchase: bool = proto.Field( + proto.BOOL, + number=30, + optional=True, + ) + is_incentivized_review: bool = proto.Field( + proto.BOOL, + number=31, + optional=True, + ) + collection_method: CollectionMethod = proto.Field( + proto.ENUM, + number=28, + enum=CollectionMethod, + ) + transaction_id: str = proto.Field( + proto.STRING, + number=29, + ) + + +class ProductReviewStatus(proto.Message): + r"""Product review status. + + Attributes: + destination_statuses (MutableSequence[google.shopping.merchant_reviews_v1.types.ProductReviewStatus.ProductReviewDestinationStatus]): + Output only. The intended destinations for + the product review. + item_level_issues (MutableSequence[google.shopping.merchant_reviews_v1.types.ProductReviewStatus.ProductReviewItemLevelIssue]): + Output only. A list of all issues associated + with the product review. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Date on which the item has been created, in + `ISO 8601 `__ format. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Date on which the item has been last updated, + in `ISO 8601 `__ + format. + """ + + class ProductReviewDestinationStatus(proto.Message): + r"""The destination status of the product review status. + + Attributes: + reporting_context (google.shopping.type.types.ReportingContext.ReportingContextEnum): + Output only. The name of the reporting + context. + """ + + reporting_context: types.ReportingContext.ReportingContextEnum = proto.Field( + proto.ENUM, + number=1, + enum=types.ReportingContext.ReportingContextEnum, + ) + + class ProductReviewItemLevelIssue(proto.Message): + r"""The ItemLevelIssue of the product review status. + + Attributes: + code (str): + Output only. The error code of the issue. + severity (google.shopping.merchant_reviews_v1.types.ProductReviewStatus.ProductReviewItemLevelIssue.Severity): + Output only. How this issue affects serving + of the product review. + resolution (str): + Output only. Whether the issue can be + resolved by the merchant. + attribute (str): + Output only. The attribute's name, if the + issue is caused by a single attribute. + reporting_context (google.shopping.type.types.ReportingContext.ReportingContextEnum): + Output only. The reporting context the issue + applies to. + description (str): + Output only. A short issue description in + English. + detail (str): + Output only. A detailed issue description in + English. + documentation (str): + Output only. The URL of a web page to help + with resolving this issue. + """ + + class Severity(proto.Enum): + r"""How the issue affects the serving of the product review. + + Values: + SEVERITY_UNSPECIFIED (0): + Not specified. + NOT_IMPACTED (1): + This issue represents a warning and does not + have a direct affect on the product review. + DISAPPROVED (2): + Issue disapproves the product review. + """ + + SEVERITY_UNSPECIFIED = 0 + NOT_IMPACTED = 1 + DISAPPROVED = 2 + + code: str = proto.Field( + proto.STRING, + number=1, + ) + severity: "ProductReviewStatus.ProductReviewItemLevelIssue.Severity" = ( + proto.Field( + proto.ENUM, + number=2, + enum="ProductReviewStatus.ProductReviewItemLevelIssue.Severity", + ) + ) + resolution: str = proto.Field( + proto.STRING, + number=3, + ) + attribute: str = proto.Field( + proto.STRING, + number=4, + ) + reporting_context: types.ReportingContext.ReportingContextEnum = proto.Field( + proto.ENUM, + number=5, + enum=types.ReportingContext.ReportingContextEnum, + ) + description: str = proto.Field( + proto.STRING, + number=6, + ) + detail: str = proto.Field( + proto.STRING, + number=7, + ) + documentation: str = proto.Field( + proto.STRING, + number=8, + ) + + destination_statuses: MutableSequence[ProductReviewDestinationStatus] = ( + proto.RepeatedField( + proto.MESSAGE, + number=3, + message=ProductReviewDestinationStatus, + ) + ) + item_level_issues: MutableSequence[ProductReviewItemLevelIssue] = ( + proto.RepeatedField( + proto.MESSAGE, + number=4, + message=ProductReviewItemLevelIssue, + ) + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + last_update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_delete_product_review_async.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_delete_product_review_async.py new file mode 100644 index 000000000000..27625a745d4c --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_delete_product_review_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 DeleteProductReview +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_DeleteProductReview_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_reviews_v1 + + +async def sample_delete_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.DeleteProductReviewRequest( + name="name_value", + ) + + # Make the request + await client.delete_product_review(request=request) + + +# [END merchantapi_v1_generated_ProductReviewsService_DeleteProductReview_async] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_delete_product_review_sync.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_delete_product_review_sync.py new file mode 100644 index 000000000000..4de2a2464645 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_delete_product_review_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 DeleteProductReview +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_DeleteProductReview_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_reviews_v1 + + +def sample_delete_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.DeleteProductReviewRequest( + name="name_value", + ) + + # Make the request + client.delete_product_review(request=request) + + +# [END merchantapi_v1_generated_ProductReviewsService_DeleteProductReview_sync] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_get_product_review_async.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_get_product_review_async.py new file mode 100644 index 000000000000..4523dc035b86 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_get_product_review_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 GetProductReview +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_GetProductReview_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_reviews_v1 + + +async def sample_get_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.GetProductReviewRequest( + name="name_value", + ) + + # Make the request + response = await client.get_product_review(request=request) + + # Handle the response + print(response) + + +# [END merchantapi_v1_generated_ProductReviewsService_GetProductReview_async] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_get_product_review_sync.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_get_product_review_sync.py new file mode 100644 index 000000000000..9aaedd89245b --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_get_product_review_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 GetProductReview +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_GetProductReview_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_reviews_v1 + + +def sample_get_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.GetProductReviewRequest( + name="name_value", + ) + + # Make the request + response = client.get_product_review(request=request) + + # Handle the response + print(response) + + +# [END merchantapi_v1_generated_ProductReviewsService_GetProductReview_sync] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_insert_product_review_async.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_insert_product_review_async.py new file mode 100644 index 000000000000..12451eda5bde --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_insert_product_review_async.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 InsertProductReview +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_InsertProductReview_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_reviews_v1 + + +async def sample_insert_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + product_review = merchant_reviews_v1.ProductReview() + product_review.product_review_id = "product_review_id_value" + + request = merchant_reviews_v1.InsertProductReviewRequest( + parent="parent_value", + product_review=product_review, + data_source="data_source_value", + ) + + # Make the request + response = await client.insert_product_review(request=request) + + # Handle the response + print(response) + + +# [END merchantapi_v1_generated_ProductReviewsService_InsertProductReview_async] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_insert_product_review_sync.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_insert_product_review_sync.py new file mode 100644 index 000000000000..2fc67a9cc5c2 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_insert_product_review_sync.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 InsertProductReview +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_InsertProductReview_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_reviews_v1 + + +def sample_insert_product_review(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + product_review = merchant_reviews_v1.ProductReview() + product_review.product_review_id = "product_review_id_value" + + request = merchant_reviews_v1.InsertProductReviewRequest( + parent="parent_value", + product_review=product_review, + data_source="data_source_value", + ) + + # Make the request + response = client.insert_product_review(request=request) + + # Handle the response + print(response) + + +# [END merchantapi_v1_generated_ProductReviewsService_InsertProductReview_sync] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_list_product_reviews_async.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_list_product_reviews_async.py new file mode 100644 index 000000000000..d8bcdbb149cf --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_list_product_reviews_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 ListProductReviews +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_ListProductReviews_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_reviews_v1 + + +async def sample_list_product_reviews(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.ListProductReviewsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_product_reviews(request=request) + + # Handle the response + async for response in page_result: + print(response) + + +# [END merchantapi_v1_generated_ProductReviewsService_ListProductReviews_async] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_list_product_reviews_sync.py b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_list_product_reviews_sync.py new file mode 100644 index 000000000000..5e32ca768297 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/merchantapi_v1_generated_product_reviews_service_list_product_reviews_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 ListProductReviews +# 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-reviews + + +# [START merchantapi_v1_generated_ProductReviewsService_ListProductReviews_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_reviews_v1 + + +def sample_list_product_reviews(): + # Create a client + client = merchant_reviews_v1.ProductReviewsServiceClient() + + # Initialize request argument(s) + request = merchant_reviews_v1.ListProductReviewsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_product_reviews(request=request) + + # Handle the response + for response in page_result: + print(response) + + +# [END merchantapi_v1_generated_ProductReviewsService_ListProductReviews_sync] diff --git a/packages/google-shopping-merchant-reviews/samples/generated_samples/snippet_metadata_google.shopping.merchant.reviews.v1.json b/packages/google-shopping-merchant-reviews/samples/generated_samples/snippet_metadata_google.shopping.merchant.reviews.v1.json new file mode 100644 index 000000000000..c5a6df2b9628 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/samples/generated_samples/snippet_metadata_google.shopping.merchant.reviews.v1.json @@ -0,0 +1,645 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.shopping.merchant.reviews.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-shopping-merchant-reviews", + "version": "0.6.1" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient", + "shortName": "ProductReviewsServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient.delete_product_review", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.DeleteProductReview", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "DeleteProductReview" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.DeleteProductReviewRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_product_review" + }, + "description": "Sample for DeleteProductReview", + "file": "merchantapi_v1_generated_product_reviews_service_delete_product_review_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_DeleteProductReview_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_delete_product_review_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient", + "shortName": "ProductReviewsServiceClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient.delete_product_review", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.DeleteProductReview", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "DeleteProductReview" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.DeleteProductReviewRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_product_review" + }, + "description": "Sample for DeleteProductReview", + "file": "merchantapi_v1_generated_product_reviews_service_delete_product_review_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_DeleteProductReview_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_delete_product_review_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient", + "shortName": "ProductReviewsServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient.get_product_review", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.GetProductReview", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "GetProductReview" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.GetProductReviewRequest" + }, + { + "name": "name", + "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_reviews_v1.types.ProductReview", + "shortName": "get_product_review" + }, + "description": "Sample for GetProductReview", + "file": "merchantapi_v1_generated_product_reviews_service_get_product_review_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_GetProductReview_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_get_product_review_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient", + "shortName": "ProductReviewsServiceClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient.get_product_review", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.GetProductReview", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "GetProductReview" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.GetProductReviewRequest" + }, + { + "name": "name", + "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_reviews_v1.types.ProductReview", + "shortName": "get_product_review" + }, + "description": "Sample for GetProductReview", + "file": "merchantapi_v1_generated_product_reviews_service_get_product_review_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_GetProductReview_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_get_product_review_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient", + "shortName": "ProductReviewsServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient.insert_product_review", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.InsertProductReview", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "InsertProductReview" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.InsertProductReviewRequest" + }, + { + "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_reviews_v1.types.ProductReview", + "shortName": "insert_product_review" + }, + "description": "Sample for InsertProductReview", + "file": "merchantapi_v1_generated_product_reviews_service_insert_product_review_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_InsertProductReview_async", + "segments": [ + { + "end": 56, + "start": 27, + "type": "FULL" + }, + { + "end": 56, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 57, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_insert_product_review_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient", + "shortName": "ProductReviewsServiceClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient.insert_product_review", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.InsertProductReview", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "InsertProductReview" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.InsertProductReviewRequest" + }, + { + "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_reviews_v1.types.ProductReview", + "shortName": "insert_product_review" + }, + "description": "Sample for InsertProductReview", + "file": "merchantapi_v1_generated_product_reviews_service_insert_product_review_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_InsertProductReview_sync", + "segments": [ + { + "end": 56, + "start": 27, + "type": "FULL" + }, + { + "end": 56, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 57, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_insert_product_review_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient", + "shortName": "ProductReviewsServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceAsyncClient.list_product_reviews", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.ListProductReviews", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "ListProductReviews" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.ListProductReviewsRequest" + }, + { + "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_reviews_v1.services.product_reviews_service.pagers.ListProductReviewsAsyncPager", + "shortName": "list_product_reviews" + }, + "description": "Sample for ListProductReviews", + "file": "merchantapi_v1_generated_product_reviews_service_list_product_reviews_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_ListProductReviews_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_list_product_reviews_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient", + "shortName": "ProductReviewsServiceClient" + }, + "fullName": "google.shopping.merchant_reviews_v1.ProductReviewsServiceClient.list_product_reviews", + "method": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService.ListProductReviews", + "service": { + "fullName": "google.shopping.merchant.reviews.v1.ProductReviewsService", + "shortName": "ProductReviewsService" + }, + "shortName": "ListProductReviews" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_reviews_v1.types.ListProductReviewsRequest" + }, + { + "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_reviews_v1.services.product_reviews_service.pagers.ListProductReviewsPager", + "shortName": "list_product_reviews" + }, + "description": "Sample for ListProductReviews", + "file": "merchantapi_v1_generated_product_reviews_service_list_product_reviews_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_ProductReviewsService_ListProductReviews_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_product_reviews_service_list_product_reviews_sync.py" + } + ] +} diff --git a/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/__init__.py b/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/__init__.py new file mode 100644 index 000000000000..32b36c5c4fe0 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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-reviews/tests/unit/gapic/merchant_reviews_v1/test_compat.py b/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/test_compat.py new file mode 100644 index 000000000000..f0a84b619162 --- /dev/null +++ b/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/test_compat.py @@ -0,0 +1,429 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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. +# +"""Tests for the compatibility module for older versions of google-api-core.""" + +import json +import os +from unittest import mock + +import google.auth.transport.mtls +import pytest +from google.api_core.universe import EmptyUniverseError +from google.auth.exceptions import MutualTLSChannelError +from google.protobuf import descriptor_pb2 + +from google.shopping.merchant_reviews_v1._compat import ( + get_api_endpoint, + get_default_mtls_endpoint, + get_universe_domain, + read_environment_variables, + should_use_client_cert, + transcode_request, +) + + +def test_get_universe_domain(): + # When universe_domain is provided + assert get_universe_domain("foo.com", default_universe="default.com") == "foo.com" + assert ( + get_universe_domain(" foo.com ", default_universe="default.com") == "foo.com" + ) + + # When universe_domain is None, falls back to default_universe + assert get_universe_domain(None, default_universe="default.com") == "default.com" + + # When multiple potential universes are provided, resolves in order of preference + assert ( + get_universe_domain("foo.com", "bar.com", default_universe="default.com") + == "foo.com" + ) + assert ( + get_universe_domain(None, "bar.com", default_universe="default.com") + == "bar.com" + ) + assert ( + get_universe_domain(None, None, default_universe="default.com") == "default.com" + ) + + # EmptyUniverseError raised when resolved value is empty string + with pytest.raises(EmptyUniverseError) as excinfo: + get_universe_domain("", default_universe="default.com") + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + with pytest.raises(EmptyUniverseError) as excinfo: + get_universe_domain(" ", default_universe="default.com") + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + with pytest.raises(EmptyUniverseError) as excinfo: + get_universe_domain(None, "", default_universe="default.com") + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +def test_get_default_mtls_endpoint(): + # Test valid API endpoints + assert get_default_mtls_endpoint("foo.googleapis.com") == "foo.mtls.googleapis.com" + assert ( + get_default_mtls_endpoint("foo.sandbox.googleapis.com") + == "foo.mtls.sandbox.googleapis.com" + ) + # Test case-insensitivity + assert get_default_mtls_endpoint("foo.GoogleAPIs.com") == "foo.mtls.googleapis.com" + assert ( + get_default_mtls_endpoint("foo.Sandbox.GoogleAPIs.com") + == "foo.mtls.sandbox.googleapis.com" + ) + + # Test valid API endpoints with schemes + assert ( + get_default_mtls_endpoint("https://foo.googleapis.com") + == "https://foo.mtls.googleapis.com" + ) + assert ( + get_default_mtls_endpoint("http://foo.googleapis.com:8080/v1") + == "http://foo.mtls.googleapis.com:8080/v1" + ) + + # Test valid API endpoints with ports + assert ( + get_default_mtls_endpoint("foo.googleapis.com:443") + == "foo.mtls.googleapis.com:443" + ) + assert ( + get_default_mtls_endpoint("foo.sandbox.googleapis.com:443") + == "foo.mtls.sandbox.googleapis.com:443" + ) + # Test case-insensitivity with ports + assert ( + get_default_mtls_endpoint("foo.GoogleAPIs.com:443") + == "foo.mtls.googleapis.com:443" + ) + assert ( + get_default_mtls_endpoint("foo.Sandbox.GoogleAPIs.com:443") + == "foo.mtls.sandbox.googleapis.com:443" + ) + + # Test endpoints that shouldn't be converted + assert ( + get_default_mtls_endpoint("foo.mtls.googleapis.com") + == "foo.mtls.googleapis.com" + ) + assert get_default_mtls_endpoint("foo.com") == "foo.com" + assert get_default_mtls_endpoint("foo.com:8080") == "foo.com:8080" + + # Test empty/None endpoints + assert get_default_mtls_endpoint("") == "" + assert get_default_mtls_endpoint(None) is None + + # Test endpoints without host + assert get_default_mtls_endpoint("http://") == "http://" + assert get_default_mtls_endpoint("https://") == "https://" + + +@pytest.mark.parametrize( + "api_override,universe_domain,default_universe,default_mtls_endpoint,default_endpoint_template,use_mtls,expected", + [ + ( + "foo.com", + "googleapis.com", + "googleapis.com", + "foo.mtls.googleapis.com", + "foo.{UNIVERSE_DOMAIN}", + True, + "foo.com", + ), + ( + None, + "googleapis.com", + "googleapis.com", + "foo.mtls.googleapis.com", + "foo.{UNIVERSE_DOMAIN}", + True, + "foo.mtls.googleapis.com", + ), + ( + None, + "googleapis.com", + "googleapis.com", + "foo.mtls.googleapis.com", + "foo.{UNIVERSE_DOMAIN}", + False, + "foo.googleapis.com", + ), + ( + None, + "bar.com", + "googleapis.com", + "foo.mtls.googleapis.com", + "foo.{UNIVERSE_DOMAIN}", + True, + MutualTLSChannelError, + ), + ( + None, + "googleapis.com", + "googleapis.com", + None, + "foo.{UNIVERSE_DOMAIN}", + True, + ValueError, + ), + ], +) +def test_get_api_endpoint( + api_override, + universe_domain, + default_universe, + default_mtls_endpoint, + default_endpoint_template, + use_mtls, + expected, +): + if isinstance(expected, type) and issubclass(expected, Exception): + with pytest.raises(expected): + get_api_endpoint( + api_override, + universe_domain, + default_universe, + default_mtls_endpoint, + default_endpoint_template, + use_mtls, + ) + else: + assert ( + get_api_endpoint( + api_override, + universe_domain, + default_universe, + default_mtls_endpoint, + default_endpoint_template, + use_mtls, + ) + == expected + ) + + +def test_should_use_client_cert_fallback_env(): + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}, clear=True + ): + assert should_use_client_cert() is True + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}, clear=True + ): + assert should_use_client_cert() is False + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "invalid"}, clear=True + ): + if not hasattr(google.auth.transport.mtls, "should_use_client_cert"): + with pytest.raises( + ValueError, + match="Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`", + ): + should_use_client_cert() + + +def test_transcode_basic(): + # We use FieldDescriptorProto as it has standard primitive fields and nested messages. + http_options = [ + { + "method": "get", + "uri": "/v1/test/{name}", + } + ] + + request = descriptor_pb2.FieldDescriptorProto() + request.name = "my-field" + request.number = 123 + + transcoded, body, query_params = transcode_request(http_options, request) + + assert transcoded["method"] == "get" + assert transcoded["uri"] == "/v1/test/my-field" + assert body is None + # 'number' should be in query parameters + assert "number" in query_params + assert query_params["number"] == 123 + + +def test_transcode_with_nested_field(): + http_options = [ + { + "method": "get", + "uri": "/v1/test/{options.deprecated}/{name}", + } + ] + + request = descriptor_pb2.FieldDescriptorProto() + request.name = "my-field" + request.options.deprecated = True + request.number = 123 + + transcoded, body, query_params = transcode_request(http_options, request) + + assert transcoded["method"] == "get" + assert transcoded["uri"] == "/v1/test/True/my-field" + assert body is None + assert "number" in query_params + assert query_params["number"] == 123 + + +def test_transcode_with_body(): + http_options = [ + { + "method": "post", + "uri": "/v1/test/{name}", + "body": "options", + } + ] + + request = descriptor_pb2.FieldDescriptorProto() + request.name = "my-field" + request.options.deprecated = True + request.number = 123 + + transcoded, body, query_params = transcode_request(http_options, request) + + assert transcoded["method"] == "post" + assert transcoded["uri"] == "/v1/test/my-field" + assert body is not None + body_data = json.loads(body) + assert body_data["deprecated"] is True + # Query parameters should not contain 'options' (the body) + assert "number" in query_params + assert query_params["number"] == 123 + assert "options" not in query_params + + +def test_transcode_with_required_fields_default_values(): + http_options = [ + { + "method": "get", + "uri": "/v1/test/{name}", + } + ] + + request = descriptor_pb2.FieldDescriptorProto() + request.name = "my-field" + + required_defaults = {"requiredQueryParam": "default-val"} + + transcoded, body, query_params = transcode_request( + http_options, + request, + required_fields_default_values=required_defaults, + ) + + assert query_params["requiredQueryParam"] == "default-val" + + +def test_transcode_with_numeric_enums(): + http_options = [ + { + "method": "get", + "uri": "/v1/test/{name}", + } + ] + + request = descriptor_pb2.FieldDescriptorProto() + request.name = "my-field" + request.type = descriptor_pb2.FieldDescriptorProto.TYPE_STRING + + # Without numeric enums + _, _, query_params = transcode_request( + http_options, request, rest_numeric_enums=False + ) + assert query_params["type"] == "TYPE_STRING" + + # With numeric enums + _, _, query_params = transcode_request( + http_options, request, rest_numeric_enums=True + ) + # Type number for TYPE_STRING is 9 + assert query_params["type"] == 9 + assert query_params["$alt"] == "json;enum-encoding=int" + + +def test_transcode_no_query_params(): + http_options = [{"method": "get", "uri": "/v1/test"}] + request = descriptor_pb2.FieldDescriptorProto() + + with mock.patch( + "google.api_core.path_template.transcode", + return_value={"method": "get", "uri": "/v1/test"}, + ): + transcoded, body, query_params = transcode_request(http_options, request) + assert query_params == {} + + +def test_transcode_with_required_fields_existing_key(): + http_options = [ + { + "method": "get", + "uri": "/v1/test", + } + ] + + request = descriptor_pb2.FieldDescriptorProto() + request.name = "custom-name" + + required_defaults = {"name": "default-name"} + + transcoded, body, query_params = transcode_request( + http_options, + request, + required_fields_default_values=required_defaults, + ) + + assert query_params["name"] == "custom-name" + + +def test_transcode_request_invalid_request(): + http_options = [{"method": "get", "uri": "/v1/test"}] + with pytest.raises(TypeError, match="request cannot be None"): + transcode_request(http_options, None) + + +def test_transcode_request_proto_plus_wrapper(): + http_options = [{"method": "get", "uri": "/v1/test/{name}"}] + mock_pb = descriptor_pb2.FieldDescriptorProto() + mock_pb.name = "proto-plus-field" + + mock_proto_plus = mock.Mock() + mock_proto_plus._pb = mock_pb + + transcoded, _, _ = transcode_request(http_options, mock_proto_plus) + assert transcoded["uri"] == "/v1/test/proto-plus-field" + + +def test_read_environment_variables(): + with mock.patch.dict( + os.environ, + { + "GOOGLE_API_USE_CLIENT_CERTIFICATE": "true", + "GOOGLE_API_USE_MTLS_ENDPOINT": "always", + "GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com", + }, + ): + use_cert, mtls_endpoint, universe_domain = read_environment_variables() + assert use_cert is True + assert mtls_endpoint == "always" + assert universe_domain == "foo.com" + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "invalid"}): + with pytest.raises(MutualTLSChannelError): + read_environment_variables() diff --git a/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/test_product_reviews_service.py b/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/test_product_reviews_service.py new file mode 100644 index 000000000000..83f95a6166cb --- /dev/null +++ b/packages/google-shopping-merchant-reviews/tests/unit/gapic/merchant_reviews_v1/test_product_reviews_service.py @@ -0,0 +1,5083 @@ +# -*- coding: utf-8 -*- +# Copyright 2026 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 asyncio +import json +import math +import os +from collections.abc import AsyncIterable, Iterable, Mapping, Sequence +from unittest import mock +from unittest.mock import AsyncMock + +import grpc +import pytest +from google.api_core import api_core_version +from google.protobuf import json_format +from grpc.experimental import aio +from proto.marshal.rules import wrappers +from proto.marshal.rules.dates import DurationRule, TimestampRule +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 + +import google.auth +import google.protobuf.timestamp_pb2 as timestamp_pb2 # type: ignore +from google.api_core import ( + client_options, + gapic_v1, + grpc_helpers, + grpc_helpers_async, + path_template, +) +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account +from google.shopping.type.types import types + +from google.shopping.merchant_reviews_v1.services.product_reviews_service import ( + ProductReviewsServiceAsyncClient, + ProductReviewsServiceClient, + pagers, + transports, +) +from google.shopping.merchant_reviews_v1.types import ( + productreviews, + productreviews_common, +) + +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) + + +@pytest.fixture(autouse=True) +def disable_mtls_env(): + with mock.patch.dict( + os.environ, + { + "GOOGLE_API_USE_CLIENT_CERTIFICATE": "false", + "CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE": "false", + }, + ): + yield + + +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 + ) + + +@pytest.fixture(autouse=True) +def set_event_loop(): + try: + asyncio.get_running_loop() + yield + except RuntimeError: + loop = asyncio.new_event_loop() + asyncio.set_event_loop(loop) + try: + yield + finally: + loop.close() + asyncio.set_event_loop(None) + + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert ProductReviewsServiceClient._get_client_cert_source(None, False) is None + assert ( + ProductReviewsServiceClient._get_client_cert_source( + mock_provided_cert_source, False + ) + is None + ) + assert ( + ProductReviewsServiceClient._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 ( + ProductReviewsServiceClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + ProductReviewsServiceClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@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 = ProductReviewsServiceClient(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 = ProductReviewsServiceClient(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", + [ + (ProductReviewsServiceClient, "grpc"), + (ProductReviewsServiceAsyncClient, "grpc_asyncio"), + (ProductReviewsServiceClient, "rest"), + ], +) +def test_product_reviews_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.ProductReviewsServiceGrpcTransport, "grpc"), + (transports.ProductReviewsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ProductReviewsServiceRestTransport, "rest"), + ], +) +def test_product_reviews_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", + [ + (ProductReviewsServiceClient, "grpc"), + (ProductReviewsServiceAsyncClient, "grpc_asyncio"), + (ProductReviewsServiceClient, "rest"), + ], +) +def test_product_reviews_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_product_reviews_service_client_get_transport_class(): + transport = ProductReviewsServiceClient.get_transport_class() + available_transports = [ + transports.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceRestTransport, + ] + assert transport in available_transports + + transport = ProductReviewsServiceClient.get_transport_class("grpc") + assert transport == transports.ProductReviewsServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceGrpcTransport, + "grpc", + ), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceRestTransport, + "rest", + ), + ], +) +@mock.patch.object( + ProductReviewsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ProductReviewsServiceClient), +) +@mock.patch.object( + ProductReviewsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ProductReviewsServiceAsyncClient), +) +def test_product_reviews_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(ProductReviewsServiceClient, "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(ProductReviewsServiceClient, "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 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", + [ + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceGrpcTransport, + "grpc", + "true", + ), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceGrpcTransport, + "grpc", + "false", + ), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceRestTransport, + "rest", + "true", + ), + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceRestTransport, + "rest", + "false", + ), + ], +) +@mock.patch.object( + ProductReviewsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ProductReviewsServiceClient), +) +@mock.patch.object( + ProductReviewsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ProductReviewsServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_product_reviews_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", [ProductReviewsServiceClient, ProductReviewsServiceAsyncClient] +) +@mock.patch.object( + ProductReviewsServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(ProductReviewsServiceClient), +) +@mock.patch.object( + ProductReviewsServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(ProductReviewsServiceAsyncClient), +) +def test_product_reviews_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_CLIENT_CERTIFICATE is "Unsupported". + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + if hasattr(google.auth.transport.mtls, "should_use_client_cert"): + 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 cases for mTLS enablement when GOOGLE_API_USE_CLIENT_CERTIFICATE is unset. + test_cases = [ + ( + # With workloads present in config, mTLS is enabled. + { + "version": 1, + "cert_configs": { + "workload": { + "cert_path": "path/to/cert/file", + "key_path": "path/to/key/file", + } + }, + }, + mock_client_cert_source, + ), + ( + # With workloads not present in config, mTLS is disabled. + { + "version": 1, + "cert_configs": {}, + }, + None, + ), + ] + if hasattr(google.auth.transport.mtls, "should_use_client_cert"): + for config_data, expected_cert_source in test_cases: + env = os.environ.copy() + env.pop("GOOGLE_API_USE_CLIENT_CERTIFICATE", None) + env.pop("CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE", None) + with mock.patch.dict(os.environ, env, clear=True): + config_filename = "mock_certificate_config.json" + config_file_content = json.dumps(config_data) + m = mock.mock_open(read_data=config_file_content) + with ( + mock.patch("builtins.open", m), + mock.patch( + "os.path.exists", + side_effect=lambda path: os.path.basename(path) + == config_filename, + ), + ): + with mock.patch.dict( + os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename} + ): + 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 expected_cert_source + + # Test cases for mTLS enablement when GOOGLE_API_USE_CLIENT_CERTIFICATE is unset(empty). + test_cases = [ + ( + # With workloads present in config, mTLS is enabled. + { + "version": 1, + "cert_configs": { + "workload": { + "cert_path": "path/to/cert/file", + "key_path": "path/to/key/file", + } + }, + }, + mock_client_cert_source, + ), + ( + # With workloads not present in config, mTLS is disabled. + { + "version": 1, + "cert_configs": {}, + }, + None, + ), + ] + if hasattr(google.auth.transport.mtls, "should_use_client_cert"): + for config_data, expected_cert_source in test_cases: + env = os.environ.copy() + env.pop("GOOGLE_API_USE_CLIENT_CERTIFICATE", "") + env.pop("CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE", "") + with mock.patch.dict(os.environ, env, clear=True): + config_filename = "mock_certificate_config.json" + config_file_content = json.dumps(config_data) + m = mock.mock_open(read_data=config_file_content) + with ( + mock.patch("builtins.open", m), + mock.patch( + "os.path.exists", + side_effect=lambda path: os.path.basename(path) + == config_filename, + ), + ): + with mock.patch.dict( + os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename} + ): + 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 expected_cert_source + + # 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`" + ) + + +@pytest.mark.parametrize( + "client_class", [ProductReviewsServiceClient, ProductReviewsServiceAsyncClient] +) +@mock.patch.object( + ProductReviewsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ProductReviewsServiceClient), +) +@mock.patch.object( + ProductReviewsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(ProductReviewsServiceAsyncClient), +) +def test_product_reviews_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = ProductReviewsServiceClient._DEFAULT_UNIVERSE + default_endpoint = ProductReviewsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = ProductReviewsServiceClient._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", + [ + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceGrpcTransport, + "grpc", + ), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceRestTransport, + "rest", + ), + ], +) +def test_product_reviews_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", + [ + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceRestTransport, + "rest", + None, + ), + ], +) +def test_product_reviews_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_product_reviews_service_client_client_options_from_dict(): + with mock.patch( + "google.shopping.merchant_reviews_v1.services.product_reviews_service.transports.ProductReviewsServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = ProductReviewsServiceClient( + 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", + [ + ( + ProductReviewsServiceClient, + transports.ProductReviewsServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_product_reviews_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", + [ + productreviews.GetProductReviewRequest(), + {}, + ], +) +def test_get_product_review(request_type, transport: str = "grpc"): + client = ProductReviewsServiceClient( + 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.get_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_value", + ) + response = client.get_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = productreviews.GetProductReviewRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, productreviews.ProductReview) + assert response.name == "name_value" + assert response.product_review_id == "product_review_id_value" + assert response.data_source == "data_source_value" + + +def test_get_product_review_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 = ProductReviewsServiceClient( + 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 = productreviews.GetProductReviewRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_product_review(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.GetProductReviewRequest( + name="name_value", + ) + assert args[0] == request_msg + + +def test_get_product_review_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 = ProductReviewsServiceClient( + 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.get_product_review 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.get_product_review] = ( + mock_rpc + ) + request = {} + client.get_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_product_review(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_get_product_review_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 = ProductReviewsServiceAsyncClient( + 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.get_product_review + 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.get_product_review + ] = mock_rpc + + request = {} + await client.get_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_product_review(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 +@pytest.mark.parametrize( + "request_type", + [ + productreviews.GetProductReviewRequest(), + {}, + ], +) +async def test_get_product_review_async(request_type, transport: str = "grpc_asyncio"): + client = ProductReviewsServiceAsyncClient( + 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.get_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_value", + ) + ) + response = await client.get_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = productreviews.GetProductReviewRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, productreviews.ProductReview) + assert response.name == "name_value" + assert response.product_review_id == "product_review_id_value" + assert response.data_source == "data_source_value" + + +def test_get_product_review_field_headers(): + client = ProductReviewsServiceClient( + 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 = productreviews.GetProductReviewRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + call.return_value = productreviews.ProductReview() + client.get_product_review(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", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_product_review_field_headers_async(): + client = ProductReviewsServiceAsyncClient( + 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 = productreviews.GetProductReviewRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview() + ) + await client.get_product_review(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", + "name=name_value", + ) in kw["metadata"] + + +def test_get_product_review_flattened(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ProductReview() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_product_review( + name="name_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].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_product_review_flattened_error(): + client = ProductReviewsServiceClient( + 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.get_product_review( + productreviews.GetProductReviewRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_product_review_flattened_async(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ProductReview() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_product_review( + name="name_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].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_product_review_flattened_error_async(): + client = ProductReviewsServiceAsyncClient( + 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.get_product_review( + productreviews.GetProductReviewRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.ListProductReviewsRequest(), + {}, + ], +) +def test_list_product_reviews(request_type, transport: str = "grpc"): + client = ProductReviewsServiceClient( + 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.list_product_reviews), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ListProductReviewsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_product_reviews(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = productreviews.ListProductReviewsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductReviewsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_product_reviews_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 = ProductReviewsServiceClient( + 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 = productreviews.ListProductReviewsRequest( + parent="parent_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.list_product_reviews), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_product_reviews(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.ListProductReviewsRequest( + parent="parent_value", + page_token="page_token_value", + ) + assert args[0] == request_msg + + +def test_list_product_reviews_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 = ProductReviewsServiceClient( + 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.list_product_reviews 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.list_product_reviews] = ( + mock_rpc + ) + request = {} + client.list_product_reviews(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_product_reviews(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_list_product_reviews_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 = ProductReviewsServiceAsyncClient( + 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.list_product_reviews + 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.list_product_reviews + ] = mock_rpc + + request = {} + await client.list_product_reviews(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_product_reviews(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 +@pytest.mark.parametrize( + "request_type", + [ + productreviews.ListProductReviewsRequest(), + {}, + ], +) +async def test_list_product_reviews_async( + request_type, transport: str = "grpc_asyncio" +): + client = ProductReviewsServiceAsyncClient( + 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.list_product_reviews), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ListProductReviewsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_product_reviews(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = productreviews.ListProductReviewsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductReviewsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_product_reviews_field_headers(): + client = ProductReviewsServiceClient( + 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 = productreviews.ListProductReviewsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + call.return_value = productreviews.ListProductReviewsResponse() + client.list_product_reviews(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_list_product_reviews_field_headers_async(): + client = ProductReviewsServiceAsyncClient( + 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 = productreviews.ListProductReviewsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ListProductReviewsResponse() + ) + await client.list_product_reviews(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_list_product_reviews_flattened(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ListProductReviewsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_product_reviews( + 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_list_product_reviews_flattened_error(): + client = ProductReviewsServiceClient( + 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.list_product_reviews( + productreviews.ListProductReviewsRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_product_reviews_flattened_async(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ListProductReviewsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ListProductReviewsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_product_reviews( + 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_list_product_reviews_flattened_error_async(): + client = ProductReviewsServiceAsyncClient( + 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.list_product_reviews( + productreviews.ListProductReviewsRequest(), + parent="parent_value", + ) + + +def test_list_product_reviews_pager(transport_name: str = "grpc"): + client = ProductReviewsServiceClient( + 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.list_product_reviews), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + next_page_token="abc", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[], + next_page_token="def", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + ], + next_page_token="ghi", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_product_reviews(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + assert pager.next_page_token == "abc" + assert str(pager).startswith(f"{pager.__class__.__name__}<") + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, productreviews.ProductReview) for i in results) + + +def test_list_product_reviews_pages(transport_name: str = "grpc"): + client = ProductReviewsServiceClient( + 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.list_product_reviews), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + next_page_token="abc", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[], + next_page_token="def", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + ], + next_page_token="ghi", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + ), + RuntimeError, + ) + pages = list(client.list_product_reviews(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_list_product_reviews_async_pager(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + next_page_token="abc", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[], + next_page_token="def", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + ], + next_page_token="ghi", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_product_reviews( + request={}, + ) + assert async_pager.next_page_token == "abc" + assert str(async_pager).startswith(f"{async_pager.__class__.__name__}<") + + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, productreviews.ProductReview) for i in responses) + + +@pytest.mark.asyncio +async def test_list_product_reviews_async_pages(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + next_page_token="abc", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[], + next_page_token="def", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + ], + next_page_token="ghi", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_product_reviews(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.InsertProductReviewRequest(), + {}, + ], +) +def test_insert_product_review(request_type, transport: str = "grpc"): + client = ProductReviewsServiceClient( + 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.insert_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_value", + ) + response = client.insert_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = productreviews.InsertProductReviewRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, productreviews.ProductReview) + assert response.name == "name_value" + assert response.product_review_id == "product_review_id_value" + assert response.data_source == "data_source_value" + + +def test_insert_product_review_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 = ProductReviewsServiceClient( + 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 = productreviews.InsertProductReviewRequest( + parent="parent_value", + data_source="data_source_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.insert_product_review), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.insert_product_review(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.InsertProductReviewRequest( + parent="parent_value", + data_source="data_source_value", + ) + assert args[0] == request_msg + + +def test_insert_product_review_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 = ProductReviewsServiceClient( + 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.insert_product_review + 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.insert_product_review] = ( + mock_rpc + ) + request = {} + client.insert_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.insert_product_review(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_insert_product_review_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 = ProductReviewsServiceAsyncClient( + 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.insert_product_review + 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.insert_product_review + ] = mock_rpc + + request = {} + await client.insert_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.insert_product_review(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 +@pytest.mark.parametrize( + "request_type", + [ + productreviews.InsertProductReviewRequest(), + {}, + ], +) +async def test_insert_product_review_async( + request_type, transport: str = "grpc_asyncio" +): + client = ProductReviewsServiceAsyncClient( + 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.insert_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_value", + ) + ) + response = await client.insert_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = productreviews.InsertProductReviewRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, productreviews.ProductReview) + assert response.name == "name_value" + assert response.product_review_id == "product_review_id_value" + assert response.data_source == "data_source_value" + + +def test_insert_product_review_field_headers(): + client = ProductReviewsServiceClient( + 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 = productreviews.InsertProductReviewRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.insert_product_review), "__call__" + ) as call: + call.return_value = productreviews.ProductReview() + client.insert_product_review(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_insert_product_review_field_headers_async(): + client = ProductReviewsServiceAsyncClient( + 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 = productreviews.InsertProductReviewRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.insert_product_review), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview() + ) + await client.insert_product_review(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"] + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.DeleteProductReviewRequest(), + {}, + ], +) +def test_delete_product_review(request_type, transport: str = "grpc"): + client = ProductReviewsServiceClient( + 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.delete_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = productreviews.DeleteProductReviewRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_review_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 = ProductReviewsServiceClient( + 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 = productreviews.DeleteProductReviewRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.delete_product_review(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.DeleteProductReviewRequest( + name="name_value", + ) + assert args[0] == request_msg + + +def test_delete_product_review_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 = ProductReviewsServiceClient( + 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.delete_product_review + 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.delete_product_review] = ( + mock_rpc + ) + request = {} + client.delete_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_product_review(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_delete_product_review_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 = ProductReviewsServiceAsyncClient( + 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.delete_product_review + 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.delete_product_review + ] = mock_rpc + + request = {} + await client.delete_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.delete_product_review(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 +@pytest.mark.parametrize( + "request_type", + [ + productreviews.DeleteProductReviewRequest(), + {}, + ], +) +async def test_delete_product_review_async( + request_type, transport: str = "grpc_asyncio" +): + client = ProductReviewsServiceAsyncClient( + 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.delete_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = productreviews.DeleteProductReviewRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_product_review_field_headers(): + client = ProductReviewsServiceClient( + 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 = productreviews.DeleteProductReviewRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + call.return_value = None + client.delete_product_review(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", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_product_review_field_headers_async(): + client = ProductReviewsServiceAsyncClient( + 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 = productreviews.DeleteProductReviewRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_product_review(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", + "name=name_value", + ) in kw["metadata"] + + +def test_delete_product_review_flattened(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_product_review( + name="name_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].name + mock_val = "name_value" + assert arg == mock_val + + +def test_delete_product_review_flattened_error(): + client = ProductReviewsServiceClient( + 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.delete_product_review( + productreviews.DeleteProductReviewRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_product_review_flattened_async(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_product_review( + name="name_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].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_delete_product_review_flattened_error_async(): + client = ProductReviewsServiceAsyncClient( + 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.delete_product_review( + productreviews.DeleteProductReviewRequest(), + name="name_value", + ) + + +def test_get_product_review_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 = ProductReviewsServiceClient( + 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.get_product_review 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.get_product_review] = ( + mock_rpc + ) + + request = {} + client.get_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_product_review(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_get_product_review_rest_required_fields( + request_type=productreviews.GetProductReviewRequest, +): + transport_class = transports.ProductReviewsServiceRestTransport + + request_init = {} + request_init["name"] = "" + 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 + + default_values = getattr( + transport_class._BaseGetProductReview, + "_BaseGetProductReview__REQUIRED_FIELDS_DEFAULT_VALUES", + {}, + ) + unset_fields = { + k: v for k, v in default_values.items() if k not in jsonified_request + } + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = productreviews.ProductReview() + # 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": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = productreviews.ProductReview.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.get_product_review(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert sorted(expected_params) == sorted(actual_params) + + +def test_get_product_review_rest_flattened(): + client = ProductReviewsServiceClient( + 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 = productreviews.ProductReview() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1/productReviews/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_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 = productreviews.ProductReview.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.get_product_review(**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/reviews/v1/{name=accounts/*/productReviews/*}" % client.transport._host, + args[1], + ) + + +def test_get_product_review_rest_flattened_error(transport: str = "rest"): + client = ProductReviewsServiceClient( + 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.get_product_review( + productreviews.GetProductReviewRequest(), + name="name_value", + ) + + +def test_list_product_reviews_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 = ProductReviewsServiceClient( + 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.list_product_reviews 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.list_product_reviews] = ( + mock_rpc + ) + + request = {} + client.list_product_reviews(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_product_reviews(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_list_product_reviews_rest_required_fields( + request_type=productreviews.ListProductReviewsRequest, +): + transport_class = transports.ProductReviewsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + 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 + + default_values = getattr( + transport_class._BaseListProductReviews, + "_BaseListProductReviews__REQUIRED_FIELDS_DEFAULT_VALUES", + {}, + ) + unset_fields = { + k: v for k, v in default_values.items() if k not in jsonified_request + } + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "pageSize", + "pageToken", + ) + ) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = productreviews.ListProductReviewsResponse() + # 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": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = productreviews.ListProductReviewsResponse.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.list_product_reviews(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert sorted(expected_params) == sorted(actual_params) + + +def test_list_product_reviews_rest_flattened(): + client = ProductReviewsServiceClient( + 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 = productreviews.ListProductReviewsResponse() + + # 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 = productreviews.ListProductReviewsResponse.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.list_product_reviews(**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/reviews/v1/{parent=accounts/*}/productReviews" % client.transport._host, + args[1], + ) + + +def test_list_product_reviews_rest_flattened_error(transport: str = "rest"): + client = ProductReviewsServiceClient( + 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.list_product_reviews( + productreviews.ListProductReviewsRequest(), + parent="parent_value", + ) + + +def test_list_product_reviews_rest_pager(transport: str = "rest"): + client = ProductReviewsServiceClient( + 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 = ( + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + next_page_token="abc", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[], + next_page_token="def", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + ], + next_page_token="ghi", + ), + productreviews.ListProductReviewsResponse( + product_reviews=[ + productreviews.ProductReview(), + productreviews.ProductReview(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + productreviews.ListProductReviewsResponse.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.list_product_reviews(request=sample_request) + + assert pager.next_page_token == "abc" + assert str(pager).startswith(f"{pager.__class__.__name__}<") + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, productreviews.ProductReview) for i in results) + + pages = list(client.list_product_reviews(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_insert_product_review_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 = ProductReviewsServiceClient( + 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.insert_product_review + 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.insert_product_review] = ( + mock_rpc + ) + + request = {} + client.insert_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.insert_product_review(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_insert_product_review_rest_required_fields( + request_type=productreviews.InsertProductReviewRequest, +): + transport_class = transports.ProductReviewsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["data_source"] = "" + 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 + assert "dataSource" not in jsonified_request + + default_values = getattr( + transport_class._BaseInsertProductReview, + "_BaseInsertProductReview__REQUIRED_FIELDS_DEFAULT_VALUES", + {}, + ) + unset_fields = { + k: v for k, v in default_values.items() if k not in jsonified_request + } + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "dataSource" in jsonified_request + assert jsonified_request["dataSource"] == request_init["data_source"] + + jsonified_request["parent"] = "parent_value" + jsonified_request["dataSource"] = "data_source_value" + + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("dataSource",)) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + assert "dataSource" in jsonified_request + assert jsonified_request["dataSource"] == "data_source_value" + + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = productreviews.ProductReview() + # 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 = productreviews.ProductReview.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.insert_product_review(request) + + expected_params = [ + ( + "dataSource", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert sorted(expected_params) == sorted(actual_params) + + +def test_delete_product_review_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 = ProductReviewsServiceClient( + 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.delete_product_review + 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.delete_product_review] = ( + mock_rpc + ) + + request = {} + client.delete_product_review(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_product_review(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_delete_product_review_rest_required_fields( + request_type=productreviews.DeleteProductReviewRequest, +): + transport_class = transports.ProductReviewsServiceRestTransport + + request_init = {} + request_init["name"] = "" + 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 + + default_values = getattr( + transport_class._BaseDeleteProductReview, + "_BaseDeleteProductReview__REQUIRED_FIELDS_DEFAULT_VALUES", + {}, + ) + unset_fields = { + k: v for k, v in default_values.items() if k not in jsonified_request + } + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_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.delete_product_review(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert sorted(expected_params) == sorted(actual_params) + + +def test_delete_product_review_rest_flattened(): + client = ProductReviewsServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1/productReviews/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_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.delete_product_review(**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/reviews/v1/{name=accounts/*/productReviews/*}" % client.transport._host, + args[1], + ) + + +def test_delete_product_review_rest_flattened_error(transport: str = "rest"): + client = ProductReviewsServiceClient( + 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.delete_product_review( + productreviews.DeleteProductReviewRequest(), + name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ProductReviewsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ProductReviewsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductReviewsServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ProductReviewsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ProductReviewsServiceClient( + 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 = ProductReviewsServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ProductReviewsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ProductReviewsServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductReviewsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ProductReviewsServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ProductReviewsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ProductReviewsServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + transports.ProductReviewsServiceRestTransport, + ], +) +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 = ProductReviewsServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = ProductReviewsServiceClient( + 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_get_product_review_empty_call_grpc(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + call.return_value = productreviews.ProductReview() + client.get_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.GetProductReviewRequest() + assert args[0] == request_msg + + +# 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_list_product_reviews_empty_call_grpc(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + call.return_value = productreviews.ListProductReviewsResponse() + client.list_product_reviews(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.ListProductReviewsRequest() + assert args[0] == request_msg + + +# 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_insert_product_review_empty_call_grpc(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.insert_product_review), "__call__" + ) as call: + call.return_value = productreviews.ProductReview() + client.insert_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.InsertProductReviewRequest() + assert args[0] == request_msg + + +# 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_delete_product_review_empty_call_grpc(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + call.return_value = None + client.delete_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.DeleteProductReviewRequest() + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = ProductReviewsServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = ProductReviewsServiceAsyncClient( + 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_get_product_review_empty_call_grpc_asyncio(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_value", + ) + ) + await client.get_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.GetProductReviewRequest() + assert args[0] == request_msg + + +# 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_list_product_reviews_empty_call_grpc_asyncio(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ListProductReviewsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_product_reviews(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.ListProductReviewsRequest() + assert args[0] == request_msg + + +# 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_insert_product_review_empty_call_grpc_asyncio(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.insert_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_value", + ) + ) + await client.insert_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.InsertProductReviewRequest() + assert args[0] == request_msg + + +# 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_delete_product_review_empty_call_grpc_asyncio(): + client = ProductReviewsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.DeleteProductReviewRequest() + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = ProductReviewsServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_get_product_review_rest_bad_request( + request_type=productreviews.GetProductReviewRequest, +): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/productReviews/sample2"} + 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.get_product_review(request) + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.GetProductReviewRequest, + dict, + ], +) +def test_get_product_review_rest_call_success(request_type): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/productReviews/sample2"} + 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 = productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_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 = productreviews.ProductReview.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.get_product_review(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, productreviews.ProductReview) + assert response.name == "name_value" + assert response.product_review_id == "product_review_id_value" + assert response.data_source == "data_source_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_product_review_rest_interceptors(null_interceptor): + transport = transports.ProductReviewsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductReviewsServiceRestInterceptor(), + ) + client = ProductReviewsServiceClient(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.ProductReviewsServiceRestInterceptor, "post_get_product_review" + ) as post, + mock.patch.object( + transports.ProductReviewsServiceRestInterceptor, + "post_get_product_review_with_metadata", + ) as post_with_metadata, + mock.patch.object( + transports.ProductReviewsServiceRestInterceptor, "pre_get_product_review" + ) as pre, + ): + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = productreviews.GetProductReviewRequest.pb( + productreviews.GetProductReviewRequest() + ) + 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 = productreviews.ProductReview.to_json( + productreviews.ProductReview() + ) + req.return_value.content = return_value + + request = productreviews.GetProductReviewRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = productreviews.ProductReview() + post_with_metadata.return_value = productreviews.ProductReview(), metadata + + client.get_product_review( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_product_reviews_rest_bad_request( + request_type=productreviews.ListProductReviewsRequest, +): + client = ProductReviewsServiceClient( + 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.list_product_reviews(request) + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.ListProductReviewsRequest, + dict, + ], +) +def test_list_product_reviews_rest_call_success(request_type): + client = ProductReviewsServiceClient( + 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 = productreviews.ListProductReviewsResponse( + 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 = productreviews.ListProductReviewsResponse.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.list_product_reviews(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProductReviewsPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_product_reviews_rest_interceptors(null_interceptor): + transport = transports.ProductReviewsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductReviewsServiceRestInterceptor(), + ) + client = ProductReviewsServiceClient(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.ProductReviewsServiceRestInterceptor, "post_list_product_reviews" + ) as post, + mock.patch.object( + transports.ProductReviewsServiceRestInterceptor, + "post_list_product_reviews_with_metadata", + ) as post_with_metadata, + mock.patch.object( + transports.ProductReviewsServiceRestInterceptor, "pre_list_product_reviews" + ) as pre, + ): + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = productreviews.ListProductReviewsRequest.pb( + productreviews.ListProductReviewsRequest() + ) + 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 = productreviews.ListProductReviewsResponse.to_json( + productreviews.ListProductReviewsResponse() + ) + req.return_value.content = return_value + + request = productreviews.ListProductReviewsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = productreviews.ListProductReviewsResponse() + post_with_metadata.return_value = ( + productreviews.ListProductReviewsResponse(), + metadata, + ) + + client.list_product_reviews( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_insert_product_review_rest_bad_request( + request_type=productreviews.InsertProductReviewRequest, +): + client = ProductReviewsServiceClient( + 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.insert_product_review(request) + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.InsertProductReviewRequest, + dict, + ], +) +def test_insert_product_review_rest_call_success(request_type): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "accounts/sample1"} + request_init["product_review"] = { + "name": "name_value", + "product_review_id": "product_review_id_value", + "product_review_attributes": { + "aggregator_name": "aggregator_name_value", + "subclient_name": "subclient_name_value", + "publisher_name": "publisher_name_value", + "publisher_favicon": "publisher_favicon_value", + "reviewer_id": "reviewer_id_value", + "reviewer_is_anonymous": True, + "reviewer_username": "reviewer_username_value", + "review_language": "review_language_value", + "review_country": "review_country_value", + "review_time": {"seconds": 751, "nanos": 543}, + "title": "title_value", + "content": "content_value", + "pros": ["pros_value1", "pros_value2"], + "cons": ["cons_value1", "cons_value2"], + "review_link": {"type_": 1, "link": "link_value"}, + "reviewer_image_links": [ + "reviewer_image_links_value1", + "reviewer_image_links_value2", + ], + "min_rating": 1064, + "max_rating": 1066, + "rating": 0.645, + "product_names": ["product_names_value1", "product_names_value2"], + "product_links": ["product_links_value1", "product_links_value2"], + "asins": ["asins_value1", "asins_value2"], + "gtins": ["gtins_value1", "gtins_value2"], + "mpns": ["mpns_value1", "mpns_value2"], + "skus": ["skus_value1", "skus_value2"], + "brands": ["brands_value1", "brands_value2"], + "is_spam": True, + "is_verified_purchase": True, + "is_incentivized_review": True, + "collection_method": 1, + "transaction_id": "transaction_id_value", + }, + "custom_attributes": [ + {"name": "name_value", "value": "value_value", "group_values": {}} + ], + "data_source": "data_source_value", + "product_review_status": { + "destination_statuses": [{"reporting_context": 1}], + "item_level_issues": [ + { + "code": "code_value", + "severity": 1, + "resolution": "resolution_value", + "attribute": "attribute_value", + "reporting_context": 1, + "description": "description_value", + "detail": "detail_value", + "documentation": "documentation_value", + } + ], + "create_time": {}, + "last_update_time": {}, + }, + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = productreviews.InsertProductReviewRequest.meta.fields["product_review"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["product_review"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["product_review"][field])): + del request_init["product_review"][field][i][subfield] + else: + del request_init["product_review"][field][subfield] + 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 = productreviews.ProductReview( + name="name_value", + product_review_id="product_review_id_value", + data_source="data_source_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 = productreviews.ProductReview.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.insert_product_review(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, productreviews.ProductReview) + assert response.name == "name_value" + assert response.product_review_id == "product_review_id_value" + assert response.data_source == "data_source_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_insert_product_review_rest_interceptors(null_interceptor): + transport = transports.ProductReviewsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductReviewsServiceRestInterceptor(), + ) + client = ProductReviewsServiceClient(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.ProductReviewsServiceRestInterceptor, + "post_insert_product_review", + ) as post, + mock.patch.object( + transports.ProductReviewsServiceRestInterceptor, + "post_insert_product_review_with_metadata", + ) as post_with_metadata, + mock.patch.object( + transports.ProductReviewsServiceRestInterceptor, "pre_insert_product_review" + ) as pre, + ): + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = productreviews.InsertProductReviewRequest.pb( + productreviews.InsertProductReviewRequest() + ) + 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 = productreviews.ProductReview.to_json( + productreviews.ProductReview() + ) + req.return_value.content = return_value + + request = productreviews.InsertProductReviewRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = productreviews.ProductReview() + post_with_metadata.return_value = productreviews.ProductReview(), metadata + + client.insert_product_review( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_product_review_rest_bad_request( + request_type=productreviews.DeleteProductReviewRequest, +): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/productReviews/sample2"} + 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.delete_product_review(request) + + +@pytest.mark.parametrize( + "request_type", + [ + productreviews.DeleteProductReviewRequest, + dict, + ], +) +def test_delete_product_review_rest_call_success(request_type): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/productReviews/sample2"} + 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 = None + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + json_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.delete_product_review(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_product_review_rest_interceptors(null_interceptor): + transport = transports.ProductReviewsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ProductReviewsServiceRestInterceptor(), + ) + client = ProductReviewsServiceClient(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.ProductReviewsServiceRestInterceptor, "pre_delete_product_review" + ) as pre, + ): + pre.assert_not_called() + pb_message = productreviews.DeleteProductReviewRequest.pb( + productreviews.DeleteProductReviewRequest() + ) + 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"} + + request = productreviews.DeleteProductReviewRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_product_review( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_initialize_client_w_rest(): + client = ProductReviewsServiceClient( + 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_get_product_review_empty_call_rest(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_product_review), "__call__" + ) as call: + client.get_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.GetProductReviewRequest() + assert args[0] == request_msg + + +# 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_list_product_reviews_empty_call_rest(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_product_reviews), "__call__" + ) as call: + client.list_product_reviews(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.ListProductReviewsRequest() + assert args[0] == request_msg + + +# 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_insert_product_review_empty_call_rest(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.insert_product_review), "__call__" + ) as call: + client.insert_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.InsertProductReviewRequest() + assert args[0] == request_msg + + +# 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_delete_product_review_empty_call_rest(): + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_product_review), "__call__" + ) as call: + client.delete_product_review(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = productreviews.DeleteProductReviewRequest() + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ProductReviewsServiceGrpcTransport, + ) + + +def test_product_reviews_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ProductReviewsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_product_reviews_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.shopping.merchant_reviews_v1.services.product_reviews_service.transports.ProductReviewsServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.ProductReviewsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "get_product_review", + "list_product_reviews", + "insert_product_review", + "delete_product_review", + ) + 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_product_reviews_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_reviews_v1.services.product_reviews_service.transports.ProductReviewsServiceTransport._prep_wrapped_messages" + ) as Transport, + ): + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ProductReviewsServiceTransport( + 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_product_reviews_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_reviews_v1.services.product_reviews_service.transports.ProductReviewsServiceTransport._prep_wrapped_messages" + ) as Transport, + ): + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ProductReviewsServiceTransport() + adc.assert_called_once() + + +def test_product_reviews_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) + ProductReviewsServiceClient() + 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.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + ], +) +def test_product_reviews_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.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + transports.ProductReviewsServiceRestTransport, + ], +) +def test_product_reviews_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.ProductReviewsServiceGrpcTransport, grpc_helpers), + (transports.ProductReviewsServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_product_reviews_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.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + ], +) +def test_product_reviews_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_product_reviews_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.ProductReviewsServiceRestTransport( + 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_product_reviews_service_host_no_port(transport_name): + client = ProductReviewsServiceClient( + 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_product_reviews_service_host_with_port(transport_name): + client = ProductReviewsServiceClient( + 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_product_reviews_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ProductReviewsServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ProductReviewsServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.get_product_review._session + session2 = client2.transport.get_product_review._session + assert session1 != session2 + session1 = client1.transport.list_product_reviews._session + session2 = client2.transport.list_product_reviews._session + assert session1 != session2 + session1 = client1.transport.insert_product_review._session + session2 = client2.transport.insert_product_review._session + assert session1 != session2 + session1 = client1.transport.delete_product_review._session + session2 = client2.transport.delete_product_review._session + assert session1 != session2 + + +def test_product_reviews_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ProductReviewsServiceGrpcTransport( + 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_product_reviews_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ProductReviewsServiceGrpcAsyncIOTransport( + 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.filterwarnings("ignore::FutureWarning") +@pytest.mark.parametrize( + "transport_class", + [ + transports.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + ], +) +def test_product_reviews_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.ProductReviewsServiceGrpcTransport, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + ], +) +def test_product_reviews_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_product_review_path(): + account = "squid" + productreview = "clam" + expected = "accounts/{account}/productReviews/{productreview}".format( + account=account, + productreview=productreview, + ) + actual = ProductReviewsServiceClient.product_review_path(account, productreview) + assert expected == actual + + +def test_parse_product_review_path(): + expected = { + "account": "whelk", + "productreview": "octopus", + } + path = ProductReviewsServiceClient.product_review_path(**expected) + + # Check that the path construction is reversible. + actual = ProductReviewsServiceClient.parse_product_review_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = ProductReviewsServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = ProductReviewsServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = ProductReviewsServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = ProductReviewsServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = ProductReviewsServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = ProductReviewsServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = ProductReviewsServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = ProductReviewsServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = ProductReviewsServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format( + project=project, + ) + actual = ProductReviewsServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = ProductReviewsServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = ProductReviewsServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = ProductReviewsServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = ProductReviewsServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = ProductReviewsServiceClient.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.ProductReviewsServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = ProductReviewsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.ProductReviewsServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = ProductReviewsServiceClient.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 = ProductReviewsServiceClient( + 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 = ProductReviewsServiceAsyncClient( + 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 = ProductReviewsServiceClient( + 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 = ProductReviewsServiceClient( + 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", + [ + (ProductReviewsServiceClient, transports.ProductReviewsServiceGrpcTransport), + ( + ProductReviewsServiceAsyncClient, + transports.ProductReviewsServiceGrpcAsyncIOTransport, + ), + ], +) +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/release-please-bulk-config.json b/release-please-bulk-config.json index 86c480f3977a..df95ab1862f3 100644 --- a/release-please-bulk-config.json +++ b/release-please-bulk-config.json @@ -3880,7 +3880,13 @@ "component": "google-shopping-merchant-reviews", "extra-files": [ "google/shopping/merchant_reviews/gapic_version.py", + "google/shopping/merchant_reviews_v1/gapic_version.py", "google/shopping/merchant_reviews_v1beta/gapic_version.py", + { + "jsonpath": "$.clientLibrary.version", + "path": "samples/generated_samples/snippet_metadata_google.shopping.merchant.reviews.v1.json", + "type": "json" + }, { "jsonpath": "$.clientLibrary.version", "path": "samples/generated_samples/snippet_metadata_google.shopping.merchant.reviews.v1beta.json",