Changelog

1.23.0 (2024-10-24)

Features

Add support for Python 3.13 (#13209) (5f2e30d)

1.22.0 (2024-10-09)

Features

add conversational search (b704404)
add tile navigation (b704404)

Documentation

keep the API doc up-to-date with recent changes (b704404)

1.21.2 (2024-07-30)

Bug Fixes

Retry and timeout values do not propagate in requests during pagination (52db52e)

1.21.1 (2024-07-08)

Bug Fixes

Allow Protobuf 5.x (#12869) (e42edbc)

1.21.0 (2024-06-10)

Features

add page_categories to control condition (ca7628f)
add product purge API (ca7628f)
allow to skip denylist postfiltering in recommendations (ca7628f)
support attribute suggestion in autocomplete (ca7628f)
support frequent bought together model config (ca7628f)
support merged facets (ca7628f)

Documentation

keep the API doc up-to-date with recent changes (ca7628f)

1.20.1 (2024-03-05)

Bug Fixes

deps: Exclude google-auth 2.24.0 and 2.25.0 (#12387) (12ce658)

1.20.0 (2024-02-22)

Features

[google-cloud-retail] add analytics service (#12294) (8b5f319)

Bug Fixes

deps: [Many APIs] Require google-api-core>=1.34.1 (#12309) (c23398a)
fix ValueError in test__validate_universe_domain (89c1b05)

1.19.1 (2024-02-06)

Bug Fixes

Add google-auth as a direct dependency (9e8d039)
Add staticmethod decorator to _get_client_cert_source and _get_api_endpoint (9e8d039)
Resolve AttributeError ‘Credentials’ object has no attribute ‘universe_domain’ (9e8d039)

1.19.0 (2024-02-01)

Features

Allow users to explicitly configure universe domain (4368029)

1.18.0 (2024-01-22)

Features

v2alpha: Add analytics service (266cb0c)
v2beta: Add analytics service (266cb0c)

1.17.0 (2023-12-07)

Features

Add support for python 3.12 (e9655df)
Introduce compatibility with native namespace packages (e9655df)

Bug Fixes

Require proto-plus >= 1.22.3 (e9655df)
Use retry_async instead of retry in async client (e9655df)

1.16.3 (2023-09-19)

Documentation

Minor formatting (4866c1b)
Remove migrated samples (#434) (cab6042)

1.16.2 (2023-07-04)

Bug Fixes

Add async context manager return types (#421) (9756fa2)

1.16.1 (2023-04-17)

Bug Fixes

v2alpha: Fix the HTTP format for merchant center link service (#408) (88bd93c)

1.16.0 (2023-04-11)

Features

Add model get API (4167a2c)
Expose A/B experiment info in search response (4167a2c)
Expose facets and product counts in autocomplete (4167a2c)
Support new filter syntax for recommendation (4167a2c)
Support per-entity search and autocomplete (4167a2c)

Documentation

Keep the API doc up-to-date with recent changes (4167a2c)

1.15.1 (2023-03-23)

Documentation

Fix formatting of request arg in docstring (#402) (5477f18)

1.15.0 (2023-02-28)

Features

Enable “rest” transport in Python for services supporting numeric enums (#394) (afebfd9)

1.14.1 (2023-01-20)

Bug Fixes

Add context manager return types (f27cab3)

Documentation

Add documentation for enums (f27cab3)

1.14.0 (2023-01-10)

Features

Add support for python 3.11 (#379) (945fd66)

1.13.0 (2023-01-05)

Features

v2beta: Allow set feed id in merchant center link (78bf804)
v2beta: Deprecate retrievable_fields in product attribute (78bf804)
v2beta: Support async write mode for WriteUserEvent API (78bf804)
v2beta: Support collect and import GA4 event format with prebuilt whistle rule (78bf804)
v2beta: Support data output to GCS (78bf804)
v2beta: Support diversity type in serving config (78bf804)
v2beta: Support exact searchable and retrievable in catalog attribute config (78bf804)

Documentation

v2beta: Keep the API doc up-to-date with recent changes (78bf804)

1.12.0 (2022-12-15)

Features

Deprecate retrievable_fields in product attribute (1ba8e50)
Support async write mode for WriteUserEvent API (1ba8e50)
Support collect GA4 event format with prebuilt whistle rule (1ba8e50)
Support diversity type in serving config (1ba8e50)
Support exact searchable and retrievable in catalog attribute config (1ba8e50)

Documentation

Keep the API doc up-to-date with recent changes (1ba8e50)

1.11.0 (2022-12-15)

Features

Add support for google.cloud.retail.__version__ (b113357)
Add typing to proto.Message based class attributes (b113357)
v2alpha: Allow set feed id in merchant center link (3ee1ee4)
v2alpha: Deprecate retrievable_fields in product attribute (3ee1ee4)
v2alpha: Expose the local inventory data in product data retrieval (3ee1ee4)
v2alpha: Return personal product labels in search response (3ee1ee4)
v2alpha: Support async write mode for WriteUserEvent API (3ee1ee4)
v2alpha: Support attribute suggestion in autocomplete (3ee1ee4)
v2alpha: Support batch remove catalog attribute config (3ee1ee4)
v2alpha: Support collect and import GA4 event format with prebuilt whistle rule (3ee1ee4)
v2alpha: Support data output to GCS (3ee1ee4)
v2alpha: Support diversity type in serving config (3ee1ee4)
v2alpha: Support exact searchable and retrievable in catalog attribute config (3ee1ee4)

Bug Fixes

Add dict typing for client_options (b113357)
deps: Require google-api-core >=1.34.0, >=2.11.0 (6780c7a)
Drop usage of pkg_resources (6780c7a)
Fix timeout default values (6780c7a)

Documentation

samples: Snippetgen handling of repeated enum field (b113357)
samples: Snippetgen should call await on the operation coroutine before calling result (6780c7a)
v2alpha: Keep the API doc up-to-date with recent changes (3ee1ee4)

1.10.2 (2022-10-07)

Bug Fixes

deps: Allow protobuf 3.19.5 (#353) (9336e6a)

1.10.1 (2022-09-29)

Bug Fixes

deps: Require protobuf >= 3.20.2 (#350) (3e1cc13)

1.10.0 (2022-09-02)

Features

Release Model Services to v2beta version (#333) (ec20834)

1.9.0 (2022-08-23)

Features

add local inventories info to the Product resource (33d7202)
release AttributesConfig APIs to v2 version (33d7202)
release CompletionConfig APIs to v2 version (33d7202)
release Control and ServingConfig serivces to v2 version (#319) (33d7202)

Documentation

Improved documentation for Fullfillment and Inventory API in ProductService (33d7202)
minor documentation format and typo fixes (33d7202)

1.8.1 (2022-08-12)

Bug Fixes

deps: allow protobuf < 5.0.0 (#313) (9c8c730)
deps: require proto-plus >= 1.22.0 (9c8c730)

1.8.0 (2022-08-09)

Features

allow adding labels in search requests (d981c65)
allow disabling spell check in search requests (d981c65)
allow enabling recommendation filtering on custom attributes (d981c65)
allow returning min/max values on search numeric facets (d981c65)
allow skipping default branch protection when doing product full import (fabe71c)
allow using serving configs as an alias of placements (d981c65)
new model service to manage recommendation models (fabe71c)
return output BigQuery table on product / event export response (d981c65)
support case insensitive match on search facets (#301) (d981c65)

Documentation

keep the API doc up-to-date with recent changes (d981c65)

1.7.0 (2022-07-17)

Features

add audience parameter (34642ee)
allow users to add labels in search requests (34642ee)
allow users to disable spell check in search requests (34642ee)

Bug Fixes

deps: require google-api-core>=1.32.0,>=2.8.0 (#275) (34642ee)
require python 3.7+ (#284) (7a97063)

Documentation

deprecate indexable/searchable on the product level custom attributes (34642ee)
keep the API doc up-to-date with recent changes (34642ee)

1.6.1 (2022-06-02)

Bug Fixes

deps: require protobuf <4.0.0dev (#272) (83bb41e)

Documentation

fix changelog header to consistent size (#273) (6a3646f)

1.6.0 (2022-05-19)

Features

generate v2alpha/v2beta (#226) (78953f8)

Documentation

fix type in docstring for map fields (#210) (b9f4020)
samples: improve the setup scripts (#207) (17dee11)

1.5.0 (2022-03-30)

Features

add new AddLocalInventories and RemoveLocalInventories APIs (8d61976)
allow search users to skip validation for invalid boost specs (8d61976)
search returns applied control ids in the response (8d61976)
support search personalization (8d61976)
users cannot switch to empty default branch unless force override (8d61976)

Documentation

deprecate request_id in ImportProductsRequest (8d61976)
deprecate search dynamic_facet_spec and suggest to config on cloud console (8d61976)
keep the API doc up-to-date with recent changes (8d61976)
suggest search users not to send IP and use hashed user id (8d61976)
users can self enroll retail search feature on cloud console (8d61976)

1.4.1 (2022-03-05)

Bug Fixes

deps: require google-api-core>=1.31.5, >=2.3.2 (#179) (398f86d)
deps: require proto-plus>=1.15.0 (398f86d)

Documentation

samples: fix create bucket for user events (#173) (264f2d4)

1.4.0 (2022-02-28)

Features

add api key support (#134) (234883d)

Bug Fixes

resolve DuplicateCredentialArgs error when using credentials_file (#146) (6861dae)

Documentation

samples: add product import samples (#149) (b4c8608)
samples: add resources for interactive tutorials (#145) (bc60b00)
samples: add retail search service samples (#133) (3b5f938)
samples: add samples for events (#155) (cc475f7)
samples: add samples for write/rejoin/purge user events (#157) (4dba447)
samples: add samples to create, read, update, and delete products (#150) (d8f8e34)
samples: Additional guidance in samples/interactive-tutorials/README.md (#162) (47d2388)
samples: read the project id from google.auth (#160) (f6192c8)
samples: remove project_number in interactive-tutorials (#158) (017202a)

1.3.0 (2022-01-14)

Features

update grpc service config settings to reflect correct API deadlines (#120) (e7649c7)

1.2.1 (2021-11-01)

Bug Fixes

deps: drop packaging dependency (1f05fe4)
deps: require google-api-core >= 1.28.0 (1f05fe4)

Documentation

fix docstring formatting (#111) (fdf5dcd)
list oneofs in docstring (1f05fe4)

1.2.0 (2021-10-18)

Features

add search mode to search request (#108) (326576f)
add support for python 3.10 (#105) (221e21a)
update grpc service config settings to reflect correct API deadlines (326576f)

Documentation

fix docstring formatting (#107) (3777919)
Keep the API doc up-to-date (326576f)

1.1.0 (2021-10-07)

Features

add context manager support in client (#101) (3e68d78)

1.0.2 (2021-09-30)

Bug Fixes

improper types in pagers generation (e82885d)

1.0.1 (2021-09-24)

Bug Fixes

add ‘dict’ annotation type to ‘request’ (bee28be)

1.0.0 (2021-08-25)

Features

update grpc service config settings to reflect correct API deadlines (#82) (2d535da)

Documentation

Keep the API doc up-to-date (#80) (a77f0ea)

0.4.2 (2021-08-04)

Documentation

retail: Quote several literal expressions for better rendering (#75) (53ede84)

0.4.1 (2021-08-01)

Documentation

Remove HTML tags from Cloud Retail API library docs (#73) (00e0a53)
remove remaining private links (#72) (e2ca897)

0.4.0 (2021-07-29)

Features

Add restricted Retail Search features for Retail API v2. (#68) (84ba173)

0.3.1 (2021-07-26)

Bug Fixes

deps: pin ‘google-{api,cloud}-core’, ‘google-auth’ to allow 2.x versions (#59) (23223a7)
enable self signed jwt for grpc (#65) (51b9934)

Documentation

add Samples section to CONTRIBUTING.rst (#60) (70d0585)

Miscellaneous Chores

release 0.3.1 (#64) (7ffa868)

0.3.0 (2021-07-01)

Features

add always_use_jwt_access (#51) (f6ad4b6)

Bug Fixes

disable always_use_jwt_access (#55) (d7f0666)

Documentation

omit mention of Python 2.7 in ‘CONTRIBUTING.rst’ (#1127) (#46) (f03c60a), closes #1126

0.2.0 (2021-05-28)

Features

bump release level to production/stable (#39) (c5b1e15)
support self-signed JWT flow for service accounts (879fd90)

Bug Fixes

add async client to %name_%version/init.py (879fd90)

0.1.0 (2021-01-14)

Features

generate v2 (db1013e)