Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudsearch_v1.query.html
blob: 4c612d12f200baae3af1fcfcae68745dbd61a96c [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87<p class="firstline">The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]89 <code><a href="#suggest">suggest(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90<p class="firstline">Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<h3>Method Details</h3>
92<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code class="details" id="close">close()</code>
94 <pre>Close httplib2 connections.</pre>
95</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<div class="method">
98 <code class="details" id="search">search(body=None, x__xgafv=None)</code>
99 <pre>The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can&#x27;t perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 The object takes the form of:
104
105{ # The search API request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]106 &quot;pageSize&quot;: 42, # Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.
107 &quot;start&quot;: 42, # Starting index of the results.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]108 &quot;requestOptions&quot;: { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]109 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
110 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
111 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]112 &quot;searchApplicationId&quot;: &quot;A String&quot;, # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).
113 &quot;languageCode&quot;: &quot;A String&quot;, # The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user&#x27;s language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
114 &quot;timeZone&quot;: &quot;A String&quot;, # Current user&#x27;s time zone id, such as &quot;America/Los_Angeles&quot; or &quot;Australia/Sydney&quot;. These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]115 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]116 &quot;facetOptions&quot;: [
117 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
118 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
119 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
120 &quot;objectType&quot;: &quot;A String&quot;, # 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.
121 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
122 },
123 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]124 &quot;queryInterpretationOptions&quot;: { # Options to interpret user query. # Options to interpret the user query.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]125 &quot;enableVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]126 &quot;disableNlInterpretation&quot;: True or False, # Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]127 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 &quot;dataSourceRestrictions&quot;: [ # The sources to use for querying. If not specified, all data sources from the current search application are used.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 { # Restriction on Datasource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
131 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
132 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
133 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]134 &quot;filterOptions&quot;: [ # 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: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]135 { # Filter options to be applied on query.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 &quot;filter&quot;: { # 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`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]137 &quot;valueFilter&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]138 &quot;operatorName&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]139 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]140 &quot;doubleValue&quot;: 3.14,
141 &quot;timestampValue&quot;: &quot;A String&quot;,
142 &quot;booleanValue&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]143 &quot;dateValue&quot;: { # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]144 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]145 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
146 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]147 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]148 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]149 &quot;stringValue&quot;: &quot;A String&quot;,
150 },
151 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]152 &quot;compositeFilter&quot;: {
153 &quot;subFilters&quot;: [ # Sub filters.
154 # Object with schema name: Filter
155 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]157 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]158 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]159 &quot;objectType&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]160 },
161 ],
162 },
163 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]164 &quot;query&quot;: &quot;A String&quot;, # The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://support.google.com/a/users/answer/9299929)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]165 &quot;sortOptions&quot;: { # The options for sorting the search results
166 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
167 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
168 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 }
170
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176Returns:
177 An object of the form:
178
179 { # The search API response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]180 &quot;resultCountEstimate&quot;: &quot;A String&quot;, # The estimated result count for this query.
181 &quot;facetResults&quot;: [ # Repeated facet results.
182 { # Source specific facet response
183 &quot;objectType&quot;: &quot;A String&quot;, # Object type for which facet results are returned. Can be empty.
184 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
185 &quot;sourceName&quot;: &quot;A String&quot;, # Source name for which facet results are returned. Will not be empty.
186 &quot;buckets&quot;: [ # FacetBuckets for values in response containing at least a single result.
187 { # A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.
188 &quot;value&quot;: { # Definition of a single value with generic type.
189 &quot;doubleValue&quot;: 3.14,
190 &quot;timestampValue&quot;: &quot;A String&quot;,
191 &quot;booleanValue&quot;: True or False,
192 &quot;dateValue&quot;: { # 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.
193 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
194 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
195 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
196 },
197 &quot;integerValue&quot;: &quot;A String&quot;,
198 &quot;stringValue&quot;: &quot;A String&quot;,
199 },
200 &quot;percentage&quot;: 42, # Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.
201 &quot;count&quot;: 42, # Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty.
202 },
203 ],
204 },
205 ],
206 &quot;resultCountExact&quot;: &quot;A String&quot;, # The exact result count for this query.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]207 &quot;resultCounts&quot;: { # Result count information # Expanded result count information.
208 &quot;sourceResultCounts&quot;: [ # Result count information for each source with results.
209 { # Per source result count information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]210 &quot;hasMoreResults&quot;: True or False, # Whether there are more search results for this source.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]211 &quot;resultCountEstimate&quot;: &quot;A String&quot;, # The estimated result count for this source.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]212 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source the result count information is associated with.
213 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
214 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
215 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]216 &quot;resultCountExact&quot;: &quot;A String&quot;, # The exact result count for this source.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]217 },
218 ],
219 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]220 &quot;spellResults&quot;: [ # Suggested spelling for the query.
221 {
222 &quot;suggestedQuery&quot;: &quot;A String&quot;, # The suggested spelling of the query.
223 },
224 ],
225 &quot;debugInfo&quot;: { # Debugging information about the response. # Debugging information about the response.
226 &quot;formattedDebugInfo&quot;: &quot;A String&quot;, # General debug info formatted for display.
227 },
228 &quot;queryInterpretation&quot;: { # Query interpretation result for user query. Empty if query interpretation is disabled.
229 &quot;interpretedQuery&quot;: &quot;A String&quot;, # The interpretation of the query used in search. For example, queries with natural language intent like &quot;email from john&quot; will be interpreted as &quot;from:john source:mail&quot;. This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.
230 &quot;reason&quot;: &quot;A String&quot;, # The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.
231 &quot;interpretationType&quot;: &quot;A String&quot;,
232 },
233 &quot;hasMoreResults&quot;: True or False, # Whether there are more search results matching the query.
234 &quot;structuredResults&quot;: [ # Structured results for the user query. These results are not counted against the page_size.
235 { # Structured results that are returned as part of search request.
236 &quot;person&quot;: { # Object to represent a person. # Representation of a person
237 &quot;photos&quot;: [ # A person&#x27;s read-only photo. A picture shown next to the person&#x27;s name to help others recognize the person in search results.
238 { # A person&#x27;s photo.
239 &quot;url&quot;: &quot;A String&quot;, # The URL of the photo.
240 },
241 ],
242 &quot;obfuscatedId&quot;: &quot;A String&quot;, # Obfuscated ID of a person.
243 &quot;name&quot;: &quot;A String&quot;, # The resource name of the person to provide information about. See People.get from Google People API.
244 &quot;personNames&quot;: [ # The person&#x27;s name
245 { # A person&#x27;s name.
246 &quot;displayName&quot;: &quot;A String&quot;, # The read-only display name formatted according to the locale specified by the viewer&#x27;s account or the Accept-Language HTTP header.
247 },
248 ],
249 &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses
250 { # A person&#x27;s email address.
251 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address.
252 },
253 ],
254 },
255 },
256 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]257 &quot;errorInfo&quot;: { # Error information about the response. # Error information about the response.
258 &quot;errorMessages&quot;: [
259 { # Error message per source response.
260 &quot;errorMessage&quot;: &quot;A String&quot;,
261 &quot;source&quot;: { # Defines sources for the suggest/search APIs.
262 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
263 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
264 },
265 },
266 ],
267 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]268 &quot;results&quot;: [ # Results from a search query.
269 { # Results containing indexed information for a document.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]270 &quot;metadata&quot;: { # Metadata of a matched search result. # Metadata of the search result.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]271 &quot;fields&quot;: [ # Indexed fields in structured data, returned as a generic named property.
272 { # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]273 &quot;textValues&quot;: { # List of text values.
274 &quot;values&quot;: [ # The maximum allowable length for text values is 2048 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]275 &quot;A String&quot;,
276 ],
277 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]278 &quot;booleanValue&quot;: True or False,
279 &quot;integerValues&quot;: { # List of integer values.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]280 &quot;values&quot;: [
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]281 &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]282 ],
283 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]284 &quot;timestampValues&quot;: { # List of timestamp values.
285 &quot;values&quot;: [
286 &quot;A String&quot;,
287 ],
288 },
289 &quot;htmlValues&quot;: { # List of html values.
290 &quot;values&quot;: [ # The maximum allowable length for html values is 2048 characters.
291 &quot;A String&quot;,
292 ],
293 },
294 &quot;name&quot;: &quot;A String&quot;, # The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]295 &quot;doubleValues&quot;: { # List of double values.
296 &quot;values&quot;: [
297 3.14,
298 ],
299 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]300 &quot;dateValues&quot;: { # List of date values.
301 &quot;values&quot;: [
302 { # 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.
303 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
304 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
305 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
306 },
307 ],
308 },
309 &quot;enumValues&quot;: { # List of enum values.
310 &quot;values&quot;: [ # The maximum allowable length for string values is 32 characters.
311 &quot;A String&quot;,
312 ],
313 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]314 &quot;objectValues&quot;: { # List of object values.
315 &quot;values&quot;: [
316 # Object with schema name: StructuredDataObject
317 ],
318 },
319 },
320 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]321 &quot;createTime&quot;: &quot;A String&quot;, # The creation time for this document or object in the search result.
322 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The named source for the result, such as Gmail.
323 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
324 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
325 },
326 &quot;mimeType&quot;: &quot;A String&quot;, # Mime type of the search result.
327 &quot;displayOptions&quot;: { # Options that specify how to display a structured data search result.
328 &quot;objectTypeLabel&quot;: &quot;A String&quot;, # The display label for the object.
329 &quot;metalines&quot;: [ # The metalines content to be displayed with the result.
330 { # The collection of fields that make up a displayed line
331 &quot;fields&quot;: [
332 { # Display Fields for Search Results
333 &quot;operatorName&quot;: &quot;A String&quot;, # The operator name of the property.
334 &quot;label&quot;: &quot;A String&quot;, # The display label for the property.
335 &quot;property&quot;: { # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`. # The name value pair for the property.
336 &quot;textValues&quot;: { # List of text values.
337 &quot;values&quot;: [ # The maximum allowable length for text values is 2048 characters.
338 &quot;A String&quot;,
339 ],
340 },
341 &quot;booleanValue&quot;: True or False,
342 &quot;integerValues&quot;: { # List of integer values.
343 &quot;values&quot;: [
344 &quot;A String&quot;,
345 ],
346 },
347 &quot;timestampValues&quot;: { # List of timestamp values.
348 &quot;values&quot;: [
349 &quot;A String&quot;,
350 ],
351 },
352 &quot;htmlValues&quot;: { # List of html values.
353 &quot;values&quot;: [ # The maximum allowable length for html values is 2048 characters.
354 &quot;A String&quot;,
355 ],
356 },
357 &quot;name&quot;: &quot;A String&quot;, # The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.
358 &quot;doubleValues&quot;: { # List of double values.
359 &quot;values&quot;: [
360 3.14,
361 ],
362 },
363 &quot;dateValues&quot;: { # List of date values.
364 &quot;values&quot;: [
365 { # 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.
366 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
367 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
368 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
369 },
370 ],
371 },
372 &quot;enumValues&quot;: { # List of enum values.
373 &quot;values&quot;: [ # The maximum allowable length for string values is 32 characters.
374 &quot;A String&quot;,
375 ],
376 },
377 &quot;objectValues&quot;: { # List of object values.
378 &quot;values&quot;: [
379 # Object with schema name: StructuredDataObject
380 ],
381 },
382 },
383 },
384 ],
385 },
386 ],
387 },
388 &quot;objectType&quot;: &quot;A String&quot;, # Object type of the search result.
389 &quot;updateTime&quot;: &quot;A String&quot;, # The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.
390 &quot;owner&quot;: { # Object to represent a person. # Owner (usually creator) of the document or object of the search result.
391 &quot;photos&quot;: [ # A person&#x27;s read-only photo. A picture shown next to the person&#x27;s name to help others recognize the person in search results.
392 { # A person&#x27;s photo.
393 &quot;url&quot;: &quot;A String&quot;, # The URL of the photo.
394 },
395 ],
396 &quot;obfuscatedId&quot;: &quot;A String&quot;, # Obfuscated ID of a person.
397 &quot;name&quot;: &quot;A String&quot;, # The resource name of the person to provide information about. See People.get from Google People API.
398 &quot;personNames&quot;: [ # The person&#x27;s name
399 { # A person&#x27;s name.
400 &quot;displayName&quot;: &quot;A String&quot;, # The read-only display name formatted according to the locale specified by the viewer&#x27;s account or the Accept-Language HTTP header.
401 },
402 ],
403 &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses
404 { # A person&#x27;s email address.
405 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address.
406 },
407 ],
408 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]409 },
410 &quot;debugInfo&quot;: { # Debugging information about the result. # Debugging information about this search result.
411 &quot;formattedDebugInfo&quot;: &quot;A String&quot;, # General debug info formatted for display.
412 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]413 &quot;snippet&quot;: { # Snippet of the search result, which summarizes the content of the resulting page. # The concatenation of all snippets (summaries) available for this result.
414 &quot;matchRanges&quot;: [ # The matched ranges in the snippet.
415 { # Matched range of a snippet [start, end).
416 &quot;end&quot;: 42, # End of the match in the snippet.
417 &quot;start&quot;: 42, # Starting position of the match in the snippet.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]418 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]419 ],
420 &quot;snippet&quot;: &quot;A String&quot;, # The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.
421 },
422 &quot;url&quot;: &quot;A String&quot;, # The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn&#x27;t be changed.
423 &quot;clusteredResults&quot;: [ # If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.
424 # Object with schema name: SearchResult
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]425 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]426 &quot;title&quot;: &quot;A String&quot;, # Title of the search result.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]427 },
428 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]429 }</pre>
430</div>
431
432<div class="method">
433 <code class="details" id="suggest">suggest(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]434 <pre>Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can&#x27;t perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]435
436Args:
437 body: object, The request body.
438 The object takes the form of:
439
440{ # Request of suggest API.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]441 &quot;requestOptions&quot;: { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]442 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
443 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
444 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]445 &quot;searchApplicationId&quot;: &quot;A String&quot;, # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).
446 &quot;languageCode&quot;: &quot;A String&quot;, # The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user&#x27;s language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
447 &quot;timeZone&quot;: &quot;A String&quot;, # Current user&#x27;s time zone id, such as &quot;America/Los_Angeles&quot; or &quot;Australia/Sydney&quot;. These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]448 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]449 &quot;dataSourceRestrictions&quot;: [ # The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are supported only for third party data sources and people (i.e. PredefinedSource.PERSON).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 { # Restriction on Datasource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]451 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
452 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
453 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
454 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]455 &quot;filterOptions&quot;: [ # 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: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 { # Filter options to be applied on query.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]457 &quot;filter&quot;: { # 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`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]458 &quot;valueFilter&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]459 &quot;operatorName&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]460 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]461 &quot;doubleValue&quot;: 3.14,
462 &quot;timestampValue&quot;: &quot;A String&quot;,
463 &quot;booleanValue&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]464 &quot;dateValue&quot;: { # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]465 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]466 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
467 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]468 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]469 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]470 &quot;stringValue&quot;: &quot;A String&quot;,
471 },
472 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]473 &quot;compositeFilter&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]474 &quot;subFilters&quot;: [ # Sub filters.
475 # Object with schema name: Filter
476 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]477 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]478 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]480 &quot;objectType&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]481 },
482 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 },
484 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]485 &quot;query&quot;: &quot;A String&quot;, # Partial query for which autocomplete suggestions will be shown. For example, if the query is &quot;sea&quot;, then the server might return &quot;season&quot;, &quot;search&quot;, &quot;seagull&quot; and so on.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486 }
487
488 x__xgafv: string, V1 error format.
489 Allowed values
490 1 - v1 error format
491 2 - v2 error format
492
493Returns:
494 An object of the form:
495
496 { # Response of the suggest API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]497 &quot;suggestResults&quot;: [ # List of suggestions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 { # One suggestion result.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]499 &quot;suggestedQuery&quot;: &quot;A String&quot;, # The suggested query that will be used for search, when the user clicks on the suggestion
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]500 &quot;peopleSuggestion&quot;: { # This field contains information about the person being suggested. # This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]501 &quot;person&quot;: { # Object to represent a person. # Suggested person. All fields of the person object might not be populated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]502 &quot;photos&quot;: [ # A person&#x27;s read-only photo. A picture shown next to the person&#x27;s name to help others recognize the person in search results.
503 { # A person&#x27;s photo.
504 &quot;url&quot;: &quot;A String&quot;, # The URL of the photo.
505 },
506 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]507 &quot;obfuscatedId&quot;: &quot;A String&quot;, # Obfuscated ID of a person.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]508 &quot;name&quot;: &quot;A String&quot;, # The resource name of the person to provide information about. See People.get from Google People API.
509 &quot;personNames&quot;: [ # The person&#x27;s name
510 { # A person&#x27;s name.
511 &quot;displayName&quot;: &quot;A String&quot;, # The read-only display name formatted according to the locale specified by the viewer&#x27;s account or the Accept-Language HTTP header.
512 },
513 ],
514 &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses
515 { # A person&#x27;s email address.
516 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address.
517 },
518 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]519 },
520 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]521 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of the suggestion.
522 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
523 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
524 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]525 &quot;querySuggestion&quot;: { # This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion. # This field will be present if the suggested query is a word/phrase completion.
526 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]527 },
528 ],
529 }</pre>
530</div>
531
532</body></html>