As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.shopping.merchant_accounts_v1.services.regions_service.async_client
# -*- 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_accounts_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
import google.protobuf.field_mask_pb2 as field_mask_pb2 # type: ignore
import google.protobuf.wrappers_pb2 as wrappers_pb2 # type: ignore
from google.shopping.merchant_accounts_v1.services.regions_service import pagers
from google.shopping.merchant_accounts_v1.types import regions
from .client import RegionsServiceClient
from .transports.base import DEFAULT_CLIENT_INFO, RegionsServiceTransport
from .transports.grpc_asyncio import RegionsServiceGrpcAsyncIOTransport
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__)
[docs]class RegionsServiceAsyncClient:
"""Manages regions configuration.
This API defines the following resource model:
- [Region][google.shopping.merchant.accounts.v1.Region]
"""
_client: RegionsServiceClient
# Copy defaults from the synchronous client for use here.
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
DEFAULT_ENDPOINT = RegionsServiceClient.DEFAULT_ENDPOINT
DEFAULT_MTLS_ENDPOINT = RegionsServiceClient.DEFAULT_MTLS_ENDPOINT
_DEFAULT_ENDPOINT_TEMPLATE = RegionsServiceClient._DEFAULT_ENDPOINT_TEMPLATE
_DEFAULT_UNIVERSE = RegionsServiceClient._DEFAULT_UNIVERSE
account_path = staticmethod(RegionsServiceClient.account_path)
parse_account_path = staticmethod(RegionsServiceClient.parse_account_path)
region_path = staticmethod(RegionsServiceClient.region_path)
parse_region_path = staticmethod(RegionsServiceClient.parse_region_path)
common_billing_account_path = staticmethod(
RegionsServiceClient.common_billing_account_path
)
parse_common_billing_account_path = staticmethod(
RegionsServiceClient.parse_common_billing_account_path
)
common_folder_path = staticmethod(RegionsServiceClient.common_folder_path)
parse_common_folder_path = staticmethod(
RegionsServiceClient.parse_common_folder_path
)
common_organization_path = staticmethod(
RegionsServiceClient.common_organization_path
)
parse_common_organization_path = staticmethod(
RegionsServiceClient.parse_common_organization_path
)
common_project_path = staticmethod(RegionsServiceClient.common_project_path)
parse_common_project_path = staticmethod(
RegionsServiceClient.parse_common_project_path
)
common_location_path = staticmethod(RegionsServiceClient.common_location_path)
parse_common_location_path = staticmethod(
RegionsServiceClient.parse_common_location_path
)
[docs] @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:
RegionsServiceAsyncClient: The constructed client.
"""
sa_info_func = (
RegionsServiceClient.from_service_account_info.__func__ # type: ignore
)
return sa_info_func(RegionsServiceAsyncClient, info, *args, **kwargs)
[docs] @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:
RegionsServiceAsyncClient: The constructed client.
"""
sa_file_func = (
RegionsServiceClient.from_service_account_file.__func__ # type: ignore
)
return sa_file_func(RegionsServiceAsyncClient, filename, *args, **kwargs)
from_service_account_json = from_service_account_file
[docs] @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 RegionsServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore
@property
def transport(self) -> RegionsServiceTransport:
"""Returns the transport used by the client instance.
Returns:
RegionsServiceTransport: 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 = RegionsServiceClient.get_transport_class
def __init__(
self,
*,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Optional[
Union[str, RegionsServiceTransport, Callable[..., RegionsServiceTransport]]
] = "grpc_asyncio",
client_options: Optional[ClientOptions] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the regions 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,RegionsServiceTransport,Callable[..., RegionsServiceTransport]]]):
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 RegionsServiceTransport 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 = RegionsServiceClient(
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.accounts_v1.RegionsServiceAsyncClient`.",
extra={
"serviceName": "google.shopping.merchant.accounts.v1.RegionsService",
"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.accounts.v1.RegionsService",
"credentialsType": None,
},
)
[docs] async def get_region(
self,
request: Optional[Union[regions.GetRegionRequest, 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]]] = (),
) -> regions.Region:
r"""Retrieves a region defined in your Merchant Center
account.
.. 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_accounts_v1
async def sample_get_region():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
request = merchant_accounts_v1.GetRegionRequest(
name="name_value",
)
# Make the request
response = await client.get_region(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.GetRegionRequest, dict]]):
The request object. Request message for the ``GetRegion`` method.
name (:class:`str`):
Required. The name of the region to retrieve. Format:
``accounts/{account}/regions/{region}``
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_accounts_v1.types.Region:
Represents a geographic region that you can use as a target with both the
RegionalInventory and ShippingSettings services. You
can define regions as collections of either postal
codes, radius areas or, in some countries, using
predefined geotargets.
A region must be defined by specifying exactly one of
postal_code_area, geotarget_area, or radius_area.
For more information, see [Set up regions
](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region)
for more information.
"""
# 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, regions.GetRegionRequest):
request = regions.GetRegionRequest(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_region
]
# 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
[docs] async def create_region(
self,
request: Optional[Union[regions.CreateRegionRequest, dict]] = None,
*,
parent: Optional[str] = None,
region: Optional[regions.Region] = None,
region_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> regions.Region:
r"""Creates a region definition in your Merchant Center
account. Executing this method requires admin access.
.. 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_accounts_v1
async def sample_create_region():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
request = merchant_accounts_v1.CreateRegionRequest(
parent="parent_value",
region_id="region_id_value",
)
# Make the request
response = await client.create_region(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.CreateRegionRequest, dict]]):
The request object. Request message for the ``CreateRegion`` method.
parent (:class:`str`):
Required. The account to create a region for. Format:
``accounts/{account}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
region (:class:`google.shopping.merchant_accounts_v1.types.Region`):
Required. The region to create.
This corresponds to the ``region`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
region_id (:class:`str`):
Required. The identifier for the
region, unique over all regions of the
same account.
This corresponds to the ``region_id`` 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_accounts_v1.types.Region:
Represents a geographic region that you can use as a target with both the
RegionalInventory and ShippingSettings services. You
can define regions as collections of either postal
codes, radius areas or, in some countries, using
predefined geotargets.
A region must be defined by specifying exactly one of
postal_code_area, geotarget_area, or radius_area.
For more information, see [Set up regions
](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region)
for more information.
"""
# 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, region, region_id]
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, regions.CreateRegionRequest):
request = regions.CreateRegionRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if region is not None:
request.region = region
if region_id is not None:
request.region_id = region_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.create_region
]
# 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
[docs] async def batch_create_regions(
self,
request: Optional[Union[regions.BatchCreateRegionsRequest, dict]] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> regions.BatchCreateRegionsResponse:
r"""Creates one or more regions in your Merchant Center
account. Executing this method requires admin access.
.. 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_accounts_v1
async def sample_batch_create_regions():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
requests = merchant_accounts_v1.CreateRegionRequest()
requests.parent = "parent_value"
requests.region_id = "region_id_value"
request = merchant_accounts_v1.BatchCreateRegionsRequest(
parent="parent_value",
requests=requests,
)
# Make the request
response = await client.batch_create_regions(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.BatchCreateRegionsRequest, dict]]):
The request object. Request message for the ``BatchCreateRegions`` 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_accounts_v1.types.BatchCreateRegionsResponse:
Response message for the BatchCreateRegions method.
"""
# 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, regions.BatchCreateRegionsRequest):
request = regions.BatchCreateRegionsRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.batch_create_regions
]
# 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
[docs] async def update_region(
self,
request: Optional[Union[regions.UpdateRegionRequest, dict]] = None,
*,
region: Optional[regions.Region] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> regions.Region:
r"""Updates a region definition in your Merchant Center
account. Executing this method requires admin access.
.. 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_accounts_v1
async def sample_update_region():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
request = merchant_accounts_v1.UpdateRegionRequest(
)
# Make the request
response = await client.update_region(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.UpdateRegionRequest, dict]]):
The request object. Request message for the ``UpdateRegion`` method.
region (:class:`google.shopping.merchant_accounts_v1.types.Region`):
Required. The updated region.
This corresponds to the ``region`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Optional. The comma-separated field mask indicating the
fields to update. Example:
``"displayName,postalCodeArea.regionCode"``.
This corresponds to the ``update_mask`` 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_accounts_v1.types.Region:
Represents a geographic region that you can use as a target with both the
RegionalInventory and ShippingSettings services. You
can define regions as collections of either postal
codes, radius areas or, in some countries, using
predefined geotargets.
A region must be defined by specifying exactly one of
postal_code_area, geotarget_area, or radius_area.
For more information, see [Set up regions
](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region)
for more information.
"""
# 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 = [region, update_mask]
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, regions.UpdateRegionRequest):
request = regions.UpdateRegionRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if region is not None:
request.region = region
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.update_region
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("region.name", request.region.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
[docs] async def batch_update_regions(
self,
request: Optional[Union[regions.BatchUpdateRegionsRequest, dict]] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> regions.BatchUpdateRegionsResponse:
r"""Updates one or more regions in your Merchant Center
account. Executing this method requires admin access.
.. 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_accounts_v1
async def sample_batch_update_regions():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
request = merchant_accounts_v1.BatchUpdateRegionsRequest(
parent="parent_value",
)
# Make the request
response = await client.batch_update_regions(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.BatchUpdateRegionsRequest, dict]]):
The request object. Request message for the ``BatchUpdateRegions`` 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_accounts_v1.types.BatchUpdateRegionsResponse:
Response message for the BatchUpdateRegions method.
"""
# 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, regions.BatchUpdateRegionsRequest):
request = regions.BatchUpdateRegionsRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.batch_update_regions
]
# 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
[docs] async def delete_region(
self,
request: Optional[Union[regions.DeleteRegionRequest, 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 region definition from your Merchant Center
account. Executing this method requires admin access.
.. 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_accounts_v1
async def sample_delete_region():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
request = merchant_accounts_v1.DeleteRegionRequest(
name="name_value",
)
# Make the request
await client.delete_region(request=request)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.DeleteRegionRequest, dict]]):
The request object. Request message for the ``DeleteRegion`` method.
name (:class:`str`):
Required. The name of the region to delete. Format:
``accounts/{account}/regions/{region}``
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, regions.DeleteRegionRequest):
request = regions.DeleteRegionRequest(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_region
]
# 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,
)
[docs] async def batch_delete_regions(
self,
request: Optional[Union[regions.BatchDeleteRegionsRequest, dict]] = 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 multiple regions by name from your Merchant
Center account. Executing this method requires admin
access.
.. 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_accounts_v1
async def sample_batch_delete_regions():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
requests = merchant_accounts_v1.DeleteRegionRequest()
requests.name = "name_value"
request = merchant_accounts_v1.BatchDeleteRegionsRequest(
parent="parent_value",
requests=requests,
)
# Make the request
await client.batch_delete_regions(request=request)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.BatchDeleteRegionsRequest, dict]]):
The request object. Request message for the ``BatchDeleteRegions`` 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`.
"""
# 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, regions.BatchDeleteRegionsRequest):
request = regions.BatchDeleteRegionsRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.batch_delete_regions
]
# 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.
await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
[docs] async def list_regions(
self,
request: Optional[Union[regions.ListRegionsRequest, 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.ListRegionsAsyncPager:
r"""Lists the regions in your Merchant Center account.
.. 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_accounts_v1
async def sample_list_regions():
# Create a client
client = merchant_accounts_v1.RegionsServiceAsyncClient()
# Initialize request argument(s)
request = merchant_accounts_v1.ListRegionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_regions(request=request)
# Handle the response
async for response in page_result:
print(response)
Args:
request (Optional[Union[google.shopping.merchant_accounts_v1.types.ListRegionsRequest, dict]]):
The request object. Request message for the ``ListRegions`` method.
parent (:class:`str`):
Required. The account to list regions 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_accounts_v1.services.regions_service.pagers.ListRegionsAsyncPager:
Response message for the ListRegions 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, regions.ListRegionsRequest):
request = regions.ListRegionsRequest(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_regions
]
# 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.ListRegionsAsyncPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def __aenter__(self) -> "RegionsServiceAsyncClient":
return self
async def __aexit__(self, exc_type, exc, tb):
await self.transport.close()
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=package_version.__version__
)
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
__all__ = ("RegionsServiceAsyncClient",)
