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>

yoshi-code-bot

2021-06-29 00:20:25 -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 [Google Workspace 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

3e17f89

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

3e17f89

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

[diff] [blame]

97

98

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame^]

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 Google Workspace 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 [Google Workspace 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.

yoshi-code-bot

3dd1527

2021-04-21 15:07:48 -0700

[diff] [blame]

106

"contextAttributes": [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.

107

{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.

108

"name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.

109

"values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

114

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

115

{ # Restriction on Datasource.

116

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

117

{ # Filter options to be applied on query.

118

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

119

"compositeFilter": {

120

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

121

"subFilters": [ # Sub filters.

122

# Object with schema name: Filter

],

},

"valueFilter": {

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

127

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

128

"booleanValue": True or False,

129

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

130

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

131

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

132

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

133

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

134

"doubleValue": 3.14,

135

"integerValue": "A String",

136

"stringValue": "A String",

137

"timestampValue": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

138

},

Bu Sun Kim

d059ad8

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

[diff] [blame]

139

},

140

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

141

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

142

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

143

],

144

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

145

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

146

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

147

},

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

148

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

149

],

150

"facetOptions": [

151

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

152

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

153

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

154

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

155

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

156

},

157

],

158

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

159

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

160

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

161

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

162

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

163

},

164

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

165

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

166

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

167

},

168

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

169

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

170

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

171

},

172

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

173

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

174

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

175

},

176

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

177

}

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

178

179

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

186

187

{ # The search API response.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

188

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

189

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

190

},

191

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

192

"errorMessages": [

193

{ # Error message per source response.

194

"errorMessage": "A String",

195

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

196

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

197

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

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

198

},

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

199

},

200

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

201

},

202

"facetResults": [ # Repeated facet results.

203

{ # Source specific facet response

204

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

205

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame^]

206

"count": 42, # Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

207

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

208

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

209

"booleanValue": True or False,

210

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

211

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

212

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

213

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

214

},

215

"doubleValue": 3.14,

216

"integerValue": "A String",

217

"stringValue": "A String",

218

"timestampValue": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

219

},

220

},

221

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

222

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

223

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

224

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

225

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

226

],

227

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

228

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

229

"interpretationType": "A String",

230

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

231

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

232

},

233

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

234

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

235

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

236

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

237

{ # Per source result count information.

238

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

239

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

240

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

241

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

242

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

243

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

},

},

],

},

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

249

{ # Results containing indexed information for a document.

250

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

251

# Object with schema name: SearchResult

252

],

253

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

254

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

255

},

256

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

257

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

258

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

259

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

260

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

261

"fields": [

262

{ # Display Fields for Search Results

263

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

264

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

265

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

266

"booleanValue": True or False,

267

"dateValues": { # List of date values.

268

"values": [

269

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

270

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

271

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

272

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

},

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"enumValues": { # List of enum values.

282

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

"A String",

],

},

"htmlValues": { # List of html values.

287

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

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

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

297

"objectValues": { # List of object values.

298

"values": [

299

# Object with schema name: StructuredDataObject

300

],

301

},

302

"textValues": { # List of text values.

303

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

"A String",

],

},

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

},

},

],

},

],

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

318

},

319

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

320

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

321

"booleanValue": True or False,

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.

325

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

326

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

327

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

},

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"enumValues": { # List of enum values.

337

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

"A String",

],

},

"htmlValues": { # List of html values.

342

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

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

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

352

"objectValues": { # List of object values.

353

"values": [

354

# Object with schema name: StructuredDataObject

355

],

356

},

357

"textValues": { # List of text values.

358

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

"A String",

],

},

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

},

],

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

370

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

371

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

372

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

373

{ # A person's email address.

374

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

375

},

376

],

377

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

378

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

379

"personNames": [ # The person's name

380

{ # A person's name.

381

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

382

},

383

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

384

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

385

{ # A person's photo.

386

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

387

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

388

],

389

},

390

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

391

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

392

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

393

},

394

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

395

},

396

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

397

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

398

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

399

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

400

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

401

},

402

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

403

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

404

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

405

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

406

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

407

},

408

],

409

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

410

{

411

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

412

},

413

],

414

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

415

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

416

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

417

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

418

{ # A person's email address.

419

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

420

},

421

],

422

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

423

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

424

"personNames": [ # The person's name

425

{ # A person's name.

426

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

427

},

428

],

429

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

430

{ # A person's photo.

431

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

},

],

},

},

],

}</pre>

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

</div>

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame^]

442

<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 [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

443

444

Args:

445

body: object, The request body.

446

The object takes the form of:

447

448

{ # Request of suggest API.

yoshi-code-bot

6970659

2021-03-03 03:54:02 -0800

[diff] [blame]

449

"dataSourceRestrictions": [ # The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

450

{ # Restriction on Datasource.

451

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

452

{ # Filter options to be applied on query.

453

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

454

"compositeFilter": {

455

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

456

"subFilters": [ # Sub filters.

457

# Object with schema name: Filter

],

},

"valueFilter": {

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

462

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

463

"booleanValue": True or False,

464

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

465

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

466

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

467

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

468

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

469

"doubleValue": 3.14,

470

"integerValue": "A String",

471

"stringValue": "A String",

472

"timestampValue": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

473

},

Bu Sun Kim

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

[diff] [blame]

474

},

Bu Sun Kim

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

[diff] [blame]

475

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

476

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

477

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

478

],

479

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

480

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

481

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

Bu Sun Kim

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

[diff] [blame]

482

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

483

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

484

],

485

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

486

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

487

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

488

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

489

},

490

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

491

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

492

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

493

},

494

}

Bu Sun Kim

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

[diff] [blame]

495

496

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

503

504

{ # Response of the suggest API.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

505

"suggestResults": [ # List of suggestions.

506

{ # One suggestion result.

507

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

508

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

509

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

510

{ # A person's email address.

511

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

512

},

513

],

514

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

515

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

516

"personNames": [ # The person's name

517

{ # A person's name.

518

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

519

},

520

],

521

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

522

{ # A person's photo.

523

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

524

},

525

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

526

},

Bu Sun Kim

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

[diff] [blame]

527

},

Yoshi Automation Bot