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