blob: 22bf28150ed04d404ac332eed5531188d6c37427 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud_search": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.debug": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.query": {
"description": "Search your organization's data in the Cloud Search index"
},
"https://www.googleapis.com/auth/cloud_search.settings": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.settings.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.settings.query": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.stats": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.stats.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudsearch.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Search",
"description": "Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/cloud-search/docs/guides/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudsearch:v1",
"kind": "discovery#restDescription",
"name": "cloudsearch",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"debug": {
"resources": {
"datasources": {
"resources": {
"items": {
"methods": {
"checkAccess": {
"description": "Checks whether an item is accessible by specified principal.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/datasources/{datasourcesId}/items/{itemsId}:checkAccess",
"httpMethod": "POST",
"id": "cloudsearch.debug.datasources.items.checkAccess",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Item name, format:\ndatasources/{source_id}/items/{item_id}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/debug/{+name}:checkAccess",
"request": {
"$ref": "Principal"
},
"response": {
"$ref": "CheckAccessResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
},
"searchByViewUrl": {
"description": "Fetches the item whose viewUrl exactly matches that of the URL provided\nin the request.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/datasources/{datasourcesId}/items:searchByViewUrl",
"httpMethod": "POST",
"id": "cloudsearch.debug.datasources.items.searchByViewUrl",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Source name, format:\ndatasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/debug/{+name}/items:searchByViewUrl",
"request": {
"$ref": "SearchItemsByViewUrlRequest"
},
"response": {
"$ref": "SearchItemsByViewUrlResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
},
"resources": {
"unmappedids": {
"methods": {
"list": {
"description": "List all unmapped identities for a specific item.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/datasources/{datasourcesId}/items/{itemsId}/unmappedids",
"httpMethod": "GET",
"id": "cloudsearch.debug.datasources.items.unmappedids.list",
"parameterOrder": [
"parent"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request.\nDefaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the item, in the following format:\ndatasources/{source_id}/items/{ID}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/debug/{+parent}/unmappedids",
"response": {
"$ref": "ListUnmappedIdentitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
}
}
}
}
},
"identitysources": {
"resources": {
"items": {
"methods": {
"listForunmappedidentity": {
"description": "Lists names of items associated with an unmapped identity.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/identitysources/{identitysourcesId}/items:forunmappedidentity",
"httpMethod": "GET",
"id": "cloudsearch.debug.identitysources.items.listForunmappedidentity",
"parameterOrder": [
"parent"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"groupResourceName": {
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request.\nDefaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the identity source, in the following format:\nidentitysources/{source_id}}",
"location": "path",
"pattern": "^identitysources/[^/]+$",
"required": true,
"type": "string"
},
"userResourceName": {
"location": "query",
"type": "string"
}
},
"path": "v1/debug/{+parent}/items:forunmappedidentity",
"response": {
"$ref": "ListItemNamesForUnmappedIdentityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
},
"unmappedids": {
"methods": {
"list": {
"description": "Lists unmapped user identities for an identity source.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/identitysources/{identitysourcesId}/unmappedids",
"httpMethod": "GET",
"id": "cloudsearch.debug.identitysources.unmappedids.list",
"parameterOrder": [
"parent"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request.\nDefaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the identity source, in the following format:\nidentitysources/{source_id}",
"location": "path",
"pattern": "^identitysources/[^/]+$",
"required": true,
"type": "string"
},
"resolutionStatusCode": {
"description": "Limit users selection to this status.",
"enum": [
"CODE_UNSPECIFIED",
"NOT_FOUND",
"IDENTITY_SOURCE_NOT_FOUND",
"IDENTITY_SOURCE_MISCONFIGURED",
"TOO_MANY_MAPPINGS_FOUND",
"INTERNAL_ERROR"
],
"location": "query",
"type": "string"
}
},
"path": "v1/debug/{+parent}/unmappedids",
"response": {
"$ref": "ListUnmappedIdentitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
}
}
}
}
},
"indexing": {
"resources": {
"datasources": {
"methods": {
"deleteSchema": {
"description": "Deletes the schema of a data source.\n\n**Note:** This API requires an admin or service account to execute.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"httpMethod": "DELETE",
"id": "cloudsearch.indexing.datasources.deleteSchema",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the data source to delete Schema. Format:\ndatasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/schema",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"getSchema": {
"description": "Gets the schema of a data source.\n\n**Note:** This API requires an admin or service account to execute.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"httpMethod": "GET",
"id": "cloudsearch.indexing.datasources.getSchema",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the data source to get Schema. Format:\ndatasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/schema",
"response": {
"$ref": "Schema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"updateSchema": {
"description": "Updates the schema of a data source. This method does not perform\nincremental updates to the schema. Instead, this method updates the schema\nby overwriting the entire schema.\n\n**Note:** This API requires an admin or service account to execute.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"httpMethod": "PUT",
"id": "cloudsearch.indexing.datasources.updateSchema",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the data source to update Schema. Format:\ndatasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/schema",
"request": {
"$ref": "UpdateSchemaRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
}
},
"resources": {
"items": {
"methods": {
"delete": {
"description": "Deletes Item resource for the\nspecified resource name. This API requires an admin or service account\nto execute. The service account used is the one whitelisted in the\ncorresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}",
"httpMethod": "DELETE",
"id": "cloudsearch.indexing.datasources.items.delete",
"parameterOrder": [
"name"
],
"parameters": {
"connectorName": {
"description": "Name of connector making this call.\n\u003cbr /\u003eFormat: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"mode": {
"description": "Required. The RequestMode for this request.",
"enum": [
"UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Name of the item to delete.\nFormat: datasources/{source_id}/items/{item_id}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
},
"version": {
"description": "Required. The incremented version of the item to delete from the index.\nThe indexing system stores the version from the datasource as a\nbyte string and compares the Item version in the index\nto the version of the queued Item using lexical ordering.\n\u003cbr /\u003e\u003cbr /\u003e\nCloud Search Indexing won't delete any queued item with\na version value that is less than or equal to\nthe version of the currently indexed item.\nThe maximum length for this field is 1024 bytes.",
"format": "byte",
"location": "query",
"type": "string"
}
},
"path": "v1/indexing/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"deleteQueueItems": {
"description": "Deletes all items in a queue. This method is useful for deleting stale\nitems.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:deleteQueueItems",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.deleteQueueItems",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the Data Source to delete items in a queue.\nFormat: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/items:deleteQueueItems",
"request": {
"$ref": "DeleteQueueItemsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"get": {
"description": "Gets Item resource by item name.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}",
"httpMethod": "GET",
"id": "cloudsearch.indexing.datasources.items.get",
"parameterOrder": [
"name"
],
"parameters": {
"connectorName": {
"description": "Name of connector making this call.\n\u003cbr /\u003eFormat: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the item to get info.\nFormat: datasources/{source_id}/items/{item_id}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}",
"response": {
"$ref": "Item"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"index": {
"description": "Updates Item ACL, metadata, and\ncontent. It will insert the Item if it\ndoes not exist.\nThis method does not support partial updates. Fields with no provided\nvalues are cleared out in the Cloud Search index.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:index",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.index",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the Item. Format:\ndatasources/{source_id}/items/{item_id}\n\u003cbr /\u003eThis is a required field.\nThe maximum length is 1536 characters.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}:index",
"request": {
"$ref": "IndexItemRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"list": {
"description": "Lists all or a subset of Item resources.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items",
"httpMethod": "GET",
"id": "cloudsearch.indexing.datasources.items.list",
"parameterOrder": [
"name"
],
"parameters": {
"brief": {
"description": "When set to true, the indexing system only populates the following fields:\nname,\nversion,\nqueue.\nmetadata.hash,\nmetadata.title,\nmetadata.sourceRepositoryURL,\nmetadata.objectType,\nmetadata.createTime,\nmetadata.updateTime,\nmetadata.contentLanguage,\nmetadata.mimeType,\nstructured_data.hash,\ncontent.hash,\nitemType,\nitemStatus.code,\nitemStatus.processingError.code,\nitemStatus.repositoryError.type,\n\u003cbr /\u003eIf this value is false, then all the fields are populated in Item.",
"location": "query",
"type": "boolean"
},
"connectorName": {
"description": "Name of connector making this call.\n\u003cbr /\u003eFormat: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the Data Source to list Items. Format:\ndatasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request.\nThe max value is 1000 when brief is true. The max value is 10 if brief\nis false.\n\u003cbr /\u003eThe default value is 10",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
}
},
"path": "v1/indexing/{+name}/items",
"response": {
"$ref": "ListItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"poll": {
"description": "Polls for unreserved items from the indexing queue and marks a\nset as reserved, starting with items that have\nthe oldest timestamp from the highest priority\nItemStatus.\nThe priority order is as follows: \u003cbr /\u003e\nERROR\n\u003cbr /\u003e\nMODIFIED\n\u003cbr /\u003e\nNEW_ITEM\n\u003cbr /\u003e\nACCEPTED\n\u003cbr /\u003e\nReserving items ensures that polling from other threads\ncannot create overlapping sets.\n\nAfter handling the reserved items, the client should put items back\ninto the unreserved state, either by calling\nindex,\nor by calling\npush with\nthe type REQUEUE.\n\nItems automatically become available (unreserved) after 4 hours even if no\nupdate or push method is called.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:poll",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.poll",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the Data Source to poll items.\nFormat: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/items:poll",
"request": {
"$ref": "PollItemsRequest"
},
"response": {
"$ref": "PollItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"push": {
"description": "Pushes an item onto a queue for later polling and updating.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:push",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.push",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the item to\npush into the indexing queue.\u003cbr /\u003e\nFormat: datasources/{source_id}/items/{ID}\n\u003cbr /\u003eThis is a required field.\nThe maximum length is 1536 characters.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}:push",
"request": {
"$ref": "PushItemRequest"
},
"response": {
"$ref": "Item"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"unreserve": {
"description": "Unreserves all items from a queue, making them all eligible to be\npolled. This method is useful for resetting the indexing queue\nafter a connector has been restarted.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:unreserve",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.unreserve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the Data Source to unreserve all items.\nFormat: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/items:unreserve",
"request": {
"$ref": "UnreserveItemsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"upload": {
"description": "Creates an upload session for uploading item content. For items smaller\nthan 100 KB, it's easier to embed the content\ninline within\nan index request.\n\nThis API requires an admin or service account to execute. The service\naccount used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:upload",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.upload",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the Item to start a resumable upload.\nFormat: datasources/{source_id}/items/{item_id}.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}:upload",
"request": {
"$ref": "StartUploadItemRequest"
},
"response": {
"$ref": "UploadItemRef"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
}
}
}
}
}
}
},
"media": {
"methods": {
"upload": {
"description": "Uploads media for indexing.\n\nThe upload endpoint supports direct and resumable upload protocols and\nis intended for large items that can not be\n[inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent).\nTo index large content:\n\n1. Call\n indexing.datasources.items.upload\n with the resource name to begin an upload session and retrieve the\n UploadItemRef.\n1. Call media.upload to upload the content using the same resource name from step 1.\n1. Call indexing.datasources.items.index\n to index the item. Populate the\n [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent)\n with the UploadItemRef from step 1.\n\n\nFor additional information, see\n[Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest).\n\n **Note:** This API requires a service account to execute.",
"flatPath": "v1/media/{mediaId}",
"httpMethod": "POST",
"id": "cloudsearch.media.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1/media/{+resourceName}"
}
}
},
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.",
"location": "path",
"pattern": "^.+$",
"required": true,
"type": "string"
}
},
"path": "v1/media/{+resourceName}",
"request": {
"$ref": "Media"
},
"response": {
"$ref": "Media"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"supportsMediaUpload": true
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "cloudsearch.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug",
"https://www.googleapis.com/auth/cloud_search.indexing",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
}
}
},
"query": {
"methods": {
"search": {
"description": "The Cloud Search Query API provides the search method, which returns\nthe most relevant results from a user query. The results can come from\nG Suite Apps, such as Gmail or Google Drive, or they can come from data\nthat you have indexed from a third party.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/query/search",
"httpMethod": "POST",
"id": "cloudsearch.query.search",
"parameterOrder": [],
"parameters": {},
"path": "v1/query/search",
"request": {
"$ref": "SearchRequest"
},
"response": {
"$ref": "SearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
]
},
"suggest": {
"description": "Provides suggestions for autocompleting the query.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/query/suggest",
"httpMethod": "POST",
"id": "cloudsearch.query.suggest",
"parameterOrder": [],
"parameters": {},
"path": "v1/query/suggest",
"request": {
"$ref": "SuggestRequest"
},
"response": {
"$ref": "SuggestResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
]
}
},
"resources": {
"sources": {
"methods": {
"list": {
"description": "Returns list of sources that user can use for Search and Suggest APIs.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/query/sources",
"httpMethod": "GET",
"id": "cloudsearch.query.sources.list",
"parameterOrder": [],
"parameters": {
"pageToken": {
"description": "Number of sources to return in the response.",
"location": "query",
"type": "string"
},
"requestOptions.debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"requestOptions.languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.\nFor translations.\n\nSet this field using the language set in browser or for the page. In the\nevent that the user's language preference is known, set this field to the\nknown user language.\n\nWhen specified, the documents in search results are biased towards the\nspecified language.\n\nThe suggest API does not use this parameter. Instead, suggest autocompletes\nonly based on characters in the query.",
"location": "query",
"type": "string"
},
"requestOptions.searchApplicationId": {
"description": "Id of the application created using SearchApplicationsService.",
"location": "query",
"type": "string"
},
"requestOptions.timeZone": {
"description": "Current user's time zone id, such as \"America/Los_Angeles\" or\n\"Australia/Sydney\". These IDs are defined by\n[Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)\nproject, and currently available in the file\n[timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml).\nThis field is used to correctly interpret date and time queries.\nIf this field is not specified, the default time zone (UTC) is used.",
"location": "query",
"type": "string"
}
},
"path": "v1/query/sources",
"response": {
"$ref": "ListQuerySourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
]
}
}
}
}
},
"settings": {
"resources": {
"datasources": {
"methods": {
"create": {
"description": "Creates a datasource.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/datasources",
"httpMethod": "POST",
"id": "cloudsearch.settings.datasources.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/settings/datasources",
"request": {
"$ref": "DataSource"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"delete": {
"description": "Deletes a datasource.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/datasources/{datasourcesId}",
"httpMethod": "DELETE",
"id": "cloudsearch.settings.datasources.delete",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the datasource.\nFormat: datasources/{source_id}.",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"get": {
"description": "Gets a datasource.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/datasources/{datasourcesId}",
"httpMethod": "GET",
"id": "cloudsearch.settings.datasources.get",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the datasource resource.\nFormat: datasources/{source_id}.",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}",
"response": {
"$ref": "DataSource"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"list": {
"description": "Lists datasources.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/datasources",
"httpMethod": "GET",
"id": "cloudsearch.settings.datasources.list",
"parameterOrder": [],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "Maximum number of datasources to fetch in a request.\nThe max value is 100.\n\u003cbr /\u003eThe default value is 10",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Starting index of the results.",
"location": "query",
"type": "string"
}
},
"path": "v1/settings/datasources",
"response": {
"$ref": "ListDataSourceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"update": {
"description": "Updates a datasource.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/datasources/{datasourcesId}",
"httpMethod": "PUT",
"id": "cloudsearch.settings.datasources.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the datasource resource.\nFormat: datasources/{source_id}.\n\u003cbr /\u003eThe name is ignored when creating a datasource.",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}",
"request": {
"$ref": "UpdateDataSourceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
}
}
},
"searchapplications": {
"methods": {
"create": {
"description": "Creates a search application.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/searchapplications",
"httpMethod": "POST",
"id": "cloudsearch.settings.searchapplications.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/settings/searchapplications",
"request": {
"$ref": "SearchApplication"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
},
"delete": {
"description": "Deletes a search application.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}",
"httpMethod": "DELETE",
"id": "cloudsearch.settings.searchapplications.delete",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The name of the search application to be deleted.\n\u003cbr /\u003eFormat: applications/{application_id}.",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
},
"get": {
"description": "Gets the specified search application.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}",
"httpMethod": "GET",
"id": "cloudsearch.settings.searchapplications.get",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Name of the search application.\n\u003cbr /\u003eFormat: applications/{application_id}.",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}",
"response": {
"$ref": "SearchApplication"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
},
"list": {
"description": "Lists all search applications.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/searchapplications",
"httpMethod": "GET",
"id": "cloudsearch.settings.searchapplications.list",
"parameterOrder": [],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "The maximum number of items to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.\n\u003cbr/\u003e The default value is 10",
"location": "query",
"type": "string"
}
},
"path": "v1/settings/searchapplications",
"response": {
"$ref": "ListSearchApplicationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
},
"reset": {
"description": "Resets a search application to default settings. This will return an empty\nresponse.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}:reset",
"httpMethod": "POST",
"id": "cloudsearch.settings.searchapplications.reset",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the search application to be reset.\n\u003cbr /\u003eFormat: applications/{application_id}.",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}:reset",
"request": {
"$ref": "ResetSearchApplicationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
},
"update": {
"description": "Updates a search application.\n\n**Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}",
"httpMethod": "PUT",
"id": "cloudsearch.settings.searchapplications.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the Search Application.\n\u003cbr /\u003eFormat: searchapplications/{application_id}.",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/settings/{+name}",
"request": {
"$ref": "SearchApplication"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
}
}
}
}
},
"stats": {
"methods": {
"getIndex": {
"description": "Gets indexed item statistics aggreggated across all data sources. This\nAPI only returns statistics for previous dates; it doesn't return\nstatistics for the current day.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/index",
"httpMethod": "GET",
"id": "cloudsearch.stats.getIndex",
"parameterOrder": [],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/index",
"response": {
"$ref": "GetCustomerIndexStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
},
"getQuery": {
"description": "Get the query statistics for customer.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/query",
"httpMethod": "GET",
"id": "cloudsearch.stats.getQuery",
"parameterOrder": [],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/query",
"response": {
"$ref": "GetCustomerQueryStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
},
"getSession": {
"description": "Get the # of search sessions, % of successful sessions with a click query\nstatistics for customer.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/session",
"httpMethod": "GET",
"id": "cloudsearch.stats.getSession",
"parameterOrder": [],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/session",
"response": {
"$ref": "GetCustomerSessionStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
},
"getUser": {
"description": "Get the users statistics for customer.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/user",
"httpMethod": "GET",
"id": "cloudsearch.stats.getUser",
"parameterOrder": [],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/user",
"response": {
"$ref": "GetCustomerUserStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
}
},
"resources": {
"index": {
"resources": {
"datasources": {
"methods": {
"get": {
"description": "Gets indexed item statistics for a single data source.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/index/datasources/{datasourcesId}",
"httpMethod": "GET",
"id": "cloudsearch.stats.index.datasources.get",
"parameterOrder": [
"name"
],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"name": {
"description": "The resource id of the data source to retrieve statistics for,\nin the following format: \"datasources/{source_id}\"",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/index/{+name}",
"response": {
"$ref": "GetDataSourceIndexStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
}
}
}
}
},
"query": {
"resources": {
"searchapplications": {
"methods": {
"get": {
"description": "Get the query statistics for search application.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/query/searchapplications/{searchapplicationsId}",
"httpMethod": "GET",
"id": "cloudsearch.stats.query.searchapplications.get",
"parameterOrder": [
"name"
],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"name": {
"description": "The resource id of the search application query stats, in the following\nformat: searchapplications/{application_id}",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/query/{+name}",
"response": {
"$ref": "GetSearchApplicationQueryStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
}
}
}
}
},
"session": {
"resources": {
"searchapplications": {
"methods": {
"get": {
"description": "Get the # of search sessions, % of successful sessions with a click query\nstatistics for search application.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/session/searchapplications/{searchapplicationsId}",
"httpMethod": "GET",
"id": "cloudsearch.stats.session.searchapplications.get",
"parameterOrder": [
"name"
],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"name": {
"description": "The resource id of the search application session stats, in the following\nformat: searchapplications/{application_id}",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/session/{+name}",
"response": {
"$ref": "GetSearchApplicationSessionStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
}
}
}
}
},
"user": {
"resources": {
"searchapplications": {
"methods": {
"get": {
"description": "Get the users statistics for search application.\n\n**Note:** This API requires a standard end user account to execute.",
"flatPath": "v1/stats/user/searchapplications/{searchapplicationsId}",
"httpMethod": "GET",
"id": "cloudsearch.stats.user.searchapplications.get",
"parameterOrder": [
"name"
],
"parameters": {
"fromDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"name": {
"description": "The resource id of the search application session stats, in the following\nformat: searchapplications/{application_id}",
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"type": "string"
},
"toDate.day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/stats/user/{+name}",
"response": {
"$ref": "GetSearchApplicationUserStatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing"
]
}
}
}
}
}
}
}
},
"revision": "20191112",
"rootUrl": "https://cloudsearch.googleapis.com/",
"schemas": {
"BooleanOperatorOptions": {
"description": "Used to provide a search operator for boolean properties. This is\noptional. Search operators let users restrict the query to specific fields\nrelevant to the type of item being searched.",
"id": "BooleanOperatorOptions",
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to isolate the\nboolean property. For example, if operatorName is *closed* and the\nproperty's name is *isClosed*, then queries like\n*closed:\u0026lt;value\u0026gt;* will show results only where the value of the\nproperty named *isClosed* matches *\u0026lt;value\u0026gt;*. By contrast, a\nsearch that uses the same *\u0026lt;value\u0026gt;* without an operator will return\nall items where *\u0026lt;value\u0026gt;* matches the value of any\nString properties or text within the content field for the item.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"BooleanPropertyOptions": {
"description": "Options for boolean properties.",
"id": "BooleanPropertyOptions",
"properties": {
"operatorOptions": {
"$ref": "BooleanOperatorOptions",
"description": "If set, describes how the boolean should be used as a search operator."
}
},
"type": "object"
},
"CheckAccessResponse": {
"id": "CheckAccessResponse",
"properties": {
"hasAccess": {
"description": "Returns true if principal has access. Returns false otherwise.",
"type": "boolean"
}
},
"type": "object"
},
"CompositeFilter": {
"id": "CompositeFilter",
"properties": {
"logicOperator": {
"description": "The logic operator of the sub filter.",
"enum": [
"AND",
"OR",
"NOT"
],
"enumDescriptions": [
"Logical operators, which can only be applied to sub filters.",
"",
"NOT can only be applied on a single sub filter."
],
"type": "string"
},
"subFilters": {
"description": "Sub filters.",
"items": {
"$ref": "Filter"
},
"type": "array"
}
},
"type": "object"
},
"CustomerIndexStats": {
"description": "Aggregation of items by status code as of the specified date.",
"id": "CustomerIndexStats",
"properties": {
"date": {
"$ref": "Date",
"description": "Date for which statistics were calculated."
},
"itemCountByStatus": {
"description": "Number of items aggregrated by status code.",
"items": {
"$ref": "ItemCountByStatus"
},
"type": "array"
}
},
"type": "object"
},
"CustomerQueryStats": {
"id": "CustomerQueryStats",
"properties": {
"date": {
"$ref": "Date",
"description": "Date for which query stats were calculated. Stats calculated on the next\nday close to midnight are returned."
},
"queryCountByStatus": {
"items": {
"$ref": "QueryCountByStatus"
},
"type": "array"
}
},
"type": "object"
},
"CustomerSessionStats": {
"id": "CustomerSessionStats",
"properties": {
"date": {
"$ref": "Date",
"description": "Date for which session stats were calculated. Stats calculated on the next\nday close to midnight are returned."
},
"searchSessionsCount": {
"description": "The count of search sessions on the day",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"CustomerUserStats": {
"id": "CustomerUserStats",
"properties": {
"date": {
"$ref": "Date",
"description": "Date for which session stats were calculated. Stats calculated on the next\nday close to midnight are returned."
},
"oneDayActiveUsersCount": {
"description": "The count of unique active users in the past one day",
"format": "int64",
"type": "string"
},
"sevenDaysActiveUsersCount": {
"description": "The count of unique active users in the past seven days",
"format": "int64",
"type": "string"
},
"thirtyDaysActiveUsersCount": {
"description": "The count of unique active users in the past thirty days",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DataSource": {
"description": "Datasource is a logical namespace for items to be indexed.\nAll items must belong to a datasource. This is the prerequisite before\nitems can be indexed into Cloud Search.",
"id": "DataSource",
"properties": {
"disableModifications": {
"description": "If true, Indexing API rejects any modification calls to this datasource\nsuch as create, update, and delete.\nDisabling this does not imply halting process of previously\naccepted data.",
"type": "boolean"
},
"disableServing": {
"description": "Disable serving any search or assist results.",
"type": "boolean"
},
"displayName": {
"description": "Required. Display name of the datasource\nThe maximum length is 300 characters.",
"type": "string"
},
"indexingServiceAccounts": {
"description": "List of service accounts that have indexing access.",
"items": {
"type": "string"
},
"type": "array"
},
"itemsVisibility": {
"description": "This field restricts visibility to items at the datasource level. Items\nwithin the datasource are restricted to the union of users and groups\nincluded in this field. Note that, this does not ensure access to a\nspecific item, as users need to have ACL permissions on the contained\nitems. This ensures a high level access on the entire datasource, and\nthat the individual items are not shared outside this visibility.",
"items": {
"$ref": "GSuitePrincipal"
},
"type": "array"
},
"name": {
"description": "Name of the datasource resource.\nFormat: datasources/{source_id}.\n\u003cbr /\u003eThe name is ignored when creating a datasource.",
"type": "string"
},
"operationIds": {
"description": "IDs of the Long Running Operations (LROs) currently running for this\nschema.",
"items": {
"type": "string"
},
"type": "array"
},
"shortName": {
"description": "A short name or alias for the source. This value will be used to match the\n'source' operator. For example, if the short name is *\u0026lt;value\u0026gt;* then\nqueries like *source:\u0026lt;value\u0026gt;* will only return results for this\nsource. The value must be unique across all datasources. The value must\nonly contain alphanumeric characters (a-zA-Z0-9). The value cannot start\nwith 'google' and cannot be one of the following: mail, gmail, docs, drive,\ngroups, sites, calendar, hangouts, gplus, keep, people, teams.\nIts maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"DataSourceIndexStats": {
"description": "Aggregation of items by status code as of the specified date.",
"id": "DataSourceIndexStats",
"properties": {
"date": {
"$ref": "Date",
"description": "Date for which index stats were calculated. If the date of request is not\nthe current date then stats calculated on the next day are returned. Stats\nare calculated close to mid night in this case. If date of request is\ncurrent date, then real time stats are returned."
},
"itemCountByStatus": {
"description": "Number of items aggregrated by status code.",
"items": {
"$ref": "ItemCountByStatus"
},
"type": "array"
}
},
"type": "object"
},
"DataSourceRestriction": {
"description": "Restriction on Datasource.",
"id": "DataSourceRestriction",
"properties": {
"filterOptions": {
"description": "Filter options restricting the results. If multiple filters\nare present, they are grouped by object type before joining.\nFilters with the same object type are joined conjunctively, then\nthe resulting expressions are joined disjunctively.\n\nThe maximum number of elements is 20.\n\nNOTE: Suggest API supports only few filters at the moment:\n \"objecttype\", \"type\" and \"mimetype\".\nFor now, schema specific filters cannot be used to filter suggestions.",
"items": {
"$ref": "FilterOptions"
},
"type": "array"
},
"source": {
"$ref": "Source",
"description": "The source of restriction."
}
},
"type": "object"
},
"Date": {
"description": "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.",
"id": "Date",
"properties": {
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DateOperatorOptions": {
"description": "Optional. Provides a search operator for date properties.\nSearch operators let users restrict the query to specific fields relevant\nto the type of item being searched.",
"id": "DateOperatorOptions",
"properties": {
"greaterThanOperatorName": {
"description": "Indicates the operator name required in the query in order to isolate the\ndate property using the greater-than operator. For example, if\ngreaterThanOperatorName is *closedafter* and the property's name is\n*closeDate*, then queries like *closedafter:\u0026lt;value\u0026gt;* will\nshow results only where the value of the property named *closeDate* is\nlater than *\u0026lt;value\u0026gt;*.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
},
"lessThanOperatorName": {
"description": "Indicates the operator name required in the query in order to isolate the\ndate property using the less-than operator. For example, if\nlessThanOperatorName is *closedbefore* and the property's name is\n*closeDate*, then queries like *closedbefore:\u0026lt;value\u0026gt;* will\nshow results only where the value of the property named *closeDate* is\nearlier than *\u0026lt;value\u0026gt;*.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
},
"operatorName": {
"description": "Indicates the actual string required in the query in order to isolate the\ndate property. For example, suppose an issue tracking schema object\nhas a property named *closeDate* that specifies an operator with an\noperatorName of *closedon*. For searches on that data, queries like\n*closedon:\u0026lt;value\u0026gt;* will show results only where the value of the\n*closeDate* property matches *\u0026lt;value\u0026gt;*. By contrast, a\nsearch that uses the same *\u0026lt;value\u0026gt;* without an operator will return\nall items where *\u0026lt;value\u0026gt;* matches the value of any String\nproperties or text within the content field for the indexed datasource.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"DatePropertyOptions": {
"description": "Options for date properties.",
"id": "DatePropertyOptions",
"properties": {
"operatorOptions": {
"$ref": "DateOperatorOptions",
"description": "If set, describes how the date should be used as a search operator."
}
},
"type": "object"
},
"DateValues": {
"description": "List of date values.",
"id": "DateValues",
"properties": {
"values": {
"items": {
"$ref": "Date"
},
"type": "array"
}
},
"type": "object"
},
"DebugOptions": {
"description": "Shared request debug options for all cloudsearch RPC methods.",
"id": "DebugOptions",
"properties": {
"enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"type": "boolean"
}
},
"type": "object"
},
"DeleteQueueItemsRequest": {
"id": "DeleteQueueItemsRequest",
"properties": {
"connectorName": {
"description": "Name of connector making this call.\n\u003cbr /\u003eFormat: datasources/{source_id}/connectors/{ID}",
"type": "string"
},
"debugOptions": {
"$ref": "DebugOptions",
"description": "Common debug options."
},
"queue": {
"description": "Name of a queue to delete items from.",
"type": "string"
}
},
"type": "object"
},
"DisplayedProperty": {
"description": "A reference to a top-level property within the object that should be\ndisplayed in search results. The values of the chosen properties will be\ndisplayed in the search results along with the\ndislpay label\nfor that property if one is specified. If a display label is not specified,\nonly the values will be shown.",
"id": "DisplayedProperty",
"properties": {
"propertyName": {
"description": "The name of the top-level property as defined in a property definition\nfor the object. If the name is not a defined property in the schema, an\nerror will be given when attempting to update the schema.",
"type": "string"
}
},
"type": "object"
},
"DoubleOperatorOptions": {
"description": "Used to provide a search operator for double properties. This is\noptional. Search operators let users restrict the query to specific fields\nrelevant to the type of item being searched.",
"id": "DoubleOperatorOptions",
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to use the\ndouble property in sorting or as a facet.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"DoublePropertyOptions": {
"description": "Options for double properties.",
"id": "DoublePropertyOptions",
"properties": {
"operatorOptions": {
"$ref": "DoubleOperatorOptions",
"description": "If set, describes how the double should be used as a search operator."
}
},
"type": "object"
},
"DoubleValues": {
"description": "List of double values.",
"id": "DoubleValues",
"properties": {
"values": {
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"DriveFollowUpRestrict": {
"description": "Drive follow-up search restricts (e.g. \"followup:suggestions\").",
"id": "DriveFollowUpRestrict",
"properties": {
"type": {
"enum": [
"UNSPECIFIED",
"FOLLOWUP_SUGGESTIONS",
"FOLLOWUP_ACTION_ITEMS"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"DriveLocationRestrict": {
"description": "Drive location search restricts (e.g. \"is:starred\").",
"id": "DriveLocationRestrict",
"properties": {
"type": {
"enum": [
"UNSPECIFIED",
"TRASHED",
"STARRED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"DriveMimeTypeRestrict": {
"description": "Drive mime-type search restricts (e.g. \"type:pdf\").",
"id": "DriveMimeTypeRestrict",
"properties": {
"type": {
"enum": [
"UNSPECIFIED",
"PDF",
"DOCUMENT",
"PRESENTATION",
"SPREADSHEET",
"FORM",
"DRAWING",
"SCRIPT",
"MAP",
"IMAGE",
"AUDIO",
"VIDEO",
"FOLDER",
"ARCHIVE",
"SITE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"DriveTimeSpanRestrict": {
"description": "The time span search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").",
"id": "DriveTimeSpanRestrict",
"properties": {
"type": {
"enum": [
"UNSPECIFIED",
"TODAY",
"YESTERDAY",
"LAST_7_DAYS",
"LAST_30_DAYS",
"LAST_90_DAYS"
],
"enumDescriptions": [
"",
"",
"",
"",
"Not Enabled",
"Not Enabled"
],
"type": "string"
}
},
"type": "object"
},
"EmailAddress": {
"description": "A person's email address.",
"id": "EmailAddress",
"properties": {
"emailAddress": {
"description": "The email address.",
"type": "string"
}
},
"type": "object"
},
"EnumOperatorOptions": {
"description": "Used to provide a search operator for enum properties. This is\noptional. Search operators let users restrict the query to specific fields\nrelevant to the type of item being searched. For example, if you provide no\noperator for a *priority* enum property with possible values *p0* and *p1*,\na query that contains the term *p0* will return items that have *p0* as the\nvalue of the *priority* property, as well as any items that contain the\nstring *p0* in other fields. If you provide an operator name for the enum,\nsuch as *priority*, then search users can use that operator to refine\nresults to only items that have *p0* as this property's value, with the\nquery *priority:p0*.",
"id": "EnumOperatorOptions",
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to isolate the\nenum property. For example, if operatorName is *priority* and the\nproperty's name is *priorityVal*, then queries like\n*priority:\u0026lt;value\u0026gt;* will show results only where the value of the\nproperty named *priorityVal* matches *\u0026lt;value\u0026gt;*. By contrast, a\nsearch that uses the same *\u0026lt;value\u0026gt;* without an operator will return\nall items where *\u0026lt;value\u0026gt;* matches the value of any String\nproperties or text within the content field for the item.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"EnumPropertyOptions": {
"description": "Options for enum properties, which allow you to define a restricted set of\nstrings to match user queries, set rankings for those string values, and\ndefine an operator name to be paired with those strings so that users can\nnarrow results to only items with a specific value. For example, for items in\na request tracking system with priority information, you could define *p0* as\nan allowable enum value and tie this enum to the operator name *priority* so\nthat search users could add *priority:p0* to their query to restrict the set\nof results to only those items indexed with the value *p0*.",
"id": "EnumPropertyOptions",
"properties": {
"operatorOptions": {
"$ref": "EnumOperatorOptions",
"description": "If set, describes how the enum should be used as a search operator."
},
"orderedRanking": {
"description": "Used to specify the ordered ranking for the enumeration that determines how\nthe integer values provided in the possible EnumValuePairs are used to rank\nresults. If specified, integer values must be provided for all possible\nEnumValuePair values given for this property. Can only be used if\nisRepeatable\nis false.",
"enum": [
"NO_ORDER",
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"There is no ranking order for the property. Results will not be adjusted\nby this property's value.",
"This property is ranked in ascending order. Lower values indicate lower\nranking.",
"This property is ranked in descending order. Lower values indicate\nhigher ranking."
],
"type": "string"
},
"possibleValues": {
"description": "The list of possible values for the enumeration property. All\nEnumValuePairs must provide a string value. If you specify an integer value\nfor one EnumValuePair, then all possible EnumValuePairs must provide an\ninteger value. Both the string value and integer value must be unique over\nall possible values. Once set, possible values cannot be removed or\nmodified. If you supply an ordered ranking and think you might insert\nadditional enum values in the future, leave gaps in the initial integer\nvalues to allow adding a value in between previously registered values.\nThe maximum number of elements is 100.",
"items": {
"$ref": "EnumValuePair"
},
"type": "array"
}
},
"type": "object"
},
"EnumValuePair": {
"description": "The enumeration value pair defines two things: a required string value and\nan optional integer value. The string value defines the necessary query\nterm required to retrieve that item, such as *p0* for a priority item.\nThe integer value determines the ranking of that string value relative\nto other enumerated values for the same property. For example, you might\nassociate *p0* with *0* and define another enum pair such as *p1* and *1*.\nYou must use the integer value in combination with\nordered\nranking to\nset the ranking of a given value relative to other enumerated values for\nthe same property name. Here, a ranking order of DESCENDING for *priority*\nproperties results in a ranking boost for items indexed with a value of\n*p0* compared to items indexed with a value of *p1*. Without a specified\nranking order, the integer value has no effect on item ranking.",
"id": "EnumValuePair",
"properties": {
"integerValue": {
"description": "The integer value of the EnumValuePair which must be non-negative.\nOptional.",
"format": "int32",
"type": "integer"
},
"stringValue": {
"description": "The string value of the EnumValuePair.\nThe maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"EnumValues": {
"description": "List of enum values.",
"id": "EnumValues",
"properties": {
"values": {
"description": "The maximum allowable length for string values is 32 characters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ErrorInfo": {
"description": "Error information about the response.",
"id": "ErrorInfo",
"properties": {
"errorMessages": {
"items": {
"$ref": "ErrorMessage"
},
"type": "array"
}
},
"type": "object"
},
"ErrorMessage": {
"description": "Error message per source response.",
"id": "ErrorMessage",
"properties": {
"errorMessage": {
"type": "string"
},
"source": {
"$ref": "Source"
}
},
"type": "object"
},
"FacetBucket": {
"description": "A bucket in a facet is the basic unit of operation. A bucket can comprise\neither a single value OR a contiguous range of values, depending on the\ntype of the field bucketed.\nFacetBucket is currently used only for returning the response object.",
"id": "FacetBucket",
"properties": {
"count": {
"description": "Number of results that match the bucket value. Counts are only returned\nfor searches when count accuracy is ensured. Can be empty.",
"format": "int32",
"type": "integer"
},
"percentage": {
"description": "Percent of results that match the bucket value. This value is between\n(0-100]. Percentages are returned for all searches, but are an estimate.\nBecause percentages are always returned, you should render percentages\ninstead of counts.",
"format": "int32",
"type": "integer"
},
"value": {
"$ref": "Value"
}
},
"type": "object"
},
"FacetOptions": {
"description": "Specifies operators to return facet results for. There will be one\nFacetResult for every source_name/object_type/operator_name combination.",
"id": "FacetOptions",
"properties": {
"numFacetBuckets": {
"description": "Maximum number of facet buckets that should be returned for this facet.\nDefaults to 10.\nMaximum value is 100.",
"format": "int32",
"type": "integer"
},
"objectType": {
"description": "If object_type is set, only those objects of that type will be used to\ncompute facets. If empty, then all objects will be used to compute facets.",
"type": "string"
},
"operatorName": {
"description": "Name of the operator chosen for faceting. @see\ncloudsearch.SchemaPropertyOptions",
"type": "string"
},
"sourceName": {
"description": "Source name to facet on. Format: datasources/{source_id}\nIf empty, all data sources will be used.",
"type": "string"
}
},
"type": "object"
},
"FacetResult": {
"description": "Source specific facet response",
"id": "FacetResult",
"properties": {
"buckets": {
"description": "FacetBuckets for values in response containing at least a single result.",
"items": {
"$ref": "FacetBucket"
},
"type": "array"
},
"objectType": {
"description": "Object type for which facet results are returned. Can be empty.",
"type": "string"
},
"operatorName": {
"description": "Name of the operator chosen for faceting. @see\ncloudsearch.SchemaPropertyOptions",
"type": "string"
},
"sourceName": {
"description": "Source name for which facet results are returned. Will not be empty.",
"type": "string"
}
},
"type": "object"
},
"FieldViolation": {
"id": "FieldViolation",
"properties": {
"description": {
"description": "Description of the error.",
"type": "string"
},
"field": {
"description": "Path of field with violation.",
"type": "string"
}
},
"type": "object"
},
"Filter": {
"description": "A generic way of expressing filters in a query, which supports two\napproaches: \u003cbr/\u003e\u003cbr/\u003e\n**1. Setting a ValueFilter.** The name must match an operator_name defined in\nthe schema for your data source.\n\u003cbr/\u003e\n**2. Setting a CompositeFilter.** The filters are evaluated\nusing the logical operator. The top-level operators can only be either an AND\nor a NOT. AND can appear only at the top-most level. OR can appear only under\na top-level AND.",
"id": "Filter",
"properties": {
"compositeFilter": {
"$ref": "CompositeFilter"
},
"valueFilter": {
"$ref": "ValueFilter"
}
},
"type": "object"
},
"FilterOptions": {
"description": "Filter options to be applied on query.",
"id": "FilterOptions",
"properties": {
"filter": {
"$ref": "Filter",
"description": "Generic filter to restrict the search, such as `lang:en`, `site:xyz`."
},
"objectType": {
"description": "If object_type is set, only objects of that type are returned. This should\ncorrespond to the name of the object that was registered within the\ndefinition of schema. The maximum length is 256 characters.",
"type": "string"
}
},
"type": "object"
},
"FreshnessOptions": {
"description": "Indicates which freshness property to use when adjusting search ranking for\nan item. Fresher, more recent dates indicate higher quality. Use the\nfreshness option property that best works with your data. For fileshare\ndocuments, last modified time is most relevant. For calendar event data,\nthe time when the event occurs is a more relevant freshness indicator. In\nthis way, calendar events that occur closer to the time of the search query\nare considered higher quality and ranked accordingly.",
"id": "FreshnessOptions",
"properties": {
"freshnessDuration": {
"description": "The duration after which an object should be considered\nstale. The default value is 180 days (in seconds).",
"format": "google-duration",
"type": "string"
},
"freshnessProperty": {
"description": "This property indicates the freshness level of the object in the index.\nIf set, this property must be a top-level property within the\nproperty definitions\nand it must be a\ntimestamp type\nor\ndate type.\nOtherwise, the Indexing API uses\nupdateTime\nas the freshness indicator.\nThe maximum length is 256 characters.\n\nWhen a property is used to calculate fresheness, the value defaults\nto 2 years from the current time.",
"type": "string"
}
},
"type": "object"
},
"GSuitePrincipal": {
"id": "GSuitePrincipal",
"properties": {
"gsuiteDomain": {
"description": "This principal represents all users of the G Suite domain of the\ncustomer.",
"type": "boolean"
},
"gsuiteGroupEmail": {
"description": "This principal references a G Suite group account",
"type": "string"
},
"gsuiteUserEmail": {
"description": "This principal references a G Suite user account",
"type": "string"
}
},
"type": "object"
},
"GetCustomerIndexStatsResponse": {
"id": "GetCustomerIndexStatsResponse",
"properties": {
"stats": {
"description": "Summary of indexed item counts, one for each day in the requested range.",
"items": {
"$ref": "CustomerIndexStats"
},
"type": "array"
}
},
"type": "object"
},
"GetCustomerQueryStatsResponse": {
"id": "GetCustomerQueryStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "CustomerQueryStats"
},
"type": "array"
}
},
"type": "object"
},
"GetCustomerSessionStatsResponse": {
"id": "GetCustomerSessionStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "CustomerSessionStats"
},
"type": "array"
}
},
"type": "object"
},
"GetCustomerUserStatsResponse": {
"id": "GetCustomerUserStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "CustomerUserStats"
},
"type": "array"
}
},
"type": "object"
},
"GetDataSourceIndexStatsResponse": {
"id": "GetDataSourceIndexStatsResponse",
"properties": {
"stats": {
"description": "Summary of indexed item counts, one for each day in the requested range.",
"items": {
"$ref": "DataSourceIndexStats"
},
"type": "array"
}
},
"type": "object"
},
"GetSearchApplicationQueryStatsResponse": {
"id": "GetSearchApplicationQueryStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "SearchApplicationQueryStats"
},
"type": "array"
}
},
"type": "object"
},
"GetSearchApplicationSessionStatsResponse": {
"id": "GetSearchApplicationSessionStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "SearchApplicationSessionStats"
},
"type": "array"
}
},
"type": "object"
},
"GetSearchApplicationUserStatsResponse": {
"id": "GetSearchApplicationUserStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "SearchApplicationUserStats"
},
"type": "array"
}
},
"type": "object"
},
"HtmlOperatorOptions": {
"description": "Used to provide a search operator for html properties. This is optional.\nSearch operators let users restrict the query to specific fields relevant\nto the type of item being searched.",
"id": "HtmlOperatorOptions",
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to isolate the\nhtml property. For example, if operatorName is *subject* and the\nproperty's name is *subjectLine*, then queries like\n*subject:\u0026lt;value\u0026gt;* will show results only where the value of the\nproperty named *subjectLine* matches *\u0026lt;value\u0026gt;*. By contrast, a\nsearch that uses the same *\u0026lt;value\u0026gt;* without an operator will return\nall items where *\u0026lt;value\u0026gt;* matches the value of any\nhtml properties or text within the content field for the item.\nThe operator name can only contain lowercase letters (a-z).\nThe maximum length is 32 characters.",
"type": "string"
}
},
"type": "object"
},
"HtmlPropertyOptions": {
"description": "Options for html properties.",
"id": "HtmlPropertyOptions",
"properties": {
"operatorOptions": {
"$ref": "HtmlOperatorOptions",
"description": "If set, describes how the property should be used as a search operator."
},
"retrievalImportance": {
"$ref": "RetrievalImportance",
"description": "Indicates the search quality importance of the tokens within the\nfield when used for retrieval. Can only be set to DEFAULT or NONE."
}
},
"type": "object"
},
"HtmlValues": {
"description": "List of html values.",
"id": "HtmlValues",
"properties": {
"values": {
"description": "The maximum allowable length for html values is 2048 characters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IndexItemOptions": {
"id": "IndexItemOptions",
"properties": {