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