1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a> . <a href="cloudsearch_v1.settings.searchapplications.html">searchapplications</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a search application. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a search application. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified search application. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#list">list(debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all search applications. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a search application. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a search application. **Note:** This API requires an admin account to execute.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a search application. **Note:** This API requires an admin account to execute.
Args:
body: object, The request body.
The object takes the form of:
{ # SearchApplication
"dataSourceRestrictions": [ # Retrictions applied to the configurations. The maximum number of elements is 10.
{ # Restriction on Datasource.
"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
"compositeFilter": {
"logicOperator": "A String", # The logic operator of the sub filter.
"subFilters": [ # Sub filters.
# Object with schema name: Filter
],
},
"valueFilter": {
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
"value": { # Definition of a single value with generic type. # The value to be compared with.
"booleanValue": True or False,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"doubleValue": 3.14,
"integerValue": "A String",
"stringValue": "A String",
"timestampValue": "A String",
},
},
},
"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
},
],
"source": { # Defines sources for the suggest/search APIs. # The source of restriction.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
"defaultFacetOptions": [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
{ # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
"integerFacetingOptions": { # Used to specify integer faceting options. # If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
"integerBuckets": [ # Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
"A String",
],
},
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
"objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
"operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
},
],
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
"sortOrder": "A String", # Ascending is the default sort order
},
"displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters.
"enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
"name": "A String", # The name of the Search Application. Format: searchapplications/{application_id}.
"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
"A String",
],
"queryInterpretationConfig": { # Default options to interpret user query. # The default options for query interpretation
"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
"forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
},
"returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable)
"scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
},
"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
{ # Configurations for a source while processing a Search or Suggest request.
"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
"numResults": 42, # Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
"numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
},
"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
"sourceImportance": "A String", # Importance of the source.
},
"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Deletes a search application. **Note:** This API requires an admin account to execute.
Args:
name: string, The name of the search application to be deleted. Format: applications/{application_id}. (required)
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Gets the specified search application. **Note:** This API requires an admin account to execute.
Args:
name: string, The name of the search application. Format: searchapplications/{application_id}. (required)
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SearchApplication
"dataSourceRestrictions": [ # Retrictions applied to the configurations. The maximum number of elements is 10.
{ # Restriction on Datasource.
"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
"compositeFilter": {
"logicOperator": "A String", # The logic operator of the sub filter.
"subFilters": [ # Sub filters.
# Object with schema name: Filter
],
},
"valueFilter": {
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
"value": { # Definition of a single value with generic type. # The value to be compared with.
"booleanValue": True or False,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"doubleValue": 3.14,
"integerValue": "A String",
"stringValue": "A String",
"timestampValue": "A String",
},
},
},
"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
},
],
"source": { # Defines sources for the suggest/search APIs. # The source of restriction.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
"defaultFacetOptions": [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
{ # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
"integerFacetingOptions": { # Used to specify integer faceting options. # If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
"integerBuckets": [ # Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
"A String",
],
},
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
"objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
"operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
},
],
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
"sortOrder": "A String", # Ascending is the default sort order
},
"displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters.
"enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
"name": "A String", # The name of the Search Application. Format: searchapplications/{application_id}.
"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
"A String",
],
"queryInterpretationConfig": { # Default options to interpret user query. # The default options for query interpretation
"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
"forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
},
"returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable)
"scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
},
"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
{ # Configurations for a source while processing a Search or Suggest request.
"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
"numResults": 42, # Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
"numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
},
"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
"sourceImportance": "A String", # Importance of the source.
},
"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all search applications. **Note:** This API requires an admin account to execute.
Args:
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
pageSize: integer, The maximum number of items to return.
pageToken: string, The next_page_token value returned from a previous List request, if any. The default value is 10
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"searchApplications": [
{ # SearchApplication
"dataSourceRestrictions": [ # Retrictions applied to the configurations. The maximum number of elements is 10.
{ # Restriction on Datasource.
"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
"compositeFilter": {
"logicOperator": "A String", # The logic operator of the sub filter.
"subFilters": [ # Sub filters.
# Object with schema name: Filter
],
},
"valueFilter": {
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
"value": { # Definition of a single value with generic type. # The value to be compared with.
"booleanValue": True or False,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"doubleValue": 3.14,
"integerValue": "A String",
"stringValue": "A String",
"timestampValue": "A String",
},
},
},
"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
},
],
"source": { # Defines sources for the suggest/search APIs. # The source of restriction.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
"defaultFacetOptions": [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
{ # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
"integerFacetingOptions": { # Used to specify integer faceting options. # If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
"integerBuckets": [ # Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
"A String",
],
},
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
"objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
"operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
},
],
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
"sortOrder": "A String", # Ascending is the default sort order
},
"displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters.
"enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
"name": "A String", # The name of the Search Application. Format: searchapplications/{application_id}.
"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
"A String",
],
"queryInterpretationConfig": { # Default options to interpret user query. # The default options for query interpretation
"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
"forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
},
"returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable)
"scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
},
"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
{ # Configurations for a source while processing a Search or Suggest request.
"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
"numResults": 42, # Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
"numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
},
"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
"sourceImportance": "A String", # Importance of the source.
},
"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a search application. **Note:** This API requires an admin account to execute.
Args:
name: string, The name of the Search Application. Format: searchapplications/{application_id}. (required)
body: object, The request body.
The object takes the form of:
{ # SearchApplication
"dataSourceRestrictions": [ # Retrictions applied to the configurations. The maximum number of elements is 10.
{ # Restriction on Datasource.
"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
"compositeFilter": {
"logicOperator": "A String", # The logic operator of the sub filter.
"subFilters": [ # Sub filters.
# Object with schema name: Filter
],
},
"valueFilter": {
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
"value": { # Definition of a single value with generic type. # The value to be compared with.
"booleanValue": True or False,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"doubleValue": 3.14,
"integerValue": "A String",
"stringValue": "A String",
"timestampValue": "A String",
},
},
},
"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
},
],
"source": { # Defines sources for the suggest/search APIs. # The source of restriction.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
"defaultFacetOptions": [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
{ # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
"integerFacetingOptions": { # Used to specify integer faceting options. # If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
"integerBuckets": [ # Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
"A String",
],
},
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
"objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
"operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
},
],
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
"sortOrder": "A String", # Ascending is the default sort order
},
"displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters.
"enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
"name": "A String", # The name of the Search Application. Format: searchapplications/{application_id}.
"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
"A String",
],
"queryInterpretationConfig": { # Default options to interpret user query. # The default options for query interpretation
"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
"forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
},
"returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable)
"scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
},
"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
{ # Configurations for a source while processing a Search or Suggest request.
"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
"numResults": 42, # Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
"numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
},
"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
"sourceImportance": "A String", # Importance of the source.
},
"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
}
updateMask: string, Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
<pre>Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.
Args:
name: string, The name of the search application to be reset. Format: applications/{application_id}. (required)
body: object, The request body.
The object takes the form of:
{
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a search application. **Note:** This API requires an admin account to execute.
Args:
name: string, The name of the Search Application. Format: searchapplications/{application_id}. (required)
body: object, The request body.
The object takes the form of:
{ # SearchApplication
"dataSourceRestrictions": [ # Retrictions applied to the configurations. The maximum number of elements is 10.
{ # Restriction on Datasource.
"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
"compositeFilter": {
"logicOperator": "A String", # The logic operator of the sub filter.
"subFilters": [ # Sub filters.
# Object with schema name: Filter
],
},
"valueFilter": {
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
"value": { # Definition of a single value with generic type. # The value to be compared with.
"booleanValue": True or False,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"doubleValue": 3.14,
"integerValue": "A String",
"stringValue": "A String",
"timestampValue": "A String",
},
},
},
"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
},
],
"source": { # Defines sources for the suggest/search APIs. # The source of restriction.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
"defaultFacetOptions": [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
{ # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
"integerFacetingOptions": { # Used to specify integer faceting options. # If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
"integerBuckets": [ # Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
"A String",
],
},
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
"objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
"operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
},
],
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
"sortOrder": "A String", # Ascending is the default sort order
},
"displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters.
"enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
"name": "A String", # The name of the Search Application. Format: searchapplications/{application_id}.
"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
"A String",
],
"queryInterpretationConfig": { # Default options to interpret user query. # The default options for query interpretation
"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
"forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
},
"returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable)
"scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
},
"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
{ # Configurations for a source while processing a Search or Suggest request.
"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
"numResults": 42, # Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.
"numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
},
"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
"sourceImportance": "A String", # Importance of the source.
},
"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
"name": "A String", # Source name for content indexed by the Indexing API.
"predefinedSource": "A String", # Predefined content source for Google Apps.
},
},
],
}
updateMask: string, Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
