Blame - docs/dyn/cloudsearch_v1.query.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

88

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

89

<code><a href="#suggest">suggest(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<h3>Method Details</h3>

92

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

96

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

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'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'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

100

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

102

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

The object takes the form of:

104

105

{ # The search API request.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

106

"queryInterpretationOptions": { # Options to interpret user query. # Options to interpret the user query.

107

"disableNlInterpretation": 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.

108

"enableVerbatimMode": 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.

109

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

110

"pageSize": 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

111

"sortOptions": { # The options for sorting the search results

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

112

"sortOrder": "A String", # Ascending is the default sort order

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

113

"operatorName": "A String", # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

114

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

115

"requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.

116

"timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". 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.

117

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request

118

"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

119

},

120

"searchApplicationId": "A String", # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).

121

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". 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'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.

122

},

123

"facetOptions": [

124

{ # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.

125

"operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions

126

"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.

127

"objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.

128

"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.

129

},

130

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

131

"dataSourceRestrictions": [ # The sources to use for querying. If not specified, all data sources from the current search application are used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

132

{ # Restriction on Datasource.

133

"source": { # Defines sources for the suggest/search APIs. # The source of restriction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

134

"name": "A String", # Source name for content indexed by the Indexing API.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

135

"predefinedSource": "A String", # Predefined content source for Google Apps.

136

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

137

"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

138

{ # Filter options to be applied on query.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

139

"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

140

"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

141

"valueFilter": {

142

"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.

143

"value": { # Definition of a single value with generic type. # The value to be compared with.

144

"integerValue": "A String",

145

"timestampValue": "A String",

146

"doubleValue": 3.14,

147

"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.

148

"year": 42, # Year of date. Must be from 1 to 9999.

149

"month": 42, # Month of date. Must be from 1 to 12.

150

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

151

},

152

"booleanValue": True or False,

153

"stringValue": "A String",

154

},

155

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

156

"compositeFilter": {

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

157

"logicOperator": "A String", # The logic operator of the sub filter.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

158

"subFilters": [ # Sub filters.

159

# Object with schema name: Filter

160

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

161

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

},

},

],

},

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

167

"query": "A String", # The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://support.google.com/a/users/answer/9299929)

168

"start": 42, # Starting index of the results.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

169

}

170

171

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

178

179

{ # The search API response.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

180

"hasMoreResults": True or False, # Whether there are more search results matching the query.

181

"resultCountExact": "A String", # The exact result count for this query.

182

"queryInterpretation": { # Query interpretation result for user query. Empty if query interpretation is disabled.

183

"interpretedQuery": "A String", # The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.

184

"interpretationType": "A String",

185

"reason": "A String", # The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.

186

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

187

"resultCounts": { # Result count information # Expanded result count information.

188

"sourceResultCounts": [ # Result count information for each source with results.

189

{ # Per source result count information.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

190

"source": { # Defines sources for the suggest/search APIs. # The source the result count information is associated with.

191

"name": "A String", # Source name for content indexed by the Indexing API.

192

"predefinedSource": "A String", # Predefined content source for Google Apps.

193

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

194

"resultCountExact": "A String", # The exact result count for this source.

195

"resultCountEstimate": "A String", # The estimated result count for this source.

196

"hasMoreResults": True or False, # Whether there are more search results for this source.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

197

},

198

],

199

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

200

"debugInfo": { # Debugging information about the response. # Debugging information about the response.

201

"formattedDebugInfo": "A String", # General debug info formatted for display.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

202

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

203

"results": [ # Results from a search query.

204

{ # Results containing indexed information for a document.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

205

"clusteredResults": [ # 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.

206

# Object with schema name: SearchResult

207

],

208

"debugInfo": { # Debugging information about the result. # Debugging information about this search result.

209

"formattedDebugInfo": "A String", # General debug info formatted for display.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

210

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

211

"metadata": { # Metadata of a matched search result. # Metadata of the search result.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

212

"displayOptions": { # Options that specify how to display a structured data search result.

213

"metalines": [ # The metalines content to be displayed with the result.

214

{ # The collection of fields that make up a displayed line

215

"fields": [

216

{ # Display Fields for Search Results

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

217

"label": "A String", # The display label for the property.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

218

"property": { # 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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

219

"name": "A String", # 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.

220

"integerValues": { # List of integer values.

221

"values": [

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

222

"A String",

223

],

224

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

225

"textValues": { # List of text values.

226

"values": [ # The maximum allowable length for text values is 2048 characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

227

"A String",

228

],

229

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

230

"objectValues": { # List of object values.

231

"values": [

232

# Object with schema name: StructuredDataObject

233

],

234

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

235

"timestampValues": { # List of timestamp values.

236

"values": [

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

237

"A String",

238

],

239

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

240

"dateValues": { # List of date values.

241

"values": [

242

{ # 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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

243

"year": 42, # Year of date. Must be from 1 to 9999.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

244

"month": 42, # Month of date. Must be from 1 to 12.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

245

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

246

},

247

],

248

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

249

"doubleValues": { # List of double values.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

250

"values": [

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3.14,

],

},

"enumValues": { # List of enum values.

255

"values": [ # The maximum allowable length for string values is 32 characters.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

256

"A String",

257

],

258

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

259

"booleanValue": True or False,

260

"htmlValues": { # List of html values.

261

"values": [ # The maximum allowable length for html values is 2048 characters.

262

"A String",

263

],

264

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

265

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

266

"operatorName": "A String", # The operator name of the property.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

271

"objectTypeLabel": "A String", # The display label for the object.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

272

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

273

"mimeType": "A String", # Mime type of the search result.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

274

"objectType": "A String", # Object type of the search result.

275

"owner": { # Object to represent a person. # Owner (usually creator) of the document or object of the search result.

276

"obfuscatedId": "A String", # Obfuscated ID of a person.

277

"name": "A String", # The resource name of the person to provide information about. See People.get from Google People API.

278

"photos": [ # A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.

279

{ # A person's photo.

280

"url": "A String", # The URL of the photo.

281

},

282

],

283

"emailAddresses": [ # The person's email addresses

284

{ # A person's email address.

285

"emailAddress": "A String", # The email address.

286

},

287

],

288

"personNames": [ # The person's name

289

{ # A person's name.

290

"displayName": "A String", # The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

},

],

},

"source": { # Defines sources for the suggest/search APIs. # The named source for the result, such as Gmail.

295

"name": "A String", # Source name for content indexed by the Indexing API.

296

"predefinedSource": "A String", # Predefined content source for Google Apps.

297

},

298

"updateTime": "A String", # 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

299

"fields": [ # Indexed fields in structured data, returned as a generic named property.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

300

{ # 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 Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

301

"name": "A String", # 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.

302

"integerValues": { # List of integer values.

303

"values": [

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

304

"A String",

305

],

306

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

307

"textValues": { # List of text values.

308

"values": [ # The maximum allowable length for text values is 2048 characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

309

"A String",

310

],

311

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

312

"objectValues": { # List of object values.

313

"values": [

314

# Object with schema name: StructuredDataObject

315

],

316

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

317

"timestampValues": { # List of timestamp values.

318

"values": [

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

319

"A String",

320

],

321

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

322

"dateValues": { # List of date values.

323

"values": [

324

{ # 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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

325

"year": 42, # Year of date. Must be from 1 to 9999.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

326

"month": 42, # Month of date. Must be from 1 to 12.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

327

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

328

},

329

],

330

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

331

"doubleValues": { # List of double values.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

332

"values": [

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3.14,

],

},

"enumValues": { # List of enum values.

337

"values": [ # The maximum allowable length for string values is 32 characters.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

338

"A String",

339

],

340

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

341

"booleanValue": True or False,

342

"htmlValues": { # List of html values.

343

"values": [ # The maximum allowable length for html values is 2048 characters.

344

"A String",

345

],

346

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

347

},

348

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

349

"createTime": "A String", # The creation time for this document or object in the search result.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

350

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

351

"url": "A String", # The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

352

"snippet": { # Snippet of the search result, which summarizes the content of the resulting page. # The concatenation of all snippets (summaries) available for this result.

353

"matchRanges": [ # The matched ranges in the snippet.

354

{ # Matched range of a snippet [start, end).

355

"end": 42, # End of the match in the snippet.

356

"start": 42, # Starting position of the match in the snippet.

357

},

358

],

359

"snippet": "A String", # The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

360

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

361

"title": "A String", # Title of the search result.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

362

},

363

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

364

"errorInfo": { # Error information about the response. # Error information about the response.

365

"errorMessages": [

366

{ # Error message per source response.

367

"errorMessage": "A String",

368

"source": { # Defines sources for the suggest/search APIs.

369

"name": "A String", # Source name for content indexed by the Indexing API.

370

"predefinedSource": "A String", # Predefined content source for Google Apps.

},

},

],

},

"resultCountEstimate": "A String", # The estimated result count for this query.

376

"facetResults": [ # Repeated facet results.

377

{ # Source specific facet response

378

"buckets": [ # FacetBuckets for values in response containing at least a single result.

379

{ # 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.

380

"count": 42, # Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty.

381

"value": { # Definition of a single value with generic type.

382

"integerValue": "A String",

383

"timestampValue": "A String",

384

"doubleValue": 3.14,

385

"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.

386

"year": 42, # Year of date. Must be from 1 to 9999.

387

"month": 42, # Month of date. Must be from 1 to 12.

388

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

389

},

390

"booleanValue": True or False,

391

"stringValue": "A String",

392

},

393

"percentage": 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.

394

},

395

],

396

"operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions

397

"sourceName": "A String", # Source name for which facet results are returned. Will not be empty.

398

"objectType": "A String", # Object type for which facet results are returned. Can be empty.

399

},

400

],

401

"spellResults": [ # Suggested spelling for the query.

402

{

403

"suggestedQuery": "A String", # The suggested spelling of the query.

404

},

405

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

406

"structuredResults": [ # Structured results for the user query. These results are not counted against the page_size.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

407

{ # Structured results that are returned as part of search request.

408

"person": { # Object to represent a person. # Representation of a person

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

409

"obfuscatedId": "A String", # Obfuscated ID of a person.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

410

"name": "A String", # The resource name of the person to provide information about. See People.get from Google People API.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

411

"photos": [ # A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.

412

{ # A person's photo.

413

"url": "A String", # The URL of the photo.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

414

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

415

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

416

"emailAddresses": [ # The person's email addresses

417

{ # A person's email address.

418

"emailAddress": "A String", # The email address.

419

},

420

],

421

"personNames": [ # The person's name

422

{ # A person's name.

423

"displayName": "A String", # The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

424

},

425

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

426

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

427

},

428

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="suggest">suggest(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-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'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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

435

436

Args:

437

body: object, The request body.

438

The object takes the form of:

439

440

{ # Request of suggest API.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

441

"dataSourceRestrictions": [ # 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

442

{ # Restriction on Datasource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

443

"source": { # Defines sources for the suggest/search APIs. # The source of restriction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

444

"name": "A String", # Source name for content indexed by the Indexing API.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

445

"predefinedSource": "A String", # Predefined content source for Google Apps.

446

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

447

"filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

448

{ # Filter options to be applied on query.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

449

"objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

450

"filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

451

"valueFilter": {

452

"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.

453

"value": { # Definition of a single value with generic type. # The value to be compared with.

454

"integerValue": "A String",

455

"timestampValue": "A String",

456

"doubleValue": 3.14,

457

"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.

458

"year": 42, # Year of date. Must be from 1 to 9999.

459

"month": 42, # Month of date. Must be from 1 to 12.

460

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

461

},

462

"booleanValue": True or False,

463

"stringValue": "A String",

464

},

465

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

466

"compositeFilter": {

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

467

"logicOperator": "A String", # The logic operator of the sub filter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

468

"subFilters": [ # Sub filters.

469

# Object with schema name: Filter

470

],

471

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

472

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

473

},

474

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

475

},

476

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

477

"query": "A String", # Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on.

478

"requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.

479

"timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". 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.

480

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request

481

"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

482

},

483

"searchApplicationId": "A String", # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).

484

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". 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'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.

485

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

486

}

487

488

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

495

496

{ # Response of the suggest API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

497

"suggestResults": [ # List of suggestions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

498

{ # One suggestion result.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

499

"source": { # Defines sources for the suggest/search APIs. # The source of the suggestion.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

500

"name": "A String", # Source name for content indexed by the Indexing API.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

501

"predefinedSource": "A String", # Predefined content source for Google Apps.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

503

"peopleSuggestion": { # 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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

504

"person": { # Object to represent a person. # Suggested person. All fields of the person object might not be populated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

505

"obfuscatedId": "A String", # Obfuscated ID of a person.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

506

"name": "A String", # The resource name of the person to provide information about. See People.get from Google People API.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

507

"photos": [ # A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.

508

{ # A person's photo.

509

"url": "A String", # The URL of the photo.

510

},

511

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

512

"emailAddresses": [ # The person's email addresses

513

{ # A person's email address.

514

"emailAddress": "A String", # The email address.

515

},

516

],

517

"personNames": [ # The person's name

518

{ # A person's name.

519

"displayName": "A String", # The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

520

},

521

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

522

},

523

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

524

"suggestedQuery": "A String", # The suggested query that will be used for search, when the user clicks on the suggestion

525

"querySuggestion": { # 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 Kim