Class MerchantCenterAccountLinkServiceClient (1.24.0) 

MerchantCenterAccountLinkServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Merchant Center Link service to link a Branch to a Merchant Center Account.

Properties

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

Returns the transport used by the client instance.

Returns
Type Description
MerchantCenterAccountLinkServiceTransport The transport used by the client instance.

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods 

MerchantCenterAccountLinkServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the merchant center account link service client.

Parameters
Name Description
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,MerchantCenterAccountLinkServiceTransport,Callable[..., MerchantCenterAccountLinkServiceTransport]]]

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 MerchantCenterAccountLinkServiceTransport 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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_merchant_center_account_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.CreateMerchantCenterAccountLinkRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    merchant_center_account_link: typing.Optional[
        google.cloud.retail_v2alpha.types.merchant_center_account_link.MerchantCenterAccountLink
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a xref_MerchantCenterAccountLink.

# 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.cloud import retail_v2alpha

def sample_create_merchant_center_account_link():
    # Create a client
    client = retail_v2alpha.MerchantCenterAccountLinkServiceClient()

    # Initialize request argument(s)
    merchant_center_account_link = retail_v2alpha.MerchantCenterAccountLink()
    merchant_center_account_link.merchant_center_account_id = 2730
    merchant_center_account_link.branch_id = "branch_id_value"

    request = retail_v2alpha.CreateMerchantCenterAccountLinkRequest(
        parent="parent_value",
        merchant_center_account_link=merchant_center_account_link,
    )

    # Make the request
    operation = client.create_merchant_center_account_link(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.retail_v2alpha.types.CreateMerchantCenterAccountLinkRequest, dict]

The request object. Request for MerchantCenterAccountLinkService.CreateMerchantCenterAccountLink method.
parent str

Required. The branch resource where this MerchantCenterAccountLink will be created. Format: projects/{PROJECT_NUMBER}/locations/global/catalogs/{CATALOG_ID} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
merchant_center_account_link google.cloud.retail_v2alpha.types.MerchantCenterAccountLink

Required. The MerchantCenterAccountLink to create. If the caller does not have permission to create the MerchantCenterAccountLink, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This corresponds to the merchant_center_account_link 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be MerchantCenterAccountLink Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch. 
delete_merchant_center_account_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.DeleteMerchantCenterAccountLinkRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a xref_MerchantCenterAccountLink. If the xref_MerchantCenterAccountLink to delete does not exist, a NOT_FOUND error is returned.

# 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.cloud import retail_v2alpha

def sample_delete_merchant_center_account_link():
    # Create a client
    client = retail_v2alpha.MerchantCenterAccountLinkServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.DeleteMerchantCenterAccountLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_merchant_center_account_link(request=request)
Parameters
Name Description
request Union[google.cloud.retail_v2alpha.types.DeleteMerchantCenterAccountLinkRequest, dict]

The request object. Request for MerchantCenterAccountLinkService.DeleteMerchantCenterAccountLink method.
name str

Required. Full resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/merchantCenterAccountLinks/{merchant_center_account_link_id} 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.

 
from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
MerchantCenterAccountLinkServiceClient The constructed client. 
from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
MerchantCenterAccountLinkServiceClient The constructed client. 
from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
MerchantCenterAccountLinkServiceClient The constructed client. 
get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.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.

Parameter
Name Description
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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use. 
get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation 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
Type Description
.operations_pb2.Operation An Operation object. 
list_merchant_center_account_links(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.ListMerchantCenterAccountLinksRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.retail_v2alpha.types.merchant_center_account_link_service.ListMerchantCenterAccountLinksResponse
)

Lists all xref_MerchantCenterAccountLinks under the specified parent xref_Catalog.

# 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.cloud import retail_v2alpha

def sample_list_merchant_center_account_links():
    # Create a client
    client = retail_v2alpha.MerchantCenterAccountLinkServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.ListMerchantCenterAccountLinksRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_merchant_center_account_links(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.retail_v2alpha.types.ListMerchantCenterAccountLinksRequest, dict]

The request object. Request for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.
parent str

Required. The parent Catalog of the resource. It must match this format: projects/{PROJECT_NUMBER}/locations/global/catalogs/{CATALOG_ID} 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
Type Description
google.cloud.retail_v2alpha.types.ListMerchantCenterAccountLinksResponse Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method. 
list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations 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
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method. 
merchant_center_account_link_path(
    project: str, location: str, catalog: str, merchant_center_account_link: str
) -> str

Returns a fully-qualified merchant_center_account_link string.

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_merchant_center_account_link_path(path: str) -> typing.Dict[str, str]

Parses a merchant_center_account_link path into its component segments.