OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/cloudsearch": { |
| 9 "description": "FOR TESTING ONLY" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/userinfo.email": { |
| 12 "description": "View your email address" |
| 13 } |
| 14 } |
| 15 } |
| 16 }, |
| 17 "basePath": "", |
| 18 "baseUrl": "https://cloudsearch.googleapis.com/", |
| 19 "batchPath": "batch", |
| 20 "description": "The Google Cloud Search API defines an application interface
to index documents that contain structured data and to search those indexes. It
supports full text search.", |
| 21 "discoveryVersion": "v1", |
| 22 "documentationLink": "", |
| 23 "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/nEzuRsBqgiDxr-ibn0WHLMhdIu8\"", |
| 24 "icons": { |
| 25 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 26 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 27 }, |
| 28 "id": "cloudsearch:v1", |
| 29 "kind": "discovery#restDescription", |
| 30 "name": "cloudsearch", |
| 31 "ownerDomain": "google.com", |
| 32 "ownerName": "Google", |
| 33 "parameters": { |
| 34 "access_token": { |
| 35 "description": "OAuth access token.", |
| 36 "location": "query", |
| 37 "type": "string" |
| 38 }, |
| 39 "alt": { |
| 40 "default": "json", |
| 41 "description": "Data format for response.", |
| 42 "enumDescriptions": [ |
| 43 "Responses with Content-Type of application/json", |
| 44 "Media download with context dependend Content-Type" |
| 45 ], |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "bearer_token": { |
| 50 "description": "OAuth bearer token.", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
| 54 "callback": { |
| 55 "description": "JSONP", |
| 56 "location": "query", |
| 57 "type": "string" |
| 58 }, |
| 59 "fields": { |
| 60 "description": "Selector specifying which fields to include in a par
tial response.", |
| 61 "location": "query", |
| 62 "type": "string" |
| 63 }, |
| 64 "key": { |
| 65 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 66 "location": "query", |
| 67 "type": "string" |
| 68 }, |
| 69 "oauth_token": { |
| 70 "description": "OAuth 2.0 token for the current user.", |
| 71 "location": "query", |
| 72 "type": "string" |
| 73 }, |
| 74 "pp": { |
| 75 "default": "true", |
| 76 "description": "Pretty-print response.", |
| 77 "location": "query", |
| 78 "type": "boolean" |
| 79 }, |
| 80 "prettyPrint": { |
| 81 "default": "true", |
| 82 "description": "Returns response with indentations and line breaks."
, |
| 83 "location": "query", |
| 84 "type": "boolean" |
| 85 }, |
| 86 "quotaUser": { |
| 87 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
| 91 "$.xgafv": { |
| 92 "description": "V1 error format.", |
| 93 "enumDescriptions": [ |
| 94 "v1 error format", |
| 95 "v2 error format" |
| 96 ], |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 } |
| 100 }, |
| 101 "protocol": "rest", |
| 102 "resources": { |
| 103 "projects": { |
| 104 "resources": { |
| 105 "indexes": { |
| 106 "methods": { |
| 107 "list": { |
| 108 "description": "Lists search indexes belonging to th
e specified project.", |
| 109 "httpMethod": "GET", |
| 110 "id": "cloudsearch.projects.indexes.list", |
| 111 "parameterOrder": [ |
| 112 "projectId", |
| 113 "indexNamePrefix", |
| 114 "pageSize", |
| 115 "pageToken", |
| 116 "view" |
| 117 ], |
| 118 "parameters": { |
| 119 "projectId": { |
| 120 "description": "The project from which to re
trieve indexes. It cannot be the empty string.", |
| 121 "location": "path", |
| 122 "required": true, |
| 123 "type": "string" |
| 124 }, |
| 125 "indexNamePrefix": { |
| 126 "description": "The prefix of the index name
. It is used to list all indexes with names that have this prefix.", |
| 127 "location": "query", |
| 128 "type": "string" |
| 129 }, |
| 130 "pageSize": { |
| 131 "description": "The maximum number of indexe
s to return per page. If not specified, 100 indexes are returned per page.", |
| 132 "format": "int32", |
| 133 "location": "query", |
| 134 "type": "integer" |
| 135 }, |
| 136 "pageToken": { |
| 137 "description": "A `nextPageToken` returned f
rom previous list indexes call as the starting point for this call. If not speci
fied, list indexes from the beginning.", |
| 138 "location": "query", |
| 139 "type": "string" |
| 140 }, |
| 141 "view": { |
| 142 "description": "Specifies which parts of the
IndexInfo resource is returned in the response. If not specified, `ID_ONLY` is
used.", |
| 143 "enum": [ |
| 144 "INDEX_VIEW_UNSPECIFIED", |
| 145 "ID_ONLY", |
| 146 "FULL" |
| 147 ], |
| 148 "location": "query", |
| 149 "type": "string" |
| 150 } |
| 151 }, |
| 152 "path": "v1/projects/{projectId}/indexes", |
| 153 "response": { |
| 154 "$ref": "ListIndexesResponse" |
| 155 }, |
| 156 "scopes": [ |
| 157 "https://www.googleapis.com/auth/cloud-platform"
, |
| 158 "https://www.googleapis.com/auth/cloudsearch", |
| 159 "https://www.googleapis.com/auth/userinfo.email" |
| 160 ] |
| 161 }, |
| 162 "search": { |
| 163 "description": "Lists the documents in the named ind
ex that match the query.", |
| 164 "httpMethod": "GET", |
| 165 "id": "cloudsearch.projects.indexes.search", |
| 166 "parameterOrder": [ |
| 167 "projectId", |
| 168 "indexId", |
| 169 "query", |
| 170 "fieldExpressions", |
| 171 "pageSize", |
| 172 "pageToken", |
| 173 "offset", |
| 174 "matchedCountAccuracy", |
| 175 "orderBy", |
| 176 "scorer", |
| 177 "scorerSize", |
| 178 "returnFields" |
| 179 ], |
| 180 "parameters": { |
| 181 "projectId": { |
| 182 "description": "The project associated with
the index for searching document. It cannot be the empty string.", |
| 183 "location": "path", |
| 184 "required": true, |
| 185 "type": "string" |
| 186 }, |
| 187 "indexId": { |
| 188 "description": "The index to search. It cann
ot be the empty string.", |
| 189 "location": "path", |
| 190 "required": true, |
| 191 "type": "string" |
| 192 }, |
| 193 "query": { |
| 194 "description": "The query string in search q
uery syntax. If the query is missing or empty, all documents are returned.", |
| 195 "location": "query", |
| 196 "type": "string" |
| 197 }, |
| 198 "fieldExpressions": { |
| 199 "description": "Customized expressions used
in `orderBy` or `returnFields`. The expression can contain fields in `Document`,
the built-in fields ( `_rank`, the document rank, and `_score` if scoring is en
abled) and fields defined in `fieldExpressions`. Each field expression is repres
ented in a json object with the following fields: * `name`: the name of the fiel
d expression in string. * `expression`: the expression to be computed. It can be
a combination of supported functions encoded in string. Expressions involving n
umber fields can use the arithmetical operators (`+`, `-`, `*`, `/`) and the bui
lt-in numeric functions (`max`, `min`, `pow`, `count`, `log`, `abs`). Expression
s involving geopoint fields can use the `geopoint` and `distance` functions. Exp
ressions for text and html fields can use the `snippet` function. For example: `
`` fieldExpressions={name: \"TotalPrice\", expression: \"(Price+Tax)\"} ``` ```
fieldExpressions={name: \"snippet\", expression: \"snippet('good times', content
)\"} ``` The field expression names can be used in `orderBy` and `returnFields`
after they are defined in `fieldExpressions`.", |
| 200 "location": "query", |
| 201 "repeated": true, |
| 202 "type": "string" |
| 203 }, |
| 204 "pageSize": { |
| 205 "description": "The maximum number of search
results to return per page. Searches perform best when the `pageSize` is kept a
s small as possible. If not specified, 10 results are returned per page.", |
| 206 "format": "int32", |
| 207 "location": "query", |
| 208 "type": "integer" |
| 209 }, |
| 210 "pageToken": { |
| 211 "description": "A `nextPageToken` returned f
rom previous Search call as the starting point for this call. Pagination tokens
provide better performance and consistency than offsets, and they cannot be used
in combination with offsets.", |
| 212 "location": "query", |
| 213 "type": "string" |
| 214 }, |
| 215 "offset": { |
| 216 "description": "Offset is used to move to an
arbitrary result, independent of the previous results. Offsets are inefficient
when compared to `pageToken`. `pageToken` and `offset` cannot be both set. The d
efault value of `offset` is 0.", |
| 217 "format": "int32", |
| 218 "location": "query", |
| 219 "type": "integer" |
| 220 }, |
| 221 "matchedCountAccuracy": { |
| 222 "description": "Minimum accuracy requirement
for `matchedCount` in search response. If specified, `matchedCount` will be acc
urate up to at least that number. For example, when set to 100, any `matchedCoun
t <= 100` is accurate. This option may add considerable latency/expense. By defa
ult (when it is not specified or set to 0), the accuracy is the same as `pageSiz
e`.", |
| 223 "format": "int32", |
| 224 "location": "query", |
| 225 "type": "integer" |
| 226 }, |
| 227 "orderBy": { |
| 228 "description": "Comma-separated list of fiel
ds for sorting on the search result, including fields from `Document`, the built
-in fields (`_rank` and `_score`), and fields defined in `fieldExpressions`. For
example: `orderBy=\"foo,bar\"`. The default sorting order is ascending. To spec
ify descending order for a field, a suffix `\" desc\"` should be appended to the
field name. For example: `orderBy=\"foo desc,bar\"`. The default value for text
sort is the empty string, and the default value for numeric sort is 0. If not s
pecified, the search results are automatically sorted by descending `_rank`. Sor
ting by ascending `_rank` is not allowed.", |
| 229 "location": "query", |
| 230 "type": "string" |
| 231 }, |
| 232 "scorer": { |
| 233 "description": "The scoring function to invo
ke on a search result for this query. If `scorer` is not set, scoring is disable
d and `_score` is 0 for all documents in the search result. To enable document r
elevancy score based on term frequency, set `\"scorer=generic\"`.", |
| 234 "location": "query", |
| 235 "type": "string" |
| 236 }, |
| 237 "scorerSize": { |
| 238 "description": "Maximum number of top retrie
ved results to score. It is valid only when `scorer` is set. If not specified, 1
00 retrieved results are scored.", |
| 239 "format": "int32", |
| 240 "location": "query", |
| 241 "type": "integer" |
| 242 }, |
| 243 "returnFields": { |
| 244 "description": "List of fields to return in
`SearchResult` objects. It can be fields from `Document`, the built-in fields `_
rank` and `_score`, and fields defined in `fieldExpressions`. Use `\"*\"` to ret
urn all fields from `Document`.", |
| 245 "location": "query", |
| 246 "repeated": true, |
| 247 "type": "string" |
| 248 } |
| 249 }, |
| 250 "path": "v1/projects/{projectId}/indexes/{indexId}/s
earch", |
| 251 "response": { |
| 252 "$ref": "SearchResponse" |
| 253 }, |
| 254 "scopes": [ |
| 255 "https://www.googleapis.com/auth/cloud-platform"
, |
| 256 "https://www.googleapis.com/auth/cloudsearch", |
| 257 "https://www.googleapis.com/auth/userinfo.email" |
| 258 ] |
| 259 } |
| 260 }, |
| 261 "resources": { |
| 262 "documents": { |
| 263 "methods": { |
| 264 "create": { |
| 265 "description": "Inserts a document for index
ing or updates an indexed document. The returned document contains only the ID o
f the new document. When `docId` is absent from the document, it is provided by
the server.", |
| 266 "httpMethod": "POST", |
| 267 "id": "cloudsearch.projects.indexes.document
s.create", |
| 268 "parameterOrder": [ |
| 269 "projectId", |
| 270 "indexId" |
| 271 ], |
| 272 "parameters": { |
| 273 "projectId": { |
| 274 "description": "The project associat
ed with the index for adding document. It cannot be the empty string.", |
| 275 "location": "path", |
| 276 "required": true, |
| 277 "type": "string" |
| 278 }, |
| 279 "indexId": { |
| 280 "description": "The index to add doc
ument to. It cannot be the empty string.", |
| 281 "location": "path", |
| 282 "required": true, |
| 283 "type": "string" |
| 284 } |
| 285 }, |
| 286 "path": "v1/projects/{projectId}/indexes/{in
dexId}/documents", |
| 287 "request": { |
| 288 "$ref": "Document" |
| 289 }, |
| 290 "response": { |
| 291 "$ref": "Document" |
| 292 }, |
| 293 "scopes": [ |
| 294 "https://www.googleapis.com/auth/cloud-p
latform", |
| 295 "https://www.googleapis.com/auth/cloudse
arch", |
| 296 "https://www.googleapis.com/auth/userinf
o.email" |
| 297 ] |
| 298 }, |
| 299 "delete": { |
| 300 "description": "Deletes a document from an i
ndex.", |
| 301 "httpMethod": "DELETE", |
| 302 "id": "cloudsearch.projects.indexes.document
s.delete", |
| 303 "parameterOrder": [ |
| 304 "projectId", |
| 305 "indexId", |
| 306 "docId" |
| 307 ], |
| 308 "parameters": { |
| 309 "projectId": { |
| 310 "description": "The project associat
ed with the index for deleting document. It cannot be the empty string.", |
| 311 "location": "path", |
| 312 "required": true, |
| 313 "type": "string" |
| 314 }, |
| 315 "indexId": { |
| 316 "description": "The index from which
to delete the document. It cannot be the empty string.", |
| 317 "location": "path", |
| 318 "required": true, |
| 319 "type": "string" |
| 320 }, |
| 321 "docId": { |
| 322 "description": "The document to be d
eleted. It cannot be the empty string.", |
| 323 "location": "path", |
| 324 "required": true, |
| 325 "type": "string" |
| 326 } |
| 327 }, |
| 328 "path": "v1/projects/{projectId}/indexes/{in
dexId}/documents/{docId}", |
| 329 "response": { |
| 330 "$ref": "Empty" |
| 331 }, |
| 332 "scopes": [ |
| 333 "https://www.googleapis.com/auth/cloud-p
latform", |
| 334 "https://www.googleapis.com/auth/cloudse
arch", |
| 335 "https://www.googleapis.com/auth/userinf
o.email" |
| 336 ] |
| 337 }, |
| 338 "get": { |
| 339 "description": "Retrieves a document from an
index.", |
| 340 "httpMethod": "GET", |
| 341 "id": "cloudsearch.projects.indexes.document
s.get", |
| 342 "parameterOrder": [ |
| 343 "projectId", |
| 344 "indexId", |
| 345 "docId" |
| 346 ], |
| 347 "parameters": { |
| 348 "projectId": { |
| 349 "description": "The project associat
ed with the index for retrieving the document. It cannot be the empty string.", |
| 350 "location": "path", |
| 351 "required": true, |
| 352 "type": "string" |
| 353 }, |
| 354 "indexId": { |
| 355 "description": "The index from which
to retrieve the document. It cannot be the empty string.", |
| 356 "location": "path", |
| 357 "required": true, |
| 358 "type": "string" |
| 359 }, |
| 360 "docId": { |
| 361 "description": "The identifier of th
e document to retrieve. It cannot be the empty string.", |
| 362 "location": "path", |
| 363 "required": true, |
| 364 "type": "string" |
| 365 } |
| 366 }, |
| 367 "path": "v1/projects/{projectId}/indexes/{in
dexId}/documents/{docId}", |
| 368 "response": { |
| 369 "$ref": "Document" |
| 370 }, |
| 371 "scopes": [ |
| 372 "https://www.googleapis.com/auth/cloud-p
latform", |
| 373 "https://www.googleapis.com/auth/cloudse
arch", |
| 374 "https://www.googleapis.com/auth/userinf
o.email" |
| 375 ] |
| 376 }, |
| 377 "list": { |
| 378 "description": "Lists documents in the speci
fied search index. Intended for batch processing.", |
| 379 "httpMethod": "GET", |
| 380 "id": "cloudsearch.projects.indexes.document
s.list", |
| 381 "parameterOrder": [ |
| 382 "projectId", |
| 383 "indexId", |
| 384 "pageSize", |
| 385 "pageToken", |
| 386 "view" |
| 387 ], |
| 388 "parameters": { |
| 389 "projectId": { |
| 390 "description": "The project associat
ed with the index for listing documents. It cannot be the empty string.", |
| 391 "location": "path", |
| 392 "required": true, |
| 393 "type": "string" |
| 394 }, |
| 395 "indexId": { |
| 396 "description": "The index from which
to list the documents. It cannot be the empty string.", |
| 397 "location": "path", |
| 398 "required": true, |
| 399 "type": "string" |
| 400 }, |
| 401 "pageSize": { |
| 402 "description": "The maximum number o
f documents to return per page. If not specified, 100 documents are returned per
page.", |
| 403 "format": "int32", |
| 404 "location": "query", |
| 405 "type": "integer" |
| 406 }, |
| 407 "pageToken": { |
| 408 "description": "A `nextPageToken` re
turned from previous list documents call as the starting point for this call. If
not specified, list documents from the beginning.", |
| 409 "location": "query", |
| 410 "type": "string" |
| 411 }, |
| 412 "view": { |
| 413 "description": "Specifies which part
of the document resource is returned in the response. If not specified, `ID_ONL
Y` is used.", |
| 414 "enum": [ |
| 415 "DOCUMENT_VIEW_UNSPECIFIED", |
| 416 "ID_ONLY", |
| 417 "FULL" |
| 418 ], |
| 419 "location": "query", |
| 420 "type": "string" |
| 421 } |
| 422 }, |
| 423 "path": "v1/projects/{projectId}/indexes/{in
dexId}/documents", |
| 424 "response": { |
| 425 "$ref": "ListDocumentsResponse" |
| 426 }, |
| 427 "scopes": [ |
| 428 "https://www.googleapis.com/auth/cloud-p
latform", |
| 429 "https://www.googleapis.com/auth/cloudse
arch", |
| 430 "https://www.googleapis.com/auth/userinf
o.email" |
| 431 ] |
| 432 } |
| 433 } |
| 434 } |
| 435 } |
| 436 } |
| 437 } |
| 438 } |
| 439 }, |
| 440 "revision": "20150309", |
| 441 "rootUrl": "https://cloudsearch.googleapis.com/", |
| 442 "schemas": { |
| 443 "Document": { |
| 444 "description": "The message representing a document resource.", |
| 445 "id": "Document", |
| 446 "properties": { |
| 447 "docId": { |
| 448 "description": "The unique identifier of the document. It mu
st contain only visible, printable ASCII characters (ASCII codes 33 through 126
inclusive) and be no longer than 500 characters. It cannot begin with an exclama
tion point ('!'), and it can't begin and end with double underscores (\"__\"). I
f missing, it is automatically assigned for the document.", |
| 449 "type": "string" |
| 450 }, |
| 451 "rank": { |
| 452 "description": "A positive integer which determines the defa
ult ordering of documents returned from a search. The rank can be set explicitly
when the document is created. It is a bad idea to assign the same rank to many
documents, and the same rank should never be assigned to more than 10,000 docume
nts. By default (when it is not specified or set to 0), it is set at the time th
e document is created to the number of seconds since January 1, 2011. The rank c
an be used in field_expressions, order_by or return_fields in a search request,
where it is referenced as `_rank`.", |
| 453 "format": "int32", |
| 454 "type": "integer" |
| 455 }, |
| 456 "fields": { |
| 457 "additionalProperties": { |
| 458 "$ref": "FieldValueList" |
| 459 }, |
| 460 "description": "The list of fields in the document. It canno
t be the empty list. Each field has a name and a list of values. The field name
is unique to a document and is case sensitive. The name can only contain ASCII c
haracters. It must start with a letter and can contain letters, digits, or under
score. It cannot be longer than 500 characters and cannot be the empty string. A
field can have multiple values with same or different types, however, it cannot
have multiple Timestamp or number values.", |
| 461 "type": "object" |
| 462 } |
| 463 }, |
| 464 "type": "object" |
| 465 }, |
| 466 "FieldValueList": { |
| 467 "description": "The values of a document field under the same field
name.", |
| 468 "id": "FieldValueList", |
| 469 "properties": { |
| 470 "values": { |
| 471 "description": "The list of typed values.", |
| 472 "items": { |
| 473 "$ref": "FieldValue" |
| 474 }, |
| 475 "type": "array" |
| 476 } |
| 477 }, |
| 478 "type": "object" |
| 479 }, |
| 480 "FieldValue": { |
| 481 "description": "The value of a document field and associated metadat
a. Exactly one of the value fields may be set.", |
| 482 "id": "FieldValue", |
| 483 "properties": { |
| 484 "stringValue": { |
| 485 "description": "The value of a string-valued field.", |
| 486 "type": "string" |
| 487 }, |
| 488 "timestampValue": { |
| 489 "description": "The value of a timestamp-valued field.", |
| 490 "type": "string" |
| 491 }, |
| 492 "numberValue": { |
| 493 "description": "The value of a number-valued field.", |
| 494 "format": "double", |
| 495 "type": "number" |
| 496 }, |
| 497 "geoValue": { |
| 498 "description": "The value of a GEO-valued field, represented
in string with any of the listed [ways of writing coordinates](http://en.wikipe
dia.org/wiki/Geographic_coordinate_conversion#Ways_of_writing_coordinates)", |
| 499 "type": "string" |
| 500 }, |
| 501 "stringFormat": { |
| 502 "description": "The format of a string value. By default, th
e string format is `DEFAULT`, where a format will be automatically detected.", |
| 503 "enum": [ |
| 504 "DEFAULT", |
| 505 "ATOM", |
| 506 "TEXT", |
| 507 "HTML" |
| 508 ], |
| 509 "type": "string" |
| 510 }, |
| 511 "lang": { |
| 512 "description": "The language of a string value. If given, th
e language must be a valid `ISO 639-1` code.", |
| 513 "type": "string" |
| 514 } |
| 515 }, |
| 516 "type": "object" |
| 517 }, |
| 518 "Empty": { |
| 519 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", |
| 520 "id": "Empty", |
| 521 "type": "object" |
| 522 }, |
| 523 "ListDocumentsResponse": { |
| 524 "description": "A response returned from a listing documents request
.", |
| 525 "id": "ListDocumentsResponse", |
| 526 "properties": { |
| 527 "documents": { |
| 528 "description": "The list of documents.", |
| 529 "items": { |
| 530 "$ref": "Document" |
| 531 }, |
| 532 "type": "array" |
| 533 }, |
| 534 "nextPageToken": { |
| 535 "description": "If there are more results, retrieve them by
invoking list documents call with the same arguments and this `nextPageToken`. I
f there are no more results, this field is not set.", |
| 536 "type": "string" |
| 537 } |
| 538 }, |
| 539 "type": "object" |
| 540 }, |
| 541 "ListIndexesResponse": { |
| 542 "description": "A response returned from a listing indexes request."
, |
| 543 "id": "ListIndexesResponse", |
| 544 "properties": { |
| 545 "indexes": { |
| 546 "description": "The information about available indexes.", |
| 547 "items": { |
| 548 "$ref": "IndexInfo" |
| 549 }, |
| 550 "type": "array" |
| 551 }, |
| 552 "nextPageToken": { |
| 553 "description": "If there are more results, retrieve them by
invoking list indexes call with the same arguments and this `nextPageToken`. If
there are no more results, this field is not set.", |
| 554 "type": "string" |
| 555 } |
| 556 }, |
| 557 "type": "object" |
| 558 }, |
| 559 "IndexInfo": { |
| 560 "description": "Information about an index.", |
| 561 "id": "IndexInfo", |
| 562 "properties": { |
| 563 "projectId": { |
| 564 "description": "The project associated with the index. It ca
nnot be the empty string.", |
| 565 "type": "string" |
| 566 }, |
| 567 "indexId": { |
| 568 "description": "The index identifier. It cannot be the empty
string. It must contain only visible, printable ASCII characters (ASCII codes 3
3 through 126 inclusive) and be no longer than 100 characters. It cannot begin w
ith an exclamation point ('!'), and it can't begin and end with double underscor
es (\"__\").", |
| 569 "type": "string" |
| 570 }, |
| 571 "indexedField": { |
| 572 "$ref": "FieldNames", |
| 573 "description": "Names of indexed fields." |
| 574 } |
| 575 }, |
| 576 "type": "object" |
| 577 }, |
| 578 "FieldNames": { |
| 579 "description": "Names of indexed fields.", |
| 580 "id": "FieldNames", |
| 581 "properties": { |
| 582 "textFields": { |
| 583 "description": "The names of fields in which TEXT values are
stored.", |
| 584 "items": { |
| 585 "type": "string" |
| 586 }, |
| 587 "type": "array" |
| 588 }, |
| 589 "htmlFields": { |
| 590 "description": "The names of fields in which HTML values are
stored.", |
| 591 "items": { |
| 592 "type": "string" |
| 593 }, |
| 594 "type": "array" |
| 595 }, |
| 596 "atomFields": { |
| 597 "description": "The names of fields in which ATOM values are
stored.", |
| 598 "items": { |
| 599 "type": "string" |
| 600 }, |
| 601 "type": "array" |
| 602 }, |
| 603 "dateFields": { |
| 604 "description": "The names of fields in which DATE values are
stored.", |
| 605 "items": { |
| 606 "type": "string" |
| 607 }, |
| 608 "type": "array" |
| 609 }, |
| 610 "numberFields": { |
| 611 "description": "The names of fields in which NUMBER values a
re stored.", |
| 612 "items": { |
| 613 "type": "string" |
| 614 }, |
| 615 "type": "array" |
| 616 }, |
| 617 "geoFields": { |
| 618 "description": "The names of fields in which GEO values are
stored.", |
| 619 "items": { |
| 620 "type": "string" |
| 621 }, |
| 622 "type": "array" |
| 623 } |
| 624 }, |
| 625 "type": "object" |
| 626 }, |
| 627 "SearchResponse": { |
| 628 "description": "A response returned from a search request.", |
| 629 "id": "SearchResponse", |
| 630 "properties": { |
| 631 "results": { |
| 632 "description": "The list of documents that match the search
query.", |
| 633 "items": { |
| 634 "$ref": "SearchResult" |
| 635 }, |
| 636 "type": "array" |
| 637 }, |
| 638 "matchedCount": { |
| 639 "description": "The number of documents that match the query
. It is greater than or equal to the number of documents actually returned. This
is an approximation and not an exact count unless it is less than or equal to `
matchedCountAccuracy` in search parameter.", |
| 640 "format": "int64", |
| 641 "type": "string" |
| 642 } |
| 643 }, |
| 644 "type": "object" |
| 645 }, |
| 646 "SearchResult": { |
| 647 "description": "A document returned in a SearchResponse.", |
| 648 "id": "SearchResult", |
| 649 "properties": { |
| 650 "docId": { |
| 651 "description": "The unique identifier of the document.", |
| 652 "type": "string" |
| 653 }, |
| 654 "fields": { |
| 655 "additionalProperties": { |
| 656 "$ref": "FieldValueList" |
| 657 }, |
| 658 "description": "The list of fields in the result. Each field
is either from the stored document, the built-in fields (`_rank`, the document
rank, and `_score` if scoring is enabled), or computed from any extra `fieldExpr
essions` defined in the request. For example, if a request contains a `fieldExpr
essions` named `\"TotalPrice\"` and expressed as `\"Price + Tax\"`, the result w
ill have a field whose name is `\"TotalPrice\"` and whose value is set to the co
mputed sum of the value of field `\"Price\"` and the value of field `\"Tax\"`. I
f a request contains a `fieldExpressions` named `\"snippet\"` and expressed as `
\"snippet(\\\"good times\\\", content)\"`, the result will have a field whose na
me is `\"snippet\"` and whose value contains a snippet of text from field `\"con
tent\"` matching the query \"good times\".", |
| 659 "type": "object" |
| 660 }, |
| 661 "nextPageToken": { |
| 662 "description": "If there are more results, retrieve them by
invoking search call with the same arguments and this `nextPageToken`. If there
are no more results, this field is not set.", |
| 663 "type": "string" |
| 664 } |
| 665 }, |
| 666 "type": "object" |
| 667 } |
| 668 }, |
| 669 "servicePath": "", |
| 670 "title": "Google Cloud Search API", |
| 671 "version": "v1" |
| 672 } |
OLD | NEW |