1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a> . <a href="cloudsearch_v1.settings.searchapplications.html">searchapplications</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a search application.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a search application.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the specified search application.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists all search applications.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#reset">reset(name, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Resets a search application to default settings. This will return an empty</p> 95<p class="toc_element"> 96 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a search application.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="create">create(body, x__xgafv=None)</code> 101 <pre>Creates a search application. 102 103Args: 104 body: object, The request body. (required) 105 The object takes the form of: 106 107{ # SearchApplication 108 "dataSourceRestrictions": [ # Retrictions applied to the configurations. 109 # The maximum number of elements is 10. 110 { # Restriction on Datasource. 111 "filterOptions": [ # Filter options restricting the results. If multiple filters 112 # are present, they are grouped by object type before joining. 113 # Filters with the same object type are joined conjunctively, then 114 # the resulting expressions are joined disjunctively. 115 # 116 # The maximum number of elements is 20. 117 # 118 # NOTE: Suggest API supports only few filters at the moment: 119 # "objecttype", "type" and "mimetype". 120 # For now, schema specific filters cannot be used to filter suggestions. 121 { # Filter options to be applied on query. 122 "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`. 123 # approaches: <br/><br/> 124 # **1. Setting a ValueFilter.** The name must match an operator_name defined in 125 # the schema for your data source. 126 # <br/> 127 # **2. Setting a CompositeFilter.** The filters are evaluated 128 # using the logical operator. The top-level operators can only be either an AND 129 # or a NOT. AND can appear only at the top-most level. OR can appear only under 130 # a top-level AND. 131 "compositeFilter": { 132 "subFilters": [ # Sub filters. 133 # Object with schema name: Filter 134 ], 135 "logicOperator": "A String", # The logic operator of the sub filter. 136 }, 137 "valueFilter": { 138 "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. 139 # The filter can work against both types of filters defined in the schema 140 # for your data source: 141 # <br/><br/> 142 # 1. `operator_name`, where the query filters results by the property 143 # that matches the value. 144 # <br/> 145 # 2. `greater_than_operator_name` or `less_than_operator_name` in your 146 # schema. The query filters the results for the property values that are 147 # greater than or less than the supplied value in the query. 148 "value": { # Definition of a single value with generic type. # The value to be compared with. 149 "timestampValue": "A String", 150 "doubleValue": 3.14, 151 "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. 152 "month": 42, # Month of date. Must be from 1 to 12. 153 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month. 154 "year": 42, # Year of date. Must be from 1 to 9999. 155 }, 156 "stringValue": "A String", 157 "booleanValue": True or False, 158 "integerValue": "A String", 159 }, 160 }, 161 }, 162 "objectType": "A String", # If object_type is set, only objects of that type are returned. This should 163 # correspond to the name of the object that was registered within the 164 # definition of schema. The maximum length is 256 characters. 165 }, 166 ], 167 "source": { # Defines sources for the suggest/search APIs. # The source of restriction. 168 "predefinedSource": "A String", # Predefined content source for Google Apps. 169 "name": "A String", # Source name for content indexed by the 170 # Indexing API. 171 }, 172 }, 173 ], 174 "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this 175 # schema. Output only field. 176 "A String", 177 ], 178 "displayName": "A String", # Display name of the Search Application. 179 # The maximum length is 300 characters. 180 "name": "A String", # Name of the Search Application. 181 # <br />Format: searchapplications/{application_id}. 182 "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions. 183 { # Configurations for a source while processing a 184 # Search or 185 # Suggest request. 186 "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source. 187 # for a source. 188 "sourceImportance": "A String", # Importance of the source. 189 }, 190 "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source. 191 # multiple results from the same source or host "crowd out" other results, 192 # diminishing the quality of search for users. To foster better search quality 193 # and source diversity in search results, you can set a condition to reduce 194 # repetitive results by source. 195 "numResults": 42, # Maximum number of results allowed from a source. 196 # No limits will be set on results if this value is less than or equal to 0. 197 "field": "A String", # Use a field to control results crowding. For example, if you want to 198 # control overly similar results from Gmail topics, use `thread_id`. 199 # For similar pages from Google Sites, you can use `webspace_id`. 200 # When matching query results contain the same field value in 201 # `GenericMetadata`, crowding limits are set on those records. 202 "numSuggestions": 42, # Maximum number of suggestions allowed from a source. 203 # No limits will be set on results if this value is less than or equal to 0. 204 "source": True or False, # Control results by content source. This option limits the total number 205 # of results from a given source and ignores field-based crowding control. 206 }, 207 "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used. 208 "predefinedSource": "A String", # Predefined content source for Google Apps. 209 "name": "A String", # Source name for content indexed by the 210 # Indexing API. 211 }, 212 }, 213 ], 214 "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results. 215 # Search or 216 # Suggest request. 217 "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used 218 # as a ranking signal. Note that this setting is not available in the Admin 219 # UI. 220 "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will 221 # be used to boost results. 222 }, 223 "defaultSortOptions": { # The default options for sorting the search results 224 "operatorName": "A String", # Name of the operator corresponding to the field to sort on. 225 # The corresponding property must be marked as 226 # sortable. 227 "sortOrder": "A String", # Ascending is the default sort order 228 }, 229 "defaultFacetOptions": [ # The default fields for returning facet results. 230 # The sources specified here also have been included in 231 # data_source_restrictions 232 # above. 233 { # Specifies operators to return facet results for. There will be one 234 # FacetResult for every source_name/object_type/operator_name combination. 235 "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} 236 # If empty, all data sources will be used. 237 "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. 238 # Defaults to 10. 239 # Maximum value is 100. 240 "operatorName": "A String", # Name of the operator chosen for faceting. @see 241 # cloudsearch.SchemaPropertyOptions 242 "objectType": "A String", # If object_type is set, only those objects of that type will be used to 243 # compute facets. If empty, then all objects will be used to compute facets. 244 }, 245 ], 246} 247 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # This resource represents a long-running operation that is the result of a 257 # network API call. 258 "metadata": { # Service-specific metadata associated with the operation. It typically 259 # contains progress information and common metadata such as create time. 260 # Some services might not provide such metadata. Any method that returns a 261 # long-running operation should document the metadata type, if any. 262 "a_key": "", # Properties of the object. Contains field @type with type URL. 263 }, 264 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 265 # different programming environments, including REST APIs and RPC APIs. It is 266 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 267 # three pieces of data: error code, error message, and error details. 268 # 269 # You can find out more about this error model and how to work with it in the 270 # [API Design Guide](https://cloud.google.com/apis/design/errors). 271 "message": "A String", # A developer-facing error message, which should be in English. Any 272 # user-facing error message should be localized and sent in the 273 # google.rpc.Status.details field, or localized by the client. 274 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 275 "details": [ # A list of messages that carry the error details. There is a common set of 276 # message types for APIs to use. 277 { 278 "a_key": "", # Properties of the object. Contains field @type with type URL. 279 }, 280 ], 281 }, 282 "done": True or False, # If the value is `false`, it means the operation is still in progress. 283 # If `true`, the operation is completed, and either `error` or `response` is 284 # available. 285 "response": { # The normal response of the operation in case of success. If the original 286 # method returns no data on success, such as `Delete`, the response is 287 # `google.protobuf.Empty`. If the original method is standard 288 # `Get`/`Create`/`Update`, the response should be the resource. For other 289 # methods, the response should have the type `XxxResponse`, where `Xxx` 290 # is the original method name. For example, if the original method name 291 # is `TakeSnapshot()`, the inferred response type is 292 # `TakeSnapshotResponse`. 293 "a_key": "", # Properties of the object. Contains field @type with type URL. 294 }, 295 "name": "A String", # The server-assigned name, which is only unique within the same service that 296 # originally returns it. If you use the default HTTP mapping, the 297 # `name` should be a resource name ending with `operations/{unique_id}`. 298 }</pre> 299</div> 300 301<div class="method"> 302 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code> 303 <pre>Deletes a search application. 304 305Args: 306 name: string, The name of the search application to be deleted. 307<br />Format: applications/{application_id}. (required) 308 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. 309Otherwise, ignore this field. 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { # This resource represents a long-running operation that is the result of a 319 # network API call. 320 "metadata": { # Service-specific metadata associated with the operation. It typically 321 # contains progress information and common metadata such as create time. 322 # Some services might not provide such metadata. Any method that returns a 323 # long-running operation should document the metadata type, if any. 324 "a_key": "", # Properties of the object. Contains field @type with type URL. 325 }, 326 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 327 # different programming environments, including REST APIs and RPC APIs. It is 328 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 329 # three pieces of data: error code, error message, and error details. 330 # 331 # You can find out more about this error model and how to work with it in the 332 # [API Design Guide](https://cloud.google.com/apis/design/errors). 333 "message": "A String", # A developer-facing error message, which should be in English. Any 334 # user-facing error message should be localized and sent in the 335 # google.rpc.Status.details field, or localized by the client. 336 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 337 "details": [ # A list of messages that carry the error details. There is a common set of 338 # message types for APIs to use. 339 { 340 "a_key": "", # Properties of the object. Contains field @type with type URL. 341 }, 342 ], 343 }, 344 "done": True or False, # If the value is `false`, it means the operation is still in progress. 345 # If `true`, the operation is completed, and either `error` or `response` is 346 # available. 347 "response": { # The normal response of the operation in case of success. If the original 348 # method returns no data on success, such as `Delete`, the response is 349 # `google.protobuf.Empty`. If the original method is standard 350 # `Get`/`Create`/`Update`, the response should be the resource. For other 351 # methods, the response should have the type `XxxResponse`, where `Xxx` 352 # is the original method name. For example, if the original method name 353 # is `TakeSnapshot()`, the inferred response type is 354 # `TakeSnapshotResponse`. 355 "a_key": "", # Properties of the object. Contains field @type with type URL. 356 }, 357 "name": "A String", # The server-assigned name, which is only unique within the same service that 358 # originally returns it. If you use the default HTTP mapping, the 359 # `name` should be a resource name ending with `operations/{unique_id}`. 360 }</pre> 361</div> 362 363<div class="method"> 364 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code> 365 <pre>Gets the specified search application. 366 367Args: 368 name: string, Name of the search application. 369<br />Format: applications/{application_id}. (required) 370 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. 371Otherwise, ignore this field. 372 x__xgafv: string, V1 error format. 373 Allowed values 374 1 - v1 error format 375 2 - v2 error format 376 377Returns: 378 An object of the form: 379 380 { # SearchApplication 381 "dataSourceRestrictions": [ # Retrictions applied to the configurations. 382 # The maximum number of elements is 10. 383 { # Restriction on Datasource. 384 "filterOptions": [ # Filter options restricting the results. If multiple filters 385 # are present, they are grouped by object type before joining. 386 # Filters with the same object type are joined conjunctively, then 387 # the resulting expressions are joined disjunctively. 388 # 389 # The maximum number of elements is 20. 390 # 391 # NOTE: Suggest API supports only few filters at the moment: 392 # "objecttype", "type" and "mimetype". 393 # For now, schema specific filters cannot be used to filter suggestions. 394 { # Filter options to be applied on query. 395 "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`. 396 # approaches: <br/><br/> 397 # **1. Setting a ValueFilter.** The name must match an operator_name defined in 398 # the schema for your data source. 399 # <br/> 400 # **2. Setting a CompositeFilter.** The filters are evaluated 401 # using the logical operator. The top-level operators can only be either an AND 402 # or a NOT. AND can appear only at the top-most level. OR can appear only under 403 # a top-level AND. 404 "compositeFilter": { 405 "subFilters": [ # Sub filters. 406 # Object with schema name: Filter 407 ], 408 "logicOperator": "A String", # The logic operator of the sub filter. 409 }, 410 "valueFilter": { 411 "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. 412 # The filter can work against both types of filters defined in the schema 413 # for your data source: 414 # <br/><br/> 415 # 1. `operator_name`, where the query filters results by the property 416 # that matches the value. 417 # <br/> 418 # 2. `greater_than_operator_name` or `less_than_operator_name` in your 419 # schema. The query filters the results for the property values that are 420 # greater than or less than the supplied value in the query. 421 "value": { # Definition of a single value with generic type. # The value to be compared with. 422 "timestampValue": "A String", 423 "doubleValue": 3.14, 424 "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. 425 "month": 42, # Month of date. Must be from 1 to 12. 426 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month. 427 "year": 42, # Year of date. Must be from 1 to 9999. 428 }, 429 "stringValue": "A String", 430 "booleanValue": True or False, 431 "integerValue": "A String", 432 }, 433 }, 434 }, 435 "objectType": "A String", # If object_type is set, only objects of that type are returned. This should 436 # correspond to the name of the object that was registered within the 437 # definition of schema. The maximum length is 256 characters. 438 }, 439 ], 440 "source": { # Defines sources for the suggest/search APIs. # The source of restriction. 441 "predefinedSource": "A String", # Predefined content source for Google Apps. 442 "name": "A String", # Source name for content indexed by the 443 # Indexing API. 444 }, 445 }, 446 ], 447 "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this 448 # schema. Output only field. 449 "A String", 450 ], 451 "displayName": "A String", # Display name of the Search Application. 452 # The maximum length is 300 characters. 453 "name": "A String", # Name of the Search Application. 454 # <br />Format: searchapplications/{application_id}. 455 "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions. 456 { # Configurations for a source while processing a 457 # Search or 458 # Suggest request. 459 "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source. 460 # for a source. 461 "sourceImportance": "A String", # Importance of the source. 462 }, 463 "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source. 464 # multiple results from the same source or host "crowd out" other results, 465 # diminishing the quality of search for users. To foster better search quality 466 # and source diversity in search results, you can set a condition to reduce 467 # repetitive results by source. 468 "numResults": 42, # Maximum number of results allowed from a source. 469 # No limits will be set on results if this value is less than or equal to 0. 470 "field": "A String", # Use a field to control results crowding. For example, if you want to 471 # control overly similar results from Gmail topics, use `thread_id`. 472 # For similar pages from Google Sites, you can use `webspace_id`. 473 # When matching query results contain the same field value in 474 # `GenericMetadata`, crowding limits are set on those records. 475 "numSuggestions": 42, # Maximum number of suggestions allowed from a source. 476 # No limits will be set on results if this value is less than or equal to 0. 477 "source": True or False, # Control results by content source. This option limits the total number 478 # of results from a given source and ignores field-based crowding control. 479 }, 480 "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used. 481 "predefinedSource": "A String", # Predefined content source for Google Apps. 482 "name": "A String", # Source name for content indexed by the 483 # Indexing API. 484 }, 485 }, 486 ], 487 "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results. 488 # Search or 489 # Suggest request. 490 "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used 491 # as a ranking signal. Note that this setting is not available in the Admin 492 # UI. 493 "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will 494 # be used to boost results. 495 }, 496 "defaultSortOptions": { # The default options for sorting the search results 497 "operatorName": "A String", # Name of the operator corresponding to the field to sort on. 498 # The corresponding property must be marked as 499 # sortable. 500 "sortOrder": "A String", # Ascending is the default sort order 501 }, 502 "defaultFacetOptions": [ # The default fields for returning facet results. 503 # The sources specified here also have been included in 504 # data_source_restrictions 505 # above. 506 { # Specifies operators to return facet results for. There will be one 507 # FacetResult for every source_name/object_type/operator_name combination. 508 "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} 509 # If empty, all data sources will be used. 510 "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. 511 # Defaults to 10. 512 # Maximum value is 100. 513 "operatorName": "A String", # Name of the operator chosen for faceting. @see 514 # cloudsearch.SchemaPropertyOptions 515 "objectType": "A String", # If object_type is set, only those objects of that type will be used to 516 # compute facets. If empty, then all objects will be used to compute facets. 517 }, 518 ], 519 }</pre> 520</div> 521 522<div class="method"> 523 <code class="details" id="list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code> 524 <pre>Lists all search applications. 525 526Args: 527 pageSize: integer, The maximum number of items to return. 528 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. 529Otherwise, ignore this field. 530 pageToken: string, The next_page_token value returned from a previous List request, if any. 531<br/> The default value is 10 532 x__xgafv: string, V1 error format. 533 Allowed values 534 1 - v1 error format 535 2 - v2 error format 536 537Returns: 538 An object of the form: 539 540 { 541 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no 542 # more results in the list. 543 "searchApplications": [ 544 { # SearchApplication 545 "dataSourceRestrictions": [ # Retrictions applied to the configurations. 546 # The maximum number of elements is 10. 547 { # Restriction on Datasource. 548 "filterOptions": [ # Filter options restricting the results. If multiple filters 549 # are present, they are grouped by object type before joining. 550 # Filters with the same object type are joined conjunctively, then 551 # the resulting expressions are joined disjunctively. 552 # 553 # The maximum number of elements is 20. 554 # 555 # NOTE: Suggest API supports only few filters at the moment: 556 # "objecttype", "type" and "mimetype". 557 # For now, schema specific filters cannot be used to filter suggestions. 558 { # Filter options to be applied on query. 559 "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`. 560 # approaches: <br/><br/> 561 # **1. Setting a ValueFilter.** The name must match an operator_name defined in 562 # the schema for your data source. 563 # <br/> 564 # **2. Setting a CompositeFilter.** The filters are evaluated 565 # using the logical operator. The top-level operators can only be either an AND 566 # or a NOT. AND can appear only at the top-most level. OR can appear only under 567 # a top-level AND. 568 "compositeFilter": { 569 "subFilters": [ # Sub filters. 570 # Object with schema name: Filter 571 ], 572 "logicOperator": "A String", # The logic operator of the sub filter. 573 }, 574 "valueFilter": { 575 "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. 576 # The filter can work against both types of filters defined in the schema 577 # for your data source: 578 # <br/><br/> 579 # 1. `operator_name`, where the query filters results by the property 580 # that matches the value. 581 # <br/> 582 # 2. `greater_than_operator_name` or `less_than_operator_name` in your 583 # schema. The query filters the results for the property values that are 584 # greater than or less than the supplied value in the query. 585 "value": { # Definition of a single value with generic type. # The value to be compared with. 586 "timestampValue": "A String", 587 "doubleValue": 3.14, 588 "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. 589 "month": 42, # Month of date. Must be from 1 to 12. 590 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month. 591 "year": 42, # Year of date. Must be from 1 to 9999. 592 }, 593 "stringValue": "A String", 594 "booleanValue": True or False, 595 "integerValue": "A String", 596 }, 597 }, 598 }, 599 "objectType": "A String", # If object_type is set, only objects of that type are returned. This should 600 # correspond to the name of the object that was registered within the 601 # definition of schema. The maximum length is 256 characters. 602 }, 603 ], 604 "source": { # Defines sources for the suggest/search APIs. # The source of restriction. 605 "predefinedSource": "A String", # Predefined content source for Google Apps. 606 "name": "A String", # Source name for content indexed by the 607 # Indexing API. 608 }, 609 }, 610 ], 611 "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this 612 # schema. Output only field. 613 "A String", 614 ], 615 "displayName": "A String", # Display name of the Search Application. 616 # The maximum length is 300 characters. 617 "name": "A String", # Name of the Search Application. 618 # <br />Format: searchapplications/{application_id}. 619 "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions. 620 { # Configurations for a source while processing a 621 # Search or 622 # Suggest request. 623 "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source. 624 # for a source. 625 "sourceImportance": "A String", # Importance of the source. 626 }, 627 "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source. 628 # multiple results from the same source or host "crowd out" other results, 629 # diminishing the quality of search for users. To foster better search quality 630 # and source diversity in search results, you can set a condition to reduce 631 # repetitive results by source. 632 "numResults": 42, # Maximum number of results allowed from a source. 633 # No limits will be set on results if this value is less than or equal to 0. 634 "field": "A String", # Use a field to control results crowding. For example, if you want to 635 # control overly similar results from Gmail topics, use `thread_id`. 636 # For similar pages from Google Sites, you can use `webspace_id`. 637 # When matching query results contain the same field value in 638 # `GenericMetadata`, crowding limits are set on those records. 639 "numSuggestions": 42, # Maximum number of suggestions allowed from a source. 640 # No limits will be set on results if this value is less than or equal to 0. 641 "source": True or False, # Control results by content source. This option limits the total number 642 # of results from a given source and ignores field-based crowding control. 643 }, 644 "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used. 645 "predefinedSource": "A String", # Predefined content source for Google Apps. 646 "name": "A String", # Source name for content indexed by the 647 # Indexing API. 648 }, 649 }, 650 ], 651 "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results. 652 # Search or 653 # Suggest request. 654 "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used 655 # as a ranking signal. Note that this setting is not available in the Admin 656 # UI. 657 "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will 658 # be used to boost results. 659 }, 660 "defaultSortOptions": { # The default options for sorting the search results 661 "operatorName": "A String", # Name of the operator corresponding to the field to sort on. 662 # The corresponding property must be marked as 663 # sortable. 664 "sortOrder": "A String", # Ascending is the default sort order 665 }, 666 "defaultFacetOptions": [ # The default fields for returning facet results. 667 # The sources specified here also have been included in 668 # data_source_restrictions 669 # above. 670 { # Specifies operators to return facet results for. There will be one 671 # FacetResult for every source_name/object_type/operator_name combination. 672 "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} 673 # If empty, all data sources will be used. 674 "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. 675 # Defaults to 10. 676 # Maximum value is 100. 677 "operatorName": "A String", # Name of the operator chosen for faceting. @see 678 # cloudsearch.SchemaPropertyOptions 679 "objectType": "A String", # If object_type is set, only those objects of that type will be used to 680 # compute facets. If empty, then all objects will be used to compute facets. 681 }, 682 ], 683 }, 684 ], 685 }</pre> 686</div> 687 688<div class="method"> 689 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 690 <pre>Retrieves the next page of results. 691 692Args: 693 previous_request: The request for the previous page. (required) 694 previous_response: The response from the request for the previous page. (required) 695 696Returns: 697 A request object that you can call 'execute()' on to request the next 698 page. Returns None if there are no more items in the collection. 699 </pre> 700</div> 701 702<div class="method"> 703 <code class="details" id="reset">reset(name, body, x__xgafv=None)</code> 704 <pre>Resets a search application to default settings. This will return an empty 705response. 706 707Args: 708 name: string, The name of the search application to be reset. 709<br />Format: applications/{application_id}. (required) 710 body: object, The request body. (required) 711 The object takes the form of: 712 713{ 714 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options. 715 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. 716 # Otherwise, ignore this field. 717 }, 718 } 719 720 x__xgafv: string, V1 error format. 721 Allowed values 722 1 - v1 error format 723 2 - v2 error format 724 725Returns: 726 An object of the form: 727 728 { # This resource represents a long-running operation that is the result of a 729 # network API call. 730 "metadata": { # Service-specific metadata associated with the operation. It typically 731 # contains progress information and common metadata such as create time. 732 # Some services might not provide such metadata. Any method that returns a 733 # long-running operation should document the metadata type, if any. 734 "a_key": "", # Properties of the object. Contains field @type with type URL. 735 }, 736 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 737 # different programming environments, including REST APIs and RPC APIs. It is 738 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 739 # three pieces of data: error code, error message, and error details. 740 # 741 # You can find out more about this error model and how to work with it in the 742 # [API Design Guide](https://cloud.google.com/apis/design/errors). 743 "message": "A String", # A developer-facing error message, which should be in English. Any 744 # user-facing error message should be localized and sent in the 745 # google.rpc.Status.details field, or localized by the client. 746 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 747 "details": [ # A list of messages that carry the error details. There is a common set of 748 # message types for APIs to use. 749 { 750 "a_key": "", # Properties of the object. Contains field @type with type URL. 751 }, 752 ], 753 }, 754 "done": True or False, # If the value is `false`, it means the operation is still in progress. 755 # If `true`, the operation is completed, and either `error` or `response` is 756 # available. 757 "response": { # The normal response of the operation in case of success. If the original 758 # method returns no data on success, such as `Delete`, the response is 759 # `google.protobuf.Empty`. If the original method is standard 760 # `Get`/`Create`/`Update`, the response should be the resource. For other 761 # methods, the response should have the type `XxxResponse`, where `Xxx` 762 # is the original method name. For example, if the original method name 763 # is `TakeSnapshot()`, the inferred response type is 764 # `TakeSnapshotResponse`. 765 "a_key": "", # Properties of the object. Contains field @type with type URL. 766 }, 767 "name": "A String", # The server-assigned name, which is only unique within the same service that 768 # originally returns it. If you use the default HTTP mapping, the 769 # `name` should be a resource name ending with `operations/{unique_id}`. 770 }</pre> 771</div> 772 773<div class="method"> 774 <code class="details" id="update">update(name, body, x__xgafv=None)</code> 775 <pre>Updates a search application. 776 777Args: 778 name: string, Name of the Search Application. 779<br />Format: searchapplications/{application_id}. (required) 780 body: object, The request body. (required) 781 The object takes the form of: 782 783{ # SearchApplication 784 "dataSourceRestrictions": [ # Retrictions applied to the configurations. 785 # The maximum number of elements is 10. 786 { # Restriction on Datasource. 787 "filterOptions": [ # Filter options restricting the results. If multiple filters 788 # are present, they are grouped by object type before joining. 789 # Filters with the same object type are joined conjunctively, then 790 # the resulting expressions are joined disjunctively. 791 # 792 # The maximum number of elements is 20. 793 # 794 # NOTE: Suggest API supports only few filters at the moment: 795 # "objecttype", "type" and "mimetype". 796 # For now, schema specific filters cannot be used to filter suggestions. 797 { # Filter options to be applied on query. 798 "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`. 799 # approaches: <br/><br/> 800 # **1. Setting a ValueFilter.** The name must match an operator_name defined in 801 # the schema for your data source. 802 # <br/> 803 # **2. Setting a CompositeFilter.** The filters are evaluated 804 # using the logical operator. The top-level operators can only be either an AND 805 # or a NOT. AND can appear only at the top-most level. OR can appear only under 806 # a top-level AND. 807 "compositeFilter": { 808 "subFilters": [ # Sub filters. 809 # Object with schema name: Filter 810 ], 811 "logicOperator": "A String", # The logic operator of the sub filter. 812 }, 813 "valueFilter": { 814 "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. 815 # The filter can work against both types of filters defined in the schema 816 # for your data source: 817 # <br/><br/> 818 # 1. `operator_name`, where the query filters results by the property 819 # that matches the value. 820 # <br/> 821 # 2. `greater_than_operator_name` or `less_than_operator_name` in your 822 # schema. The query filters the results for the property values that are 823 # greater than or less than the supplied value in the query. 824 "value": { # Definition of a single value with generic type. # The value to be compared with. 825 "timestampValue": "A String", 826 "doubleValue": 3.14, 827 "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. 828 "month": 42, # Month of date. Must be from 1 to 12. 829 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month. 830 "year": 42, # Year of date. Must be from 1 to 9999. 831 }, 832 "stringValue": "A String", 833 "booleanValue": True or False, 834 "integerValue": "A String", 835 }, 836 }, 837 }, 838 "objectType": "A String", # If object_type is set, only objects of that type are returned. This should 839 # correspond to the name of the object that was registered within the 840 # definition of schema. The maximum length is 256 characters. 841 }, 842 ], 843 "source": { # Defines sources for the suggest/search APIs. # The source of restriction. 844 "predefinedSource": "A String", # Predefined content source for Google Apps. 845 "name": "A String", # Source name for content indexed by the 846 # Indexing API. 847 }, 848 }, 849 ], 850 "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this 851 # schema. Output only field. 852 "A String", 853 ], 854 "displayName": "A String", # Display name of the Search Application. 855 # The maximum length is 300 characters. 856 "name": "A String", # Name of the Search Application. 857 # <br />Format: searchapplications/{application_id}. 858 "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions. 859 { # Configurations for a source while processing a 860 # Search or 861 # Suggest request. 862 "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source. 863 # for a source. 864 "sourceImportance": "A String", # Importance of the source. 865 }, 866 "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source. 867 # multiple results from the same source or host "crowd out" other results, 868 # diminishing the quality of search for users. To foster better search quality 869 # and source diversity in search results, you can set a condition to reduce 870 # repetitive results by source. 871 "numResults": 42, # Maximum number of results allowed from a source. 872 # No limits will be set on results if this value is less than or equal to 0. 873 "field": "A String", # Use a field to control results crowding. For example, if you want to 874 # control overly similar results from Gmail topics, use `thread_id`. 875 # For similar pages from Google Sites, you can use `webspace_id`. 876 # When matching query results contain the same field value in 877 # `GenericMetadata`, crowding limits are set on those records. 878 "numSuggestions": 42, # Maximum number of suggestions allowed from a source. 879 # No limits will be set on results if this value is less than or equal to 0. 880 "source": True or False, # Control results by content source. This option limits the total number 881 # of results from a given source and ignores field-based crowding control. 882 }, 883 "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used. 884 "predefinedSource": "A String", # Predefined content source for Google Apps. 885 "name": "A String", # Source name for content indexed by the 886 # Indexing API. 887 }, 888 }, 889 ], 890 "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results. 891 # Search or 892 # Suggest request. 893 "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used 894 # as a ranking signal. Note that this setting is not available in the Admin 895 # UI. 896 "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will 897 # be used to boost results. 898 }, 899 "defaultSortOptions": { # The default options for sorting the search results 900 "operatorName": "A String", # Name of the operator corresponding to the field to sort on. 901 # The corresponding property must be marked as 902 # sortable. 903 "sortOrder": "A String", # Ascending is the default sort order 904 }, 905 "defaultFacetOptions": [ # The default fields for returning facet results. 906 # The sources specified here also have been included in 907 # data_source_restrictions 908 # above. 909 { # Specifies operators to return facet results for. There will be one 910 # FacetResult for every source_name/object_type/operator_name combination. 911 "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} 912 # If empty, all data sources will be used. 913 "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. 914 # Defaults to 10. 915 # Maximum value is 100. 916 "operatorName": "A String", # Name of the operator chosen for faceting. @see 917 # cloudsearch.SchemaPropertyOptions 918 "objectType": "A String", # If object_type is set, only those objects of that type will be used to 919 # compute facets. If empty, then all objects will be used to compute facets. 920 }, 921 ], 922} 923 924 x__xgafv: string, V1 error format. 925 Allowed values 926 1 - v1 error format 927 2 - v2 error format 928 929Returns: 930 An object of the form: 931 932 { # This resource represents a long-running operation that is the result of a 933 # network API call. 934 "metadata": { # Service-specific metadata associated with the operation. It typically 935 # contains progress information and common metadata such as create time. 936 # Some services might not provide such metadata. Any method that returns a 937 # long-running operation should document the metadata type, if any. 938 "a_key": "", # Properties of the object. Contains field @type with type URL. 939 }, 940 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 941 # different programming environments, including REST APIs and RPC APIs. It is 942 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 943 # three pieces of data: error code, error message, and error details. 944 # 945 # You can find out more about this error model and how to work with it in the 946 # [API Design Guide](https://cloud.google.com/apis/design/errors). 947 "message": "A String", # A developer-facing error message, which should be in English. Any 948 # user-facing error message should be localized and sent in the 949 # google.rpc.Status.details field, or localized by the client. 950 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 951 "details": [ # A list of messages that carry the error details. There is a common set of 952 # message types for APIs to use. 953 { 954 "a_key": "", # Properties of the object. Contains field @type with type URL. 955 }, 956 ], 957 }, 958 "done": True or False, # If the value is `false`, it means the operation is still in progress. 959 # If `true`, the operation is completed, and either `error` or `response` is 960 # available. 961 "response": { # The normal response of the operation in case of success. If the original 962 # method returns no data on success, such as `Delete`, the response is 963 # `google.protobuf.Empty`. If the original method is standard 964 # `Get`/`Create`/`Update`, the response should be the resource. For other 965 # methods, the response should have the type `XxxResponse`, where `Xxx` 966 # is the original method name. For example, if the original method name 967 # is `TakeSnapshot()`, the inferred response type is 968 # `TakeSnapshotResponse`. 969 "a_key": "", # Properties of the object. Contains field @type with type URL. 970 }, 971 "name": "A String", # The server-assigned name, which is only unique within the same service that 972 # originally returns it. If you use the default HTTP mapping, the 973 # `name` should be a resource name ending with `operations/{unique_id}`. 974 }</pre> 975</div> 976 977</body></html>