Class ProductServiceClient (1.9.0)

ProductServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for ingesting Product information of the customer's website.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`ProductServiceTransport`	The transport used by the client instance.

Methods

ProductServiceClient

ProductServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the product 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`	`Union[str, ProductServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.
`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.

add_fulfillment_places

add_fulfillment_places(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.AddFulfillmentPlacesRequest, dict]] = None, *, product: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Incrementally adds place IDs to xref_Product.fulfillment_info.place_ids.

This process is asynchronous and does not require the xref_Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the xref_Product queried by xref_ProductService.GetProduct or xref_ProductService.ListProducts.

This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2beta

def sample_add_fulfillment_places():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.AddFulfillmentPlacesRequest(
        product="product_value",
        type_="type__value",
        place_ids=['place_ids_value_1', 'place_ids_value_2'],
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.AddFulfillmentPlacesRequest, dict]` The request object. Request message for ProductService.AddFulfillmentPlaces method.
`product`	`str` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This corresponds to the `product` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be AddFulfillmentPlacesResponse Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

add_local_inventories

add_local_inventories(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.AddLocalInventoriesRequest, dict]] = None, *, product: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the xref_Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the xref_Product queried by xref_ProductService.GetProduct or xref_ProductService.ListProducts.

Local inventory information can only be modified using this method. xref_ProductService.CreateProduct and xref_ProductService.UpdateProduct has no effect on local inventories.

This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2beta

def sample_add_local_inventories():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.AddLocalInventoriesRequest(
        product="product_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.AddLocalInventoriesRequest, dict]` The request object. Request message for ProductService.AddLocalInventories method.
`product`	`str` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This corresponds to the `product` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be AddLocalInventoriesResponse Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

branch_path

branch_path(project: str, location: str, catalog: str, branch: str)

Returns a fully-qualified branch string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_product

create_product(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.CreateProductRequest, dict]] = None, *, parent: Optional[str] = None, product: Optional[google.cloud.retail_v2beta.types.product.Product] = None, product_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a xref_Product.

from google.cloud import retail_v2beta

def sample_create_product():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    product = retail_v2beta.Product()
    product.title = "title_value"

    request = retail_v2beta.CreateProductRequest(
        parent="parent_value",
        product=product,
        product_id="product_id_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.CreateProductRequest, dict]` The request object. Request message for ProductService.CreateProduct method.
`parent`	`str` Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`product`	`google.cloud.retail_v2beta.types.Product` Required. The Product to create. This corresponds to the `product` field on the `request` instance; if `request` is provided, this should not be set.
`product_id`	`str` Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This corresponds to the `product_id` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.retail_v2beta.types.Product`	Product captures all metadata information of items to be recommended or searched.

delete_product

delete_product(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.DeleteProductRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a xref_Product.

from google.cloud import retail_v2beta

def sample_delete_product():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.DeleteProductRequest(
        name="name_value",
    )

    # Make the request
    client.delete_product(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.DeleteProductRequest, dict]` The request object. Request message for ProductService.DeleteProduct method.
`name`	`str` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted. 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, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

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
`ProductServiceClient`	The constructed client.

from_service_account_info

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
`ProductServiceClient`	The constructed client.

from_service_account_json

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
`ProductServiceClient`	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.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 variabel 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_product

get_product(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.GetProductRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a xref_Product.

from google.cloud import retail_v2beta

def sample_get_product():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.GetProductRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.GetProductRequest, dict]` The request object. Request message for ProductService.GetProduct method.
`name`	`str` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.retail_v2beta.types.Product`	Product captures all metadata information of items to be recommended or searched.

import_products

import_products(request: Optional[Union[google.cloud.retail_v2beta.types.import_config.ImportProductsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Bulk import of multiple xref_Products.

Request processing may be synchronous. Non-existing items are created.

Note that it is possible for a subset of the xref_Products to be successfully updated.

from google.cloud import retail_v2beta

def sample_import_products():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    input_config = retail_v2beta.ProductInputConfig()
    input_config.product_inline_source.products.title = "title_value"

    request = retail_v2beta.ImportProductsRequest(
        parent="parent_value",
        input_config=input_config,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.ImportProductsRequest, dict]` The request object. Request message for Import methods.
`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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be ImportProductsResponse Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

list_products

list_products(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.ListProductsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a list of xref_Products.

from google.cloud import retail_v2beta

def sample_list_products():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.ListProductsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_products(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.ListProductsRequest, dict]` The request object. Request message for ProductService.ListProducts method.
`parent`	`str` Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.retail_v2beta.services.product_service.pagers.ListProductsPager`	Response message for ProductService.ListProducts method. Iterating over this object will yield results and resolve additional pages automatically.

parse_branch_path

parse_branch_path(path: str)

Parses a branch path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_product_path

parse_product_path(path: str)

Parses a product path into its component segments.

product_path

product_path(project: str, location: str, catalog: str, branch: str, product: str)

Returns a fully-qualified product string.

remove_fulfillment_places

remove_fulfillment_places(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.RemoveFulfillmentPlacesRequest, dict]] = None, *, product: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Incrementally removes place IDs from a xref_Product.fulfillment_info.place_ids.

This process is asynchronous and does not require the xref_Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the xref_Product queried by xref_ProductService.GetProduct or xref_ProductService.ListProducts.

This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2beta

def sample_remove_fulfillment_places():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.RemoveFulfillmentPlacesRequest(
        product="product_value",
        type_="type__value",
        place_ids=['place_ids_value_1', 'place_ids_value_2'],
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.RemoveFulfillmentPlacesRequest, dict]` The request object. Request message for ProductService.RemoveFulfillmentPlaces method.
`product`	`str` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This corresponds to the `product` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be RemoveFulfillmentPlacesResponse Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.

remove_local_inventories

remove_local_inventories(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.RemoveLocalInventoriesRequest, dict]] = None, *, product: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the xref_Product queried by xref_ProductService.GetProduct or xref_ProductService.ListProducts.

Local inventory information can only be removed using this method. xref_ProductService.CreateProduct and xref_ProductService.UpdateProduct has no effect on local inventories.

This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2beta

def sample_remove_local_inventories():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.RemoveLocalInventoriesRequest(
        product="product_value",
        place_ids=['place_ids_value_1', 'place_ids_value_2'],
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.RemoveLocalInventoriesRequest, dict]` The request object. Request message for ProductService.RemoveLocalInventories method.
`product`	`str` Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This corresponds to the `product` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be RemoveLocalInventoriesResponse Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

set_inventory

set_inventory(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.SetInventoryRequest, dict]] = None, *, inventory: Optional[google.cloud.retail_v2beta.types.product.Product] = None, set_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the xref_Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the xref_Product queried by xref_ProductService.GetProduct or xref_ProductService.ListProducts.

When inventory is updated with xref_ProductService.CreateProduct and xref_ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the xref_ProductService.CreateProduct or xref_ProductService.UpdateProduct request.

If no inventory fields are set in xref_CreateProductRequest.product, then any pre-existing inventory information for this product will be used.

If no inventory fields are set in xref_SetInventoryRequest.set_mask, then any existing inventory information will be preserved.

Pre-existing inventory information can only be updated with xref_ProductService.SetInventory, xref_ProductService.AddFulfillmentPlaces, and xref_ProductService.RemoveFulfillmentPlaces.

This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2beta

def sample_set_inventory():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    inventory = retail_v2beta.Product()
    inventory.title = "title_value"

    request = retail_v2beta.SetInventoryRequest(
        inventory=inventory,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.SetInventoryRequest, dict]` The request object. Request message for ProductService.SetInventory method.
`inventory`	`google.cloud.retail_v2beta.types.Product` Required. The inventory information to update. The allowable fields to update are: - Product.price_info - Product.availability - Product.available_quantity - Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The caller can replace place IDs for a subset of fulfillment types in the following ways: - Adds "fulfillment_info" in SetInventoryRequest.set_mask - Specifies only the desired fulfillment types and corresponding place IDs to update in SetInventoryRequest.inventory.fulfillment_info The caller can clear all place IDs from a subset of fulfillment types in the following ways: - Adds "fulfillment_info" in SetInventoryRequest.set_mask - Specifies only the desired fulfillment types to clear in SetInventoryRequest.inventory.fulfillment_info - Checks that only the desired fulfillment info types have empty SetInventoryRequest.inventory.fulfillment_info.place_ids The last update time is recorded for the following inventory fields: - Product.price_info - Product.availability - Product.available_quantity - Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, ProductService.UpdateProduct should be invoked instead. This corresponds to the `inventory` field on the `request` instance; if `request` is provided, this should not be set.
`set_mask`	`google.protobuf.field_mask_pb2.FieldMask` Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. This corresponds to the `set_mask` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be SetInventoryResponse Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.

update_product

update_product(request: Optional[Union[google.cloud.retail_v2beta.types.product_service.UpdateProductRequest, dict]] = None, *, product: Optional[google.cloud.retail_v2beta.types.product.Product] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a xref_Product.

from google.cloud import retail_v2beta

def sample_update_product():
    # Create a client
    client = retail_v2beta.ProductServiceClient()

    # Initialize request argument(s)
    product = retail_v2beta.Product()
    product.title = "title_value"

    request = retail_v2beta.UpdateProductRequest(
        product=product,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2beta.types.UpdateProductRequest, dict]` The request object. Request message for ProductService.UpdateProduct method.
`product`	`google.cloud.retail_v2beta.types.Product` Required. The product to update/create. If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned. This corresponds to the `product` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update. 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.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.retail_v2beta.types.Product`	Product captures all metadata information of items to be recommended or searched.