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.

ProductService

class google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for ingesting [Product][google.cloud.retail.v2.Product] information of the customer’s website.

Instantiates the product service client.

Parameters
  • 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 (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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async add_fulfillment_places(request: Optional[google.cloud.retail_v2.types.product_service.AddFulfillmentPlacesRequest] = None, *, product: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
  • request (google.cloud.retail_v2.types.AddFulfillmentPlacesRequest) – The request object. Request message for [AddFulfillmentPlaces][] method.

  • product (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.AddFulfillmentPlacesResponse Response of the RemoveFulfillmentPlacesRequest. Currently empty because

there is no meaningful response populated from the [AddFulfillmentPlaces][] method.

Return type

google.api_core.operation_async.AsyncOperation

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

Returns a fully-qualified branch string.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async create_product(request: Optional[google.cloud.retail_v2.types.product_service.CreateProductRequest] = None, *, parent: Optional[str] = None, product: Optional[google.cloud.retail_v2.types.product.Product] = None, product_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.retail_v2.types.product.Product[source]

Creates a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (google.cloud.retail_v2.types.CreateProductRequest) – The request object. Request message for [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_v2.types.Product) –

    Required. The [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name].

    If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.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

Product captures all metadata information of items to be recommended or searched.

Return type

google.cloud.retail_v2.types.Product

async delete_product(request: Optional[google.cloud.retail_v2.types.product_service.DeleteProductRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (google.cloud.retail_v2.types.DeleteProductRequest) – The request object. Request message for [DeleteProduct][] method.

  • name (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.

    The [Product][google.cloud.retail.v2.Product] to delete can neither be a [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION] [Product][google.cloud.retail.v2.Product] member nor a [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product] with more than one [variants][google.cloud.retail.v2.Product.Type.VARIANT]. Otherwise, an INVALID_ARGUMENT error is returned.

    All inventory information for the named [Product][google.cloud.retail.v2.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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ProductServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

ProductServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ProductServiceAsyncClient

async get_product(request: Optional[google.cloud.retail_v2.types.product_service.GetProductRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.retail_v2.types.product.Product[source]

Gets a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (google.cloud.retail_v2.types.GetProductRequest) – The request object. Request message for [GetProduct][] method.

  • name (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the requested [Product][google.cloud.retail.v2.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

Product captures all metadata information of items to be recommended or searched.

Return type

google.cloud.retail_v2.types.Product

get_transport_class()Type[google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async import_products(request: Optional[google.cloud.retail_v2.types.import_config.ImportProductsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.

Request processing may be synchronous. No partial updating is supported. Non-existing items are created.

Note that it is possible for a subset of the [Product][google.cloud.retail.v2.Product]s to be successfully updated.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.ImportProductsResponse Response of the

[ImportProductsRequest][google.cloud.retail.v2.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.

Return type

google.api_core.operation_async.AsyncOperation

async list_products(request: Optional[google.cloud.retail_v2.types.product_service.ListProductsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.retail_v2.services.product_service.pagers.ListProductsAsyncPager[source]

Gets a list of [Product][google.cloud.retail.v2.Product]s.

Parameters
  • request (google.cloud.retail_v2.types.ListProductsRequest) – The request object. Request message for [ProductService.ListProducts][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product]s 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

Response message for

[ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.retail_v2.services.product_service.pagers.ListProductsAsyncPager

static parse_branch_path(path: str)Dict[str, str]

Parses a branch path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_product_path(path: str)Dict[str, str]

Parses a product path into its component segments.

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

Returns a fully-qualified product string.

async remove_fulfillment_places(request: Optional[google.cloud.retail_v2.types.product_service.RemoveFulfillmentPlacesRequest] = None, *, product: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
  • request (google.cloud.retail_v2.types.RemoveFulfillmentPlacesRequest) – The request object. Request message for [RemoveFulfillmentPlaces][] method.

  • product (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.RemoveFulfillmentPlacesResponse Response of the RemoveFulfillmentPlacesRequest. Currently empty because there

is no meaningful response populated from the [RemoveFulfillmentPlaces][] method.

Return type

google.api_core.operation_async.AsyncOperation

async set_inventory(request: Optional[google.cloud.retail_v2.types.product_service.SetInventoryRequest] = None, *, inventory: Optional[google.cloud.retail_v2.types.product.Product] = None, set_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Updates inventory information for a [Product][google.cloud.retail.v2.Product] while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

When inventory is updated with [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and [UpdateProduct][google.cloud.retail.v2.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 [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] or [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] request.

If no inventory fields are set in [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product], then any pre-existing inventory information for this product will be used.

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

Pre-existing inventory information can only be updated with [SetInventory][google.cloud.retail.v2.ProductService.SetInventory], [AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces], and [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
  • request (google.cloud.retail_v2.types.SetInventoryRequest) – The request object. Request message for [SetInventory][] method.

  • inventory (google.cloud.retail_v2.types.Product) –

    Required. The inventory information to update. The allowable fields to update are:

    • [Product.price_info][google.cloud.retail.v2.Product.price_info]

    • [Product.availability][google.cloud.retail.v2.Product.availability]

    • [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]

    • [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info] The updated inventory fields must be specified in [SetInventoryRequest.set_mask][google.cloud.retail.v2.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][google.cloud.retail.v2.Product] named in [Product.name][google.cloud.retail.v2.Product.name], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the [Product][google.cloud.retail.v2.Product] to update does not have existing inventory information, the provided inventory information will be inserted.

    If the [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.SetInventoryRequest.set_time].

    The last update time is recorded for the following inventory fields:

    • [Product.price_info][google.cloud.retail.v2.Product.price_info]

    • [Product.availability][google.cloud.retail.v2.Product.availability]

    • [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]

    • [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]

    If a full overwrite of inventory information while ignoring timestamps is needed, [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][google.cloud.retail.v2.Product] to update. If not set or set with empty paths, all inventory fields will be updated.

    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

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.SetInventoryResponse Response of the SetInventoryRequest. Currently empty because

there is no meaningful response populated from the [SetInventory][] method.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ProductServiceTransport

async update_product(request: Optional[google.cloud.retail_v2.types.product_service.UpdateProductRequest] = None, *, product: Optional[google.cloud.retail_v2.types.product.Product] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.retail_v2.types.product.Product[source]

Updates a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (google.cloud.retail_v2.types.UpdateProductRequest) – The request object. Request message for [UpdateProduct][] method.

  • product (google.cloud.retail_v2.types.Product) –

    Required. The product to update/create.

    If the caller does not have permission to update the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the [Product][google.cloud.retail.v2.Product] to update does not exist and [allow_missing][google.cloud.retail.v2.UpdateProductRequest.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][google.cloud.retail.v2.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.

    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

Product captures all metadata information of items to be recommended or searched.

Return type

google.cloud.retail_v2.types.Product

class google.cloud.retail_v2.services.product_service.ProductServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.retail_v2.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>)[source]

Service for ingesting [Product][google.cloud.retail.v2.Product] information of the customer’s website.

Instantiates the product service client.

Parameters
  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

add_fulfillment_places(request: Optional[Union[google.cloud.retail_v2.types.product_service.AddFulfillmentPlacesRequest, dict]] = None, *, product: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
  • request (Union[google.cloud.retail_v2.types.AddFulfillmentPlacesRequest, dict]) – The request object. Request message for [AddFulfillmentPlaces][] method.

  • product (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.AddFulfillmentPlacesResponse Response of the RemoveFulfillmentPlacesRequest. Currently empty because

there is no meaningful response populated from the [AddFulfillmentPlaces][] method.

Return type

google.api_core.operation.Operation

static branch_path(project: str, location: str, catalog: str, branch: str)str[source]

Returns a fully-qualified branch string.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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

Creates a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (Union[google.cloud.retail_v2.types.CreateProductRequest, dict]) – The request object. Request message for [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_v2.types.Product) –

    Required. The [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name].

    If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.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

Product captures all metadata information of items to be recommended or searched.

Return type

google.cloud.retail_v2.types.Product

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

Deletes a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (Union[google.cloud.retail_v2.types.DeleteProductRequest, dict]) – The request object. Request message for [DeleteProduct][] method.

  • name (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.

    The [Product][google.cloud.retail.v2.Product] to delete can neither be a [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION] [Product][google.cloud.retail.v2.Product] member nor a [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product] with more than one [variants][google.cloud.retail.v2.Product.Type.VARIANT]. Otherwise, an INVALID_ARGUMENT error is returned.

    All inventory information for the named [Product][google.cloud.retail.v2.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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ProductServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

ProductServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ProductServiceClient

get_product(request: Optional[Union[google.cloud.retail_v2.types.product_service.GetProductRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.retail_v2.types.product.Product[source]

Gets a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (Union[google.cloud.retail_v2.types.GetProductRequest, dict]) – The request object. Request message for [GetProduct][] method.

  • name (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the requested [Product][google.cloud.retail.v2.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

Product captures all metadata information of items to be recommended or searched.

Return type

google.cloud.retail_v2.types.Product

import_products(request: Optional[Union[google.cloud.retail_v2.types.import_config.ImportProductsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.

Request processing may be synchronous. No partial updating is supported. Non-existing items are created.

Note that it is possible for a subset of the [Product][google.cloud.retail.v2.Product]s to be successfully updated.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.ImportProductsResponse Response of the

[ImportProductsRequest][google.cloud.retail.v2.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.

Return type

google.api_core.operation.Operation

list_products(request: Optional[Union[google.cloud.retail_v2.types.product_service.ListProductsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.retail_v2.services.product_service.pagers.ListProductsPager[source]

Gets a list of [Product][google.cloud.retail.v2.Product]s.

Parameters
  • request (Union[google.cloud.retail_v2.types.ListProductsRequest, dict]) – The request object. Request message for [ProductService.ListProducts][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product]s 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

Response message for

[ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.retail_v2.services.product_service.pagers.ListProductsPager

static parse_branch_path(path: str)Dict[str, str][source]

Parses a branch path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_product_path(path: str)Dict[str, str][source]

Parses a product path into its component segments.

static product_path(project: str, location: str, catalog: str, branch: str, product: str)str[source]

Returns a fully-qualified product string.

remove_fulfillment_places(request: Optional[Union[google.cloud.retail_v2.types.product_service.RemoveFulfillmentPlacesRequest, dict]] = None, *, product: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
  • request (Union[google.cloud.retail_v2.types.RemoveFulfillmentPlacesRequest, dict]) – The request object. Request message for [RemoveFulfillmentPlaces][] method.

  • product (str) –

    Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.RemoveFulfillmentPlacesResponse Response of the RemoveFulfillmentPlacesRequest. Currently empty because there

is no meaningful response populated from the [RemoveFulfillmentPlaces][] method.

Return type

google.api_core.operation.Operation

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

Updates inventory information for a [Product][google.cloud.retail.v2.Product] while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.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 [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

When inventory is updated with [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and [UpdateProduct][google.cloud.retail.v2.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 [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] or [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] request.

If no inventory fields are set in [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product], then any pre-existing inventory information for this product will be used.

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

Pre-existing inventory information can only be updated with [SetInventory][google.cloud.retail.v2.ProductService.SetInventory], [AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces], and [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
  • request (Union[google.cloud.retail_v2.types.SetInventoryRequest, dict]) – The request object. Request message for [SetInventory][] method.

  • inventory (google.cloud.retail_v2.types.Product) –

    Required. The inventory information to update. The allowable fields to update are:

    • [Product.price_info][google.cloud.retail.v2.Product.price_info]

    • [Product.availability][google.cloud.retail.v2.Product.availability]

    • [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]

    • [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info] The updated inventory fields must be specified in [SetInventoryRequest.set_mask][google.cloud.retail.v2.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][google.cloud.retail.v2.Product] named in [Product.name][google.cloud.retail.v2.Product.name], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the [Product][google.cloud.retail.v2.Product] to update does not have existing inventory information, the provided inventory information will be inserted.

    If the [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.SetInventoryRequest.set_time].

    The last update time is recorded for the following inventory fields:

    • [Product.price_info][google.cloud.retail.v2.Product.price_info]

    • [Product.availability][google.cloud.retail.v2.Product.availability]

    • [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]

    • [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]

    If a full overwrite of inventory information while ignoring timestamps is needed, [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][google.cloud.retail.v2.Product] to update. If not set or set with empty paths, all inventory fields will be updated.

    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

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2.types.SetInventoryResponse Response of the SetInventoryRequest. Currently empty because

there is no meaningful response populated from the [SetInventory][] method.

Return type

google.api_core.operation.Operation

property transport: google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ProductServiceTransport

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

Updates a [Product][google.cloud.retail.v2.Product].

Parameters
  • request (Union[google.cloud.retail_v2.types.UpdateProductRequest, dict]) – The request object. Request message for [UpdateProduct][] method.

  • product (google.cloud.retail_v2.types.Product) –

    Required. The product to update/create.

    If the caller does not have permission to update the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the [Product][google.cloud.retail.v2.Product] to update does not exist and [allow_missing][google.cloud.retail.v2.UpdateProductRequest.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][google.cloud.retail.v2.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.

    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

Product captures all metadata information of items to be recommended or searched.

Return type

google.cloud.retail_v2.types.Product

class google.cloud.retail_v2.services.product_service.pagers.ListProductsAsyncPager(method: Callable[[...], Awaitable[google.cloud.retail_v2.types.product_service.ListProductsResponse]], request: google.cloud.retail_v2.types.product_service.ListProductsRequest, response: google.cloud.retail_v2.types.product_service.ListProductsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_products requests.

This class thinly wraps an initial google.cloud.retail_v2.types.ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual google.cloud.retail_v2.types.ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.retail_v2.services.product_service.pagers.ListProductsPager(method: Callable[[...], google.cloud.retail_v2.types.product_service.ListProductsResponse], request: google.cloud.retail_v2.types.product_service.ListProductsRequest, response: google.cloud.retail_v2.types.product_service.ListProductsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_products requests.

This class thinly wraps an initial google.cloud.retail_v2.types.ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual google.cloud.retail_v2.types.ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters