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
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -161,7 +161,7 @@ <h3>Method Details</h3>
161
161
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
162
162
"imageUri": "A String", # Optional. The promotion thumbnail image url.
163
163
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
164
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
164
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
165
165
},
166
166
},
167
167
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -238,7 +238,7 @@ <h3>Method Details</h3>
238
238
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
239
239
"imageUri": "A String", # Optional. The promotion thumbnail image url.
240
240
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
241
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
241
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
242
242
},
243
243
},
244
244
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -339,7 +339,7 @@ <h3>Method Details</h3>
339
339
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
340
340
"imageUri": "A String", # Optional. The promotion thumbnail image url.
341
341
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
342
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
342
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
343
343
},
344
344
},
345
345
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -427,7 +427,7 @@ <h3>Method Details</h3>
427
427
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
428
428
"imageUri": "A String", # Optional. The promotion thumbnail image url.
429
429
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
430
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
430
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
431
431
},
432
432
},
433
433
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -522,7 +522,7 @@ <h3>Method Details</h3>
522
522
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
523
523
"imageUri": "A String", # Optional. The promotion thumbnail image url.
524
524
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
525
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
525
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
526
526
},
527
527
},
528
528
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -599,7 +599,7 @@ <h3>Method Details</h3>
599
599
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
600
600
"imageUri": "A String", # Optional. The promotion thumbnail image url.
601
601
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
602
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
602
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
603
603
},
604
604
},
605
605
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
1044
1045
},
1045
1046
],
1047
+
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
1048
+
"matchHighlightingCondition": "A String", # The condition under which match highlighting should occur.
1049
+
},
1046
1050
"facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
1047
1051
{ # A facet specification to perform faceted search.
1048
1052
"enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
@@ -1233,7 +1237,7 @@ <h3>Method Details</h3>
1233
1237
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
1234
1238
"imageUri": "A String", # Optional. The promotion thumbnail image url.
1235
1239
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
1236
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
1240
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
1237
1241
},
1238
1242
],
1239
1243
"sessionInfo": { # Information about the session. # Session information. Only set if SearchRequest.session is provided. See its description for more details.
@@ -1378,6 +1382,9 @@ <h3>Method Details</h3>
1378
1382
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
1379
1383
},
1380
1384
],
1385
+
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
1386
+
"matchHighlightingCondition": "A String", # The condition under which match highlighting should occur.
1387
+
},
1381
1388
"facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
1382
1389
{ # A facet specification to perform faceted search.
1383
1390
"enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
@@ -1568,7 +1575,7 @@ <h3>Method Details</h3>
1568
1575
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
1569
1576
"imageUri": "A String", # Optional. The promotion thumbnail image url.
1570
1577
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
1571
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
1578
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
1572
1579
},
1573
1580
],
1574
1581
"sessionInfo": { # Information about the session. # Session information. Only set if SearchRequest.session is provided. See its description for more details.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -161,7 +161,7 @@ <h3>Method Details</h3>
161
161
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
162
162
"imageUri": "A String", # Optional. The promotion thumbnail image url.
163
163
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
164
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
164
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
165
165
},
166
166
},
167
167
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -238,7 +238,7 @@ <h3>Method Details</h3>
238
238
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
239
239
"imageUri": "A String", # Optional. The promotion thumbnail image url.
240
240
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
241
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
241
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
242
242
},
243
243
},
244
244
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -339,7 +339,7 @@ <h3>Method Details</h3>
339
339
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
340
340
"imageUri": "A String", # Optional. The promotion thumbnail image url.
341
341
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
342
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
342
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
343
343
},
344
344
},
345
345
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -427,7 +427,7 @@ <h3>Method Details</h3>
427
427
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
428
428
"imageUri": "A String", # Optional. The promotion thumbnail image url.
429
429
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
430
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
430
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
431
431
},
432
432
},
433
433
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -522,7 +522,7 @@ <h3>Method Details</h3>
522
522
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
523
523
"imageUri": "A String", # Optional. The promotion thumbnail image url.
524
524
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
525
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
525
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
526
526
},
527
527
},
528
528
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
@@ -599,7 +599,7 @@ <h3>Method Details</h3>
599
599
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
600
600
"imageUri": "A String", # Optional. The promotion thumbnail image url.
601
601
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
602
-
"uri": "A String", # Required. The URL for the page the user wants to promote.
602
+
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
603
603
},
604
604
},
605
605
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
0 commit comments