Skip to content

Commit 1096a28

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: users can self enroll retail search feature on cloud console (#195)
* docs: users can self enroll retail search feature on cloud console docs: suggest search users not to send IP and use hashed user id docs: deprecate request_id in ImportProductsRequest docs: deprecate search dynamic_facet_spec and suggest to config on cloud console docs: keep the API doc up-to-date with recent changes feat: add new AddLocalInventories and RemoveLocalInventories APIs feat: users cannot switch to empty default branch unless force override feat: allow search users to skip validation for invalid boost specs feat: support search personalization feat: search returns applied control ids in the response PiperOrigin-RevId: 437355889 Source-Link: googleapis/googleapis@4d00815 Source-Link: googleapis/googleapis-gen@b2b7982 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJiNzk4MjQ3ZDQ2YzkzMjczN2NmNjg5NzQ0YTgyN2ZhZTdlNTMxMyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent fe7d74b commit 1096a28

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2362
-370
lines changed

‎packages/google-cloud-retail/google/cloud/retail/__init__.py‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@
5959
from google.cloud.retail_v2.types.common import FulfillmentInfo
6060
from google.cloud.retail_v2.types.common import Image
6161
from google.cloud.retail_v2.types.common import Interval
62+
from google.cloud.retail_v2.types.common import LocalInventory
6263
from google.cloud.retail_v2.types.common import PriceInfo
63-
from google.cloud.retail_v2.types.common import Promotion
6464
from google.cloud.retail_v2.types.common import Rating
6565
from google.cloud.retail_v2.types.common import UserInfo
6666
from google.cloud.retail_v2.types.completion_service import CompleteQueryRequest
@@ -87,6 +87,9 @@
8787
from google.cloud.retail_v2.types.product_service import AddFulfillmentPlacesMetadata
8888
from google.cloud.retail_v2.types.product_service import AddFulfillmentPlacesRequest
8989
from google.cloud.retail_v2.types.product_service import AddFulfillmentPlacesResponse
90+
from google.cloud.retail_v2.types.product_service import AddLocalInventoriesMetadata
91+
from google.cloud.retail_v2.types.product_service import AddLocalInventoriesRequest
92+
from google.cloud.retail_v2.types.product_service import AddLocalInventoriesResponse
9093
from google.cloud.retail_v2.types.product_service import CreateProductRequest
9194
from google.cloud.retail_v2.types.product_service import DeleteProductRequest
9295
from google.cloud.retail_v2.types.product_service import GetProductRequest
@@ -95,10 +98,14 @@
9598
from google.cloud.retail_v2.types.product_service import RemoveFulfillmentPlacesMetadata
9699
from google.cloud.retail_v2.types.product_service import RemoveFulfillmentPlacesRequest
97100
from google.cloud.retail_v2.types.product_service import RemoveFulfillmentPlacesResponse
101+
from google.cloud.retail_v2.types.product_service import RemoveLocalInventoriesMetadata
102+
from google.cloud.retail_v2.types.product_service import RemoveLocalInventoriesRequest
103+
from google.cloud.retail_v2.types.product_service import RemoveLocalInventoriesResponse
98104
from google.cloud.retail_v2.types.product_service import SetInventoryMetadata
99105
from google.cloud.retail_v2.types.product_service import SetInventoryRequest
100106
from google.cloud.retail_v2.types.product_service import SetInventoryResponse
101107
from google.cloud.retail_v2.types.product_service import UpdateProductRequest
108+
from google.cloud.retail_v2.types.promotion import Promotion
102109
from google.cloud.retail_v2.types.purge_config import PurgeMetadata
103110
from google.cloud.retail_v2.types.purge_config import PurgeUserEventsRequest
104111
from google.cloud.retail_v2.types.purge_config import PurgeUserEventsResponse
@@ -141,8 +148,8 @@
141148
"FulfillmentInfo",
142149
"Image",
143150
"Interval",
151+
"LocalInventory",
144152
"PriceInfo",
145-
"Promotion",
146153
"Rating",
147154
"UserInfo",
148155
"CompleteQueryRequest",
@@ -169,6 +176,9 @@
169176
"AddFulfillmentPlacesMetadata",
170177
"AddFulfillmentPlacesRequest",
171178
"AddFulfillmentPlacesResponse",
179+
"AddLocalInventoriesMetadata",
180+
"AddLocalInventoriesRequest",
181+
"AddLocalInventoriesResponse",
172182
"CreateProductRequest",
173183
"DeleteProductRequest",
174184
"GetProductRequest",
@@ -177,10 +187,14 @@
177187
"RemoveFulfillmentPlacesMetadata",
178188
"RemoveFulfillmentPlacesRequest",
179189
"RemoveFulfillmentPlacesResponse",
190+
"RemoveLocalInventoriesMetadata",
191+
"RemoveLocalInventoriesRequest",
192+
"RemoveLocalInventoriesResponse",
180193
"SetInventoryMetadata",
181194
"SetInventoryRequest",
182195
"SetInventoryResponse",
183196
"UpdateProductRequest",
197+
"Promotion",
184198
"PurgeMetadata",
185199
"PurgeUserEventsRequest",
186200
"PurgeUserEventsResponse",

‎packages/google-cloud-retail/google/cloud/retail_v2/__init__.py‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141
from .types.common import FulfillmentInfo
4242
from .types.common import Image
4343
from .types.common import Interval
44+
from .types.common import LocalInventory
4445
from .types.common import PriceInfo
45-
from .types.common import Promotion
4646
from .types.common import Rating
4747
from .types.common import UserInfo
4848
from .types.completion_service import CompleteQueryRequest
@@ -69,6 +69,9 @@
6969
from .types.product_service import AddFulfillmentPlacesMetadata
7070
from .types.product_service import AddFulfillmentPlacesRequest
7171
from .types.product_service import AddFulfillmentPlacesResponse
72+
from .types.product_service import AddLocalInventoriesMetadata
73+
from .types.product_service import AddLocalInventoriesRequest
74+
from .types.product_service import AddLocalInventoriesResponse
7275
from .types.product_service import CreateProductRequest
7376
from .types.product_service import DeleteProductRequest
7477
from .types.product_service import GetProductRequest
@@ -77,10 +80,14 @@
7780
from .types.product_service import RemoveFulfillmentPlacesMetadata
7881
from .types.product_service import RemoveFulfillmentPlacesRequest
7982
from .types.product_service import RemoveFulfillmentPlacesResponse
83+
from .types.product_service import RemoveLocalInventoriesMetadata
84+
from .types.product_service import RemoveLocalInventoriesRequest
85+
from .types.product_service import RemoveLocalInventoriesResponse
8086
from .types.product_service import SetInventoryMetadata
8187
from .types.product_service import SetInventoryRequest
8288
from .types.product_service import SetInventoryResponse
8389
from .types.product_service import UpdateProductRequest
90+
from .types.promotion import Promotion
8491
from .types.purge_config import PurgeMetadata
8592
from .types.purge_config import PurgeUserEventsRequest
8693
from .types.purge_config import PurgeUserEventsResponse
@@ -106,6 +113,9 @@
106113
"AddFulfillmentPlacesMetadata",
107114
"AddFulfillmentPlacesRequest",
108115
"AddFulfillmentPlacesResponse",
116+
"AddLocalInventoriesMetadata",
117+
"AddLocalInventoriesRequest",
118+
"AddLocalInventoriesResponse",
109119
"Audience",
110120
"BigQuerySource",
111121
"Catalog",
@@ -139,6 +149,7 @@
139149
"ListCatalogsResponse",
140150
"ListProductsRequest",
141151
"ListProductsResponse",
152+
"LocalInventory",
142153
"PredictRequest",
143154
"PredictResponse",
144155
"PredictionServiceClient",
@@ -161,6 +172,9 @@
161172
"RemoveFulfillmentPlacesMetadata",
162173
"RemoveFulfillmentPlacesRequest",
163174
"RemoveFulfillmentPlacesResponse",
175+
"RemoveLocalInventoriesMetadata",
176+
"RemoveLocalInventoriesRequest",
177+
"RemoveLocalInventoriesResponse",
164178
"SearchRequest",
165179
"SearchResponse",
166180
"SearchServiceClient",

‎packages/google-cloud-retail/google/cloud/retail_v2/gapic_metadata.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@
127127
"add_fulfillment_places"
128128
]
129129
},
130+
"AddLocalInventories": {
131+
"methods": [
132+
"add_local_inventories"
133+
]
134+
},
130135
"CreateProduct": {
131136
"methods": [
132137
"create_product"
@@ -157,6 +162,11 @@
157162
"remove_fulfillment_places"
158163
]
159164
},
165+
"RemoveLocalInventories": {
166+
"methods": [
167+
"remove_local_inventories"
168+
]
169+
},
160170
"SetInventory": {
161171
"methods": [
162172
"set_inventory"
@@ -177,6 +187,11 @@
177187
"add_fulfillment_places"
178188
]
179189
},
190+
"AddLocalInventories": {
191+
"methods": [
192+
"add_local_inventories"
193+
]
194+
},
180195
"CreateProduct": {
181196
"methods": [
182197
"create_product"
@@ -207,6 +222,11 @@
207222
"remove_fulfillment_places"
208223
]
209224
},
225+
"RemoveLocalInventories": {
226+
"methods": [
227+
"remove_local_inventories"
228+
]
229+
},
210230
"SetInventory": {
211231
"methods": [
212232
"set_inventory"

‎packages/google-cloud-retail/google/cloud/retail_v2/services/catalog_service/async_client.py‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -478,11 +478,6 @@ async def set_default_branch(
478478
- UserEventService will only join events with products from
479479
branch {newBranch}.
480480
481-
This feature is only available for users who have Retail Search
482-
enabled. Please submit a form
483-
`here <https://cloud.google.com/contact>`__ to contact cloud
484-
sales if you are interested in using Retail Search.
485-
486481
487482
.. code-block:: python
488483
@@ -565,11 +560,6 @@ async def get_default_branch(
565560
[CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
566561
method under a specified parent catalog.
567562
568-
This feature is only available for users who have Retail Search
569-
enabled. Please submit a form
570-
`here <https://cloud.google.com/contact>`__ to contact cloud
571-
sales if you are interested in using Retail Search.
572-
573563
574564
.. code-block:: python
575565

‎packages/google-cloud-retail/google/cloud/retail_v2/services/catalog_service/client.py‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -689,11 +689,6 @@ def set_default_branch(
689689
- UserEventService will only join events with products from
690690
branch {newBranch}.
691691
692-
This feature is only available for users who have Retail Search
693-
enabled. Please submit a form
694-
`here <https://cloud.google.com/contact>`__ to contact cloud
695-
sales if you are interested in using Retail Search.
696-
697692
698693
.. code-block:: python
699694
@@ -776,11 +771,6 @@ def get_default_branch(
776771
[CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
777772
method under a specified parent catalog.
778773
779-
This feature is only available for users who have Retail Search
780-
enabled. Please submit a form
781-
`here <https://cloud.google.com/contact>`__ to contact cloud
782-
sales if you are interested in using Retail Search.
783-
784774
785775
.. code-block:: python
786776

‎packages/google-cloud-retail/google/cloud/retail_v2/services/catalog_service/transports/grpc.py‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -327,11 +327,6 @@ def set_default_branch(
327327
- UserEventService will only join events with products from
328328
branch {newBranch}.
329329
330-
This feature is only available for users who have Retail Search
331-
enabled. Please submit a form
332-
`here <https://cloud.google.com/contact>`__ to contact cloud
333-
sales if you are interested in using Retail Search.
334-
335330
Returns:
336331
Callable[[~.SetDefaultBranchRequest],
337332
~.Empty]:
@@ -363,11 +358,6 @@ def get_default_branch(
363358
[CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
364359
method under a specified parent catalog.
365360
366-
This feature is only available for users who have Retail Search
367-
enabled. Please submit a form
368-
`here <https://cloud.google.com/contact>`__ to contact cloud
369-
sales if you are interested in using Retail Search.
370-
371361
Returns:
372362
Callable[[~.GetDefaultBranchRequest],
373363
~.GetDefaultBranchResponse]:

‎packages/google-cloud-retail/google/cloud/retail_v2/services/catalog_service/transports/grpc_asyncio.py‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -334,11 +334,6 @@ def set_default_branch(
334334
- UserEventService will only join events with products from
335335
branch {newBranch}.
336336
337-
This feature is only available for users who have Retail Search
338-
enabled. Please submit a form
339-
`here <https://cloud.google.com/contact>`__ to contact cloud
340-
sales if you are interested in using Retail Search.
341-
342337
Returns:
343338
Callable[[~.SetDefaultBranchRequest],
344339
Awaitable[~.Empty]]:
@@ -370,11 +365,6 @@ def get_default_branch(
370365
[CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
371366
method under a specified parent catalog.
372367
373-
This feature is only available for users who have Retail Search
374-
enabled. Please submit a form
375-
`here <https://cloud.google.com/contact>`__ to contact cloud
376-
sales if you are interested in using Retail Search.
377-
378368
Returns:
379369
Callable[[~.GetDefaultBranchRequest],
380370
Awaitable[~.GetDefaultBranchResponse]]:

‎packages/google-cloud-retail/google/cloud/retail_v2/services/completion_service/async_client.py‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,9 @@
4242

4343
class CompletionServiceAsyncClient:
4444
"""Auto-completion service for retail.
45-
4645
This feature is only available for users who have Retail Search
47-
enabled. Please submit a form
48-
`here <https://cloud.google.com/contact>`__ to contact cloud sales
49-
if you are interested in using Retail Search.
46+
enabled. Please enable Retail Search on Cloud Console before
47+
using this feature.
5048
"""
5149

5250
_client: CompletionServiceClient
@@ -218,12 +216,11 @@ async def complete_query(
218216
timeout: float = None,
219217
metadata: Sequence[Tuple[str, str]] = (),
220218
) -> completion_service.CompleteQueryResponse:
221-
r"""Completes the specified prefix with keyword suggestions.
222-
223-
This feature is only available for users who have Retail Search
224-
enabled. Please submit a form
225-
`here <https://cloud.google.com/contact>`__ to contact cloud
226-
sales if you are interested in using Retail Search.
219+
r"""Completes the specified prefix with keyword
220+
suggestions.
221+
This feature is only available for users who have Retail
222+
Search enabled. Please enable Retail Search on Cloud
223+
Console before using this feature.
227224
228225
229226
.. code-block:: python
@@ -291,14 +288,14 @@ async def import_completion_data(
291288
metadata: Sequence[Tuple[str, str]] = (),
292289
) -> operation_async.AsyncOperation:
293290
r"""Bulk import of processed completion dataset.
294-
295-
Request processing may be synchronous. Partial updating is not
296-
supported.
297-
298-
This feature is only available for users who have Retail Search
299-
enabled. Please submit a form
300-
`here <https://cloud.google.com/contact>`__ to contact cloud
301-
sales if you are interested in using Retail Search.
291+
Request processing is asynchronous. Partial updating is
292+
not supported.
293+
The operation is successfully finished only after the
294+
imported suggestions are indexed successfully and ready
295+
for serving. The process takes hours.
296+
This feature is only available for users who have Retail
297+
Search enabled. Please enable Retail Search on Cloud
298+
Console before using this feature.
302299
303300
304301
.. code-block:: python

‎packages/google-cloud-retail/google/cloud/retail_v2/services/completion_service/client.py‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,9 @@ def get_transport_class(
8080

8181
class CompletionServiceClient(metaclass=CompletionServiceClientMeta):
8282
"""Auto-completion service for retail.
83-
8483
This feature is only available for users who have Retail Search
85-
enabled. Please submit a form
86-
`here <https://cloud.google.com/contact>`__ to contact cloud sales
87-
if you are interested in using Retail Search.
84+
enabled. Please enable Retail Search on Cloud Console before
85+
using this feature.
8886
"""
8987

9088
@staticmethod
@@ -417,12 +415,11 @@ def complete_query(
417415
timeout: float = None,
418416
metadata: Sequence[Tuple[str, str]] = (),
419417
) -> completion_service.CompleteQueryResponse:
420-
r"""Completes the specified prefix with keyword suggestions.
421-
422-
This feature is only available for users who have Retail Search
423-
enabled. Please submit a form
424-
`here <https://cloud.google.com/contact>`__ to contact cloud
425-
sales if you are interested in using Retail Search.
418+
r"""Completes the specified prefix with keyword
419+
suggestions.
420+
This feature is only available for users who have Retail
421+
Search enabled. Please enable Retail Search on Cloud
422+
Console before using this feature.
426423
427424
428425
.. code-block:: python
@@ -491,14 +488,14 @@ def import_completion_data(
491488
metadata: Sequence[Tuple[str, str]] = (),
492489
) -> operation.Operation:
493490
r"""Bulk import of processed completion dataset.
494-
495-
Request processing may be synchronous. Partial updating is not
496-
supported.
497-
498-
This feature is only available for users who have Retail Search
499-
enabled. Please submit a form
500-
`here <https://cloud.google.com/contact>`__ to contact cloud
501-
sales if you are interested in using Retail Search.
491+
Request processing is asynchronous. Partial updating is
492+
not supported.
493+
The operation is successfully finished only after the
494+
imported suggestions are indexed successfully and ready
495+
for serving. The process takes hours.
496+
This feature is only available for users who have Retail
497+
Search enabled. Please enable Retail Search on Cloud
498+
Console before using this feature.
502499
503500
504501
.. code-block:: python

0 commit comments

Comments
 (0)