You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Enrolls retail API solution for the project. Recommendation solution is enrolled by default when your project enables Retail API. You don't need to call this API for the recommendation solution.</p>
<pre>Enrolls retail API solution for the project. Recommendation solution is enrolled by default when your project enables Retail API. You don't need to call this API for the recommendation solution.
113
+
114
+
Args:
115
+
project: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
116
+
body: object, The request body.
117
+
The object takes the form of:
118
+
119
+
{ # Request for EnrollSolution method.
120
+
"searchSolutionUseCase": "A String", # Solution use case to enroll. Currently settable for Browse to enroll. It should be only set when [solution] is set as SolutionType.SOLUTION_TYPE_SEARCH or an INVALID_ARGUMENT error is thrown.
121
+
"solution": "A String", # Required. Solution to enroll.
122
+
}
123
+
124
+
x__xgafv: string, V1 error format.
125
+
Allowed values
126
+
1 - v1 error format
127
+
2 - v2 error format
128
+
129
+
Returns:
130
+
An object of the form:
131
+
132
+
{ # This resource represents a long-running operation that is the result of a network API call.
133
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
134
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
135
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
136
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
137
+
{
138
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
139
+
},
140
+
],
141
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
142
+
},
143
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
144
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
145
+
},
146
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
147
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
148
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Gets the project. Throws NOT_FOUND if the project wasn't initialized for Retail API Service.
156
+
157
+
Args:
158
+
name: string, Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject` (required)
159
+
x__xgafv: string, V1 error format.
160
+
Allowed values
161
+
1 - v1 error format
162
+
2 - v2 error format
163
+
164
+
Returns:
165
+
An object of the form:
166
+
167
+
{ # Metadata that describes a Cloud Retail Project.
168
+
"enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled.
169
+
"A String",
170
+
],
171
+
"name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`.
<pclass="firstline">Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms</p>
<pre>Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms
87
+
88
+
Args:
89
+
project: string, Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject` (required)
90
+
body: object, The request body.
91
+
The object takes the form of:
92
+
93
+
{ # Request for AcceptTerms method.
94
+
}
95
+
96
+
x__xgafv: string, V1 error format.
97
+
Allowed values
98
+
1 - v1 error format
99
+
2 - v2 error format
100
+
101
+
Returns:
102
+
An object of the form:
103
+
104
+
{ # Metadata that describes a Cloud Retail Project.
105
+
"enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled.
106
+
"A String",
107
+
],
108
+
"name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`.
"description": "Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.",
"description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.",
2817
2820
"type": "boolean"
2818
2821
},
@@ -2825,6 +2828,7 @@
2825
2828
"type": "array"
2826
2829
},
2827
2830
"searchable": {
2831
+
"deprecated": true,
2828
2832
"description": "This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.",
2829
2833
"type": "boolean"
2830
2834
},
@@ -3004,6 +3008,7 @@
3004
3008
"type": "string"
3005
3009
},
3006
3010
"requestId": {
3011
+
"deprecated": true,
3007
3012
"description": "Deprecated. This field is never set.",
3008
3013
"type": "string"
3009
3014
},
@@ -3051,6 +3056,7 @@
3051
3056
"type": "string"
3052
3057
},
3053
3058
"requestId": {
3059
+
"deprecated": true,
3054
3060
"description": "Deprecated. This field has no effect.",
3055
3061
"type": "string"
3056
3062
},
@@ -3470,6 +3476,7 @@
3470
3476
"type": "integer"
3471
3477
},
3472
3478
"pageToken": {
3479
+
"deprecated": true,
3473
3480
"description": "This field is not used; leave it unset.",
3474
3481
"type": "string"
3475
3482
},
@@ -3755,6 +3762,7 @@
3755
3762
"description": "The rating of this product."
3756
3763
},
3757
3764
"retrievableFields": {
3765
+
"deprecated": true,
3758
3766
"description": "Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form \"attributes.key\" where \"key\" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.",
"description": "Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated."
0 commit comments