Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / cloudsearch_v1.query.html
blob: 2a0ea9a1627849819bdd320bd43ceeda54755cef [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.query.html">query</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudsearch_v1.query.sources.html">sources()</a></code>
79</p>
80<p class="firstline">Returns the sources Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#search">search(body, x__xgafv=None)</a></code></p>
84<p class="firstline">The Cloud Search Query API provides the search method, which returns</p>
85<p class="toc_element">
86 <code><a href="#suggest">suggest(body, x__xgafv=None)</a></code></p>
87<p class="firstline">Provides suggestions for autocompleting the query.</p>
88<h3>Method Details</h3>
89<div class="method">
90 <code class="details" id="search">search(body, x__xgafv=None)</code>
91 <pre>The Cloud Search Query API provides the search method, which returns
92the most relevant results from a user query. The results can come from
93G Suite Apps, such as Gmail or Google Drive, or they can come from data
94that you have indexed from a third party.
95
96Args:
97 body: object, The request body. (required)
98 The object takes the form of:
99
100{ # The search API request.
101 "facetOptions": [
102 { # Specifies operators to return facet results for. There will be one
103 # FacetResult for every source_name/object_type/operator_name combination.
104 "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
105 # If empty, all data sources will be used.
106 "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
107 # Defaults to 10.
108 # Maximum value is 100.
109 "operatorName": "A String", # Name of the operator chosen for faceting. @see
110 # cloudsearch.SchemaPropertyOptions
111 "objectType": "A String", # If object_type is set, only those objects of that type will be used to
112 # compute facets. If empty, then all objects will be used to compute facets.
113 },
114 ],
115 "pageSize": 42, # Maximum number of search results to return in one page.
116 # Valid values are between 1 and 100, inclusive.
117 # Default value is 10.
118 "queryInterpretationOptions": { # Options to interpret user query. # Options to interpret the user query.
119 "disableNlInterpretation": True or False, # Flag to disable natural language (NL) interpretation of queries. Default is
120 # false, Set to true to disable natural language interpretation. NL
121 # interpretation only applies to predefined datasources.
122 },
123 "sortOptions": { # The options for sorting the search results
124 "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
125 # The corresponding property must be marked as
126 # sortable.
127 "sortOrder": "A String", # Ascending is the default sort order
128 },
129 "dataSourceRestrictions": [ # The sources to use for querying. If not specified, all data sources
130 # from the current search application are used.
131 { # Restriction on Datasource.
132 "filterOptions": [ # Filter options restricting the results. If multiple filters
133 # are present, they are grouped by object type before joining.
134 # Filters with the same object type are joined conjunctively, then
135 # the resulting expressions are joined disjunctively.
136 #
137 # The maximum number of elements is 20.
138 #
139 # NOTE: Suggest API supports only few filters at the moment:
140 # "objecttype", "type" and "mimetype".
141 # For now, schema specific filters cannot be used to filter suggestions.
142 { # Filter options to be applied on query.
143 "filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
144 # approaches: <br/><br/>
145 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
146 # the schema for your data source.
147 # <br/>
148 # **2. Setting a CompositeFilter.** The filters are evaluated
149 # using the logical operator. The top-level operators can only be either an AND
150 # or a NOT. AND can appear only at the top-most level. OR can appear only under
151 # a top-level AND.
152 "compositeFilter": {
153 "subFilters": [ # Sub filters.
154 # Object with schema name: Filter
155 ],
156 "logicOperator": "A String", # The logic operator of the sub filter.
157 },
158 "valueFilter": {
159 "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
160 # The filter can work against both types of filters defined in the schema
161 # for your data source:
162 # <br/><br/>
163 # 1. `operator_name`, where the query filters results by the property
164 # that matches the value.
165 # <br/>
166 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
167 # schema. The query filters the results for the property values that are
168 # greater than or less than the supplied value in the query.
169 "value": { # Definition of a single value with generic type. # The value to be compared with.
170 "timestampValue": "A String",
171 "doubleValue": 3.14,
172 "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.
173 "month": 42, # Month of date. Must be from 1 to 12.
174 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
175 "year": 42, # Year of date. Must be from 1 to 9999.
176 },
177 "stringValue": "A String",
178 "booleanValue": True or False,
179 "integerValue": "A String",
180 },
181 },
182 },
183 "objectType": "A String", # If object_type is set, only objects of that type are returned. This should
184 # correspond to the name of the object that was registered within the
185 # definition of schema. The maximum length is 256 characters.
186 },
187 ],
188 "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
189 "predefinedSource": "A String", # Predefined content source for Google Apps.
190 "name": "A String", # Source name for content indexed by the
191 # Indexing API.
192 },
193 },
194 ],
195 "start": 42, # Starting index of the results.
196 "query": "A String", # The raw query string.
197 # See supported search operators in the [Cloud search
198 # Cheat
199 # Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/)
200 "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
201 "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn".
202 # For more information, see
203 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
204 # For translations.
205 #
206 # When specified, the documents in search results are biased towards the
207 # specified language.
208 # Suggest API does not use this parameter. It autocompletes only based on
209 # characters in the query.
210 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
211 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
212 # Otherwise, ignore this field.
213 },
214 "searchApplicationId": "A String", # Id of the application created using SearchApplicationsService.
215 "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or
216 # "Australia/Sydney". These IDs are defined by
217 # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)
218 # project, and currently available in the file
219 # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml)
220 },
221 }
222
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228Returns:
229 An object of the form:
230
231 { # The search API response.
232 "structuredResults": [ # Structured results for the user query. These results are not counted
233 # against the page_size.
234 { # Structured results that are returned as part of search request.
235 "person": { # Object to represent a person. # Representation of a person
236 "photos": [ # A person's read-only photo. A picture shown next to the person's name to
237 # help others recognize the person in search results.
238 { # A person's photo.
239 "url": "A String", # The URL of the photo.
240 },
241 ],
242 "emailAddresses": [ # The person's email addresses
243 { # A person's email address.
244 "emailAddress": "A String", # The email address.
245 },
246 ],
247 "name": "A String", # The resource name of the person to provide information about.
248 # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
249 # People.get</a> from Google People API.
250 "personNames": [ # The person's name
251 { # A person's name.
252 "displayName": "A String", # The read-only display name formatted according to the locale specified by
253 # the viewer's account or the <code>Accept-Language</code> HTTP header.
254 },
255 ],
256 "obfuscatedId": "A String", # Obfuscated ID of a person.
257 },
258 },
259 ],
260 "queryInterpretation": { # Query interpretation result for user query. Empty if query interpretation
261 # is disabled.
262 "interpretationType": "A String",
263 "interpretedQuery": "A String", # The interpretation of the query used in search. For example, query "email
264 # from john" will be interpreted as "from:john source:mail"
265 },
266 "debugInfo": { # Debugging information about the response. # Debugging information about the response.
267 "formattedDebugInfo": "A String", # General debug info formatted for display.
268 },
269 "spellResults": [ # Suggested spelling for the query.
270 {
271 "suggestedQuery": "A String", # The suggested spelling of the query.
272 },
273 ],
274 "results": [ # Results from a search query.
275 { # Results containing indexed information for a document.
276 "title": "A String", # Title of the search result.
277 "debugInfo": { # Debugging information about the result. # Debugging information about this search result.
278 "formattedDebugInfo": "A String", # General debug info formatted for display.
279 },
280 "snippet": { # Snippet of the search result, which summarizes the content of the resulting # The concatenation of all snippets (summaries) available for this result.
281 # page.
282 "snippet": "A String", # The snippet of the document.
283 # The snippet of the document. May contain escaped HTML character that
284 # should be unescaped prior to rendering.
285 "matchRanges": [ # The matched ranges in the snippet.
286 { # Matched range of a snippet [start, end).
287 "start": 42, # Starting position of the match in the snippet.
288 "end": 42, # End of the match in the snippet.
289 },
290 ],
291 },
292 "url": "A String", # The URL of the search result. The URL contains a Google redirect to the
293 # actual item. This URL is signed and shouldn't be changed.
294 "clusteredResults": [ # If source is clustered, provide list of clustered results. There will only
295 # be one level of clustered results. If current source is not enabled for
296 # clustering, this field will be empty.
297 # Object with schema name: SearchResult
298 ],
299 "metadata": { # Metadata of a matched search result. # Metadata of the search result.
300 "mimeType": "A String", # Mime type of the search result.
301 "updateTime": "A String", # The last modified date for the object in the search result. If not
302 # set in the item, the value returned here is empty. When
303 # `updateTime` is used for calculating freshness and is not set, this
304 # value defaults to 2 years from the current time.
305 "fields": [ # Indexed fields in structured data, returned as a generic named property.
306 { # A typed name-value pair for structured data. The type of the value should
307 # be the same as the registered type for the `name` property in the object
308 # definition of `objectType`.
309 "objectValues": { # List of object values.
310 "values": [
311 # Object with schema name: StructuredDataObject
312 ],
313 },
314 "dateValues": { # List of date values.
315 "values": [
316 { # 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.
317 "month": 42, # Month of date. Must be from 1 to 12.
318 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
319 "year": 42, # Year of date. Must be from 1 to 9999.
320 },
321 ],
322 },
323 "textValues": { # List of text values.
324 "values": [ # The maximum allowable length for text values is 2048 characters.
325 "A String",
326 ],
327 },
328 "enumValues": { # List of enum values.
329 "values": [ # The maximum allowable length for string values is 32 characters.
330 "A String",
331 ],
332 },
333 "integerValues": { # List of integer values.
334 "values": [
335 "A String",
336 ],
337 },
338 "doubleValues": { # List of double values.
339 "values": [
340 3.14,
341 ],
342 },
343 "htmlValues": { # List of html values.
344 "values": [ # The maximum allowable length for html values is 2048 characters.
345 "A String",
346 ],
347 },
348 "booleanValue": True or False,
349 "timestampValues": { # List of timestamp values.
350 "values": [
351 "A String",
352 ],
353 },
354 "name": "A String", # The name of the property. This name should correspond to the name of the
355 # property that was registered for object definition in the schema.
356 # The maximum allowable length for this property is 256 characters.
357 },
358 ],
359 "source": { # Defines sources for the suggest/search APIs. # The named source for the result, such as Gmail.
360 "predefinedSource": "A String", # Predefined content source for Google Apps.
361 "name": "A String", # Source name for content indexed by the
362 # Indexing API.
363 },
364 "owner": { # Object to represent a person. # Owner (usually creator) of the document or object of the search result.
365 "photos": [ # A person's read-only photo. A picture shown next to the person's name to
366 # help others recognize the person in search results.
367 { # A person's photo.
368 "url": "A String", # The URL of the photo.
369 },
370 ],
371 "emailAddresses": [ # The person's email addresses
372 { # A person's email address.
373 "emailAddress": "A String", # The email address.
374 },
375 ],
376 "name": "A String", # The resource name of the person to provide information about.
377 # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
378 # People.get</a> from Google People API.
379 "personNames": [ # The person's name
380 { # A person's name.
381 "displayName": "A String", # The read-only display name formatted according to the locale specified by
382 # the viewer's account or the <code>Accept-Language</code> HTTP header.
383 },
384 ],
385 "obfuscatedId": "A String", # Obfuscated ID of a person.
386 },
387 "createTime": "A String", # The creation time for this document or object in the search result.
388 "displayOptions": { # Options that specify how to display a structured data search result.
389 "objectTypeLabel": "A String", # The display label for the object.
390 "metalines": [ # The metalines content to be displayed with the result.
391 { # The collection of fields that make up a displayed line
392 "fields": [
393 { # Display Fields for Search Results
394 "property": { # A typed name-value pair for structured data. The type of the value should # The name value pair for the property.
395 # be the same as the registered type for the `name` property in the object
396 # definition of `objectType`.
397 "objectValues": { # List of object values.
398 "values": [
399 # Object with schema name: StructuredDataObject
400 ],
401 },
402 "dateValues": { # List of date values.
403 "values": [
404 { # 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.
405 "month": 42, # Month of date. Must be from 1 to 12.
406 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
407 "year": 42, # Year of date. Must be from 1 to 9999.
408 },
409 ],
410 },
411 "textValues": { # List of text values.
412 "values": [ # The maximum allowable length for text values is 2048 characters.
413 "A String",
414 ],
415 },
416 "enumValues": { # List of enum values.
417 "values": [ # The maximum allowable length for string values is 32 characters.
418 "A String",
419 ],
420 },
421 "integerValues": { # List of integer values.
422 "values": [
423 "A String",
424 ],
425 },
426 "doubleValues": { # List of double values.
427 "values": [
428 3.14,
429 ],
430 },
431 "htmlValues": { # List of html values.
432 "values": [ # The maximum allowable length for html values is 2048 characters.
433 "A String",
434 ],
435 },
436 "booleanValue": True or False,
437 "timestampValues": { # List of timestamp values.
438 "values": [
439 "A String",
440 ],
441 },
442 "name": "A String", # The name of the property. This name should correspond to the name of the
443 # property that was registered for object definition in the schema.
444 # The maximum allowable length for this property is 256 characters.
445 },
446 "operatorName": "A String", # The operator name of the property.
447 "label": "A String", # The display label for the property.
448 },
449 ],
450 },
451 ],
452 },
453 "objectType": "A String", # Object type of the search result.
454 },
455 },
456 ],
457 "resultCounts": { # Result count information # Expanded result count information.
458 "sourceResultCounts": [ # Result count information for each source with results.
459 { # Per source result count information.
460 "source": { # Defines sources for the suggest/search APIs. # The source the result count information is associated with.
461 "predefinedSource": "A String", # Predefined content source for Google Apps.
462 "name": "A String", # Source name for content indexed by the
463 # Indexing API.
464 },
465 "resultCountExact": "A String", # The exact result count for this source.
466 "hasMoreResults": True or False, # Whether there are more search results for this source.
467 "resultCountEstimate": "A String", # The estimated result count for this source.
468 },
469 ],
470 },
471 "resultCountEstimate": "A String", # The estimated result count for this query.
472 "resultCountExact": "A String", # The exact result count for this query.
473 "facetResults": [ # Repeated facet results.
474 { # Source specific facet response
475 "sourceName": "A String", # Source name for which facet results are returned. Will not be empty.
476 "buckets": [ # FacetBuckets for values in response containing at least a single result.
477 { # A bucket in a facet is the basic unit of operation. A bucket can comprise
478 # either a single value OR a contiguous range of values, depending on the
479 # type of the field bucketed.
480 # FacetBucket is currently used only for returning the response object.
481 "count": 42, # Number of results that match the bucket value. Counts are only returned
482 # for searches when count accuracy is ensured. Can be empty.
483 "percentage": 42, # Percent of results that match the bucket value. This value is between
484 # (0-100]. Percentages are returned for all searches, but are an estimate.
485 # Because percentages are always returned, you should render percentages
486 # instead of counts.
487 "value": { # Definition of a single value with generic type.
488 "timestampValue": "A String",
489 "doubleValue": 3.14,
490 "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.
491 "month": 42, # Month of date. Must be from 1 to 12.
492 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
493 "year": 42, # Year of date. Must be from 1 to 9999.
494 },
495 "stringValue": "A String",
496 "booleanValue": True or False,
497 "integerValue": "A String",
498 },
499 },
500 ],
501 "operatorName": "A String", # Name of the operator chosen for faceting. @see
502 # cloudsearch.SchemaPropertyOptions
503 "objectType": "A String", # Object type for which facet results are returned. Can be empty.
504 },
505 ],
506 "errorInfo": { # Error information about the response. # Error information about the response.
507 "errorMessages": [
508 { # Error message per source response.
509 "source": { # Defines sources for the suggest/search APIs.
510 "predefinedSource": "A String", # Predefined content source for Google Apps.
511 "name": "A String", # Source name for content indexed by the
512 # Indexing API.
513 },
514 "errorMessage": "A String",
515 },
516 ],
517 },
518 "hasMoreResults": True or False, # Whether there are more search results matching the query.
519 }</pre>
520</div>
521
522<div class="method">
523 <code class="details" id="suggest">suggest(body, x__xgafv=None)</code>
524 <pre>Provides suggestions for autocompleting the query.
525
526Args:
527 body: object, The request body. (required)
528 The object takes the form of:
529
530{ # Request of suggest API.
531 "dataSourceRestrictions": [ # The sources to use for suggestions. If not specified, all data sources
532 # from the current search application are used.
533 # Suggestions are based on Gmail titles. Suggestions from third party sources
534 # are not available.
535 { # Restriction on Datasource.
536 "filterOptions": [ # Filter options restricting the results. If multiple filters
537 # are present, they are grouped by object type before joining.
538 # Filters with the same object type are joined conjunctively, then
539 # the resulting expressions are joined disjunctively.
540 #
541 # The maximum number of elements is 20.
542 #
543 # NOTE: Suggest API supports only few filters at the moment:
544 # "objecttype", "type" and "mimetype".
545 # For now, schema specific filters cannot be used to filter suggestions.
546 { # Filter options to be applied on query.
547 "filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
548 # approaches: <br/><br/>
549 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
550 # the schema for your data source.
551 # <br/>
552 # **2. Setting a CompositeFilter.** The filters are evaluated
553 # using the logical operator. The top-level operators can only be either an AND
554 # or a NOT. AND can appear only at the top-most level. OR can appear only under
555 # a top-level AND.
556 "compositeFilter": {
557 "subFilters": [ # Sub filters.
558 # Object with schema name: Filter
559 ],
560 "logicOperator": "A String", # The logic operator of the sub filter.
561 },
562 "valueFilter": {
563 "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
564 # The filter can work against both types of filters defined in the schema
565 # for your data source:
566 # <br/><br/>
567 # 1. `operator_name`, where the query filters results by the property
568 # that matches the value.
569 # <br/>
570 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
571 # schema. The query filters the results for the property values that are
572 # greater than or less than the supplied value in the query.
573 "value": { # Definition of a single value with generic type. # The value to be compared with.
574 "timestampValue": "A String",
575 "doubleValue": 3.14,
576 "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.
577 "month": 42, # Month of date. Must be from 1 to 12.
578 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
579 "year": 42, # Year of date. Must be from 1 to 9999.
580 },
581 "stringValue": "A String",
582 "booleanValue": True or False,
583 "integerValue": "A String",
584 },
585 },
586 },
587 "objectType": "A String", # If object_type is set, only objects of that type are returned. This should
588 # correspond to the name of the object that was registered within the
589 # definition of schema. The maximum length is 256 characters.
590 },
591 ],
592 "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
593 "predefinedSource": "A String", # Predefined content source for Google Apps.
594 "name": "A String", # Source name for content indexed by the
595 # Indexing API.
596 },
597 },
598 ],
599 "query": "A String", # Partial query for which autocomplete suggestions will be shown.
600 # For example, if the query is "sea", then the server might return
601 # "season", "search", "seagull" and so on.
602 "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
603 "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn".
604 # For more information, see
605 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
606 # For translations.
607 #
608 # When specified, the documents in search results are biased towards the
609 # specified language.
610 # Suggest API does not use this parameter. It autocompletes only based on
611 # characters in the query.
612 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
613 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
614 # Otherwise, ignore this field.
615 },
616 "searchApplicationId": "A String", # Id of the application created using SearchApplicationsService.
617 "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or
618 # "Australia/Sydney". These IDs are defined by
619 # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)
620 # project, and currently available in the file
621 # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml)
622 },
623 }
624
625 x__xgafv: string, V1 error format.
626 Allowed values
627 1 - v1 error format
628 2 - v2 error format
629
630Returns:
631 An object of the form:
632
633 { # Response of the suggest API.
634 "suggestResults": [ # List of suggestions.
635 { # One suggestion result.
636 "source": { # Defines sources for the suggest/search APIs. # The source of the suggestion.
637 "predefinedSource": "A String", # Predefined content source for Google Apps.
638 "name": "A String", # Source name for content indexed by the
639 # Indexing API.
640 },
641 "peopleSuggestion": { # This field contains information about the person being suggested. # This is present when the suggestion indicates a person. It
642 # contains more information about the person - like their email ID,
643 # name etc.
644 "person": { # Object to represent a person. # Suggested person. All fields of the person object might not be populated.
645 "photos": [ # A person's read-only photo. A picture shown next to the person's name to
646 # help others recognize the person in search results.
647 { # A person's photo.
648 "url": "A String", # The URL of the photo.
649 },
650 ],
651 "emailAddresses": [ # The person's email addresses
652 { # A person's email address.
653 "emailAddress": "A String", # The email address.
654 },
655 ],
656 "name": "A String", # The resource name of the person to provide information about.
657 # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
658 # People.get</a> from Google People API.
659 "personNames": [ # The person's name
660 { # A person's name.
661 "displayName": "A String", # The read-only display name formatted according to the locale specified by
662 # the viewer's account or the <code>Accept-Language</code> HTTP header.
663 },
664 ],
665 "obfuscatedId": "A String", # Obfuscated ID of a person.
666 },
667 },
668 "suggestedQuery": "A String", # The suggested query that will be used for search, when the user
669 # clicks on the suggestion
670 "querySuggestion": { # This field does not contain anything as of now and is just used as an # This field will be present if the suggested query is a word/phrase
671 # completion.
672 # indicator that the suggest result was a phrase completion.
673 },
674 },
675 ],
676 }</pre>
677</div>
678
679</body></html>