Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / cloudsearch.v1.json
blob: ec4d6ac3d3d6c9255d23d113f6d126cb3b749535 [file] [log] [blame] [edit]
{
"fullyEncodeReservedExpansion": true,
"schemas": {
"ResultDisplayField": {
"id": "ResultDisplayField",
"properties": {
"operatorName": {
"type": "string",
"description": "The operator name of the property."
},
"property": {
"description": "The name value pair for the property.",
"$ref": "NamedProperty"
},
"label": {
"type": "string",
"description": "The display label for the property."
}
},
"type": "object",
"description": "Display Fields for Search Results"
},
"DebugOptions": {
"description": "Shared request debug options for all cloudsearch RPC methods.",
"properties": {
"enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"type": "boolean"
}
},
"id": "DebugOptions",
"type": "object"
},
"SourceScoringConfig": {
"description": "Set the scoring configuration. This allows modifying the ranking of results for a source.",
"id": "SourceScoringConfig",
"type": "object",
"properties": {
"sourceImportance": {
"type": "string",
"description": "Importance of the source.",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"DEFAULT",
"LOW",
"HIGH"
]
}
}
},
"TextValues": {
"type": "object",
"properties": {
"values": {
"description": "The maximum allowable length for text values is 2048 characters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TextValues",
"description": "List of text values."
},
"IntegerPropertyOptions": {
"id": "IntegerPropertyOptions",
"description": "Options for integer properties.",
"properties": {
"maximumValue": {
"type": "string",
"description": "The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.",
"format": "int64"
},
"orderedRanking": {
"type": "string",
"enumDescriptions": [
"There is no ranking order for the property. Results are not adjusted by this property's value.",
"This property is ranked in ascending order. Lower values indicate lower ranking.",
"This property is ranked in descending order. Lower values indicate higher ranking."
],
"description": "Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.",
"enum": [
"NO_ORDER",
"ASCENDING",
"DESCENDING"
]
},
"operatorOptions": {
"description": "If set, describes how the integer should be used as a search operator.",
"$ref": "IntegerOperatorOptions"
},
"minimumValue": {
"description": "The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"SuggestRequest": {
"id": "SuggestRequest",
"description": "Request of suggest API.",
"properties": {
"query": {
"description": "Partial query for which autocomplete suggestions will be shown. For example, if the query is \"sea\", then the server might return \"season\", \"search\", \"seagull\" and so on.",
"type": "string"
},
"requestOptions": {
"description": "Request options, such as the search application and user timezone.",
"$ref": "RequestOptions"
},
"dataSourceRestrictions": {
"type": "array",
"description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are supported only for third party data sources and people (i.e. PredefinedSource.PERSON).",
"items": {
"$ref": "DataSourceRestriction"
}
}
},
"type": "object"
},
"GSuitePrincipal": {
"type": "object",
"id": "GSuitePrincipal",
"properties": {
"gsuiteDomain": {
"type": "boolean",
"description": "This principal represents all users of the G Suite domain of the customer."
},
"gsuiteGroupEmail": {
"type": "string",
"description": "This principal references a G Suite group account"
},
"gsuiteUserEmail": {
"type": "string",
"description": "This principal references a G Suite user account"
}
}
},
"ResponseDebugInfo": {
"properties": {
"formattedDebugInfo": {
"description": "General debug info formatted for display.",
"type": "string"
}
},
"id": "ResponseDebugInfo",
"type": "object",
"description": "Debugging information about the response."
},
"SearchApplicationUserStats": {
"id": "SearchApplicationUserStats",
"type": "object",
"properties": {
"thirtyDaysActiveUsersCount": {
"description": "The count of unique active users in the past thirty days",
"type": "string",
"format": "int64"
},
"oneDayActiveUsersCount": {
"description": "The count of unique active users in the past one day",
"type": "string",
"format": "int64"
},
"sevenDaysActiveUsersCount": {
"format": "int64",
"description": "The count of unique active users in the past seven days",
"type": "string"
},
"date": {
"$ref": "Date",
"description": "Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned."
}
}
},
"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"
},
"SourceConfig": {
"id": "SourceConfig",
"properties": {
"scoringConfig": {
"$ref": "SourceScoringConfig",
"description": "The scoring configuration for the source."
},
"source": {
"description": "The source for which this configuration is to be used.",
"$ref": "Source"
},
"crowdingConfig": {
"description": "The crowding configuration for the source.",
"$ref": "SourceCrowdingConfig"
}
},
"description": "Configurations for a source while processing a Search or Suggest request.",
"type": "object"
},
"ResetSearchApplicationRequest": {
"type": "object",
"properties": {
"debugOptions": {
"description": "Common debug options.",
"$ref": "DebugOptions"
}
},
"id": "ResetSearchApplicationRequest"
},
"PushItem": {
"description": "Represents an item to be pushed to the indexing queue.",
"type": "object",
"id": "PushItem",
"properties": {
"type": {
"description": "The type of the push operation that defines the push behavior.",
"enum": [
"UNSPECIFIED",
"MODIFIED",
"NOT_MODIFIED",
"REPOSITORY_ERROR",
"REQUEUE"
],
"type": "string",
"enumDescriptions": [
"Default UNSPECIFIED. Specifies that the push operation should not modify ItemStatus",
"Indicates that the repository document has been modified or updated since the previous update call. This changes status to MODIFIED state for an existing item. If this is called on a non existing item, the status is changed to NEW_ITEM.",
"Item in the repository has not been modified since the last update call. This push operation will set status to ACCEPTED state.",
"Connector is facing a repository error regarding this item. Change status to REPOSITORY_ERROR state. Item is unreserved and rescheduled at a future time determined by exponential backoff.",
"Call push with REQUEUE only for items that have been reserved. This action unreserves the item and resets its available time to the wall clock time."
]
},
"queue": {
"description": "Queue to which this item belongs to. The default queue is chosen if this field is not specified. The maximum length is 512 characters.",
"type": "string"
},
"contentHash": {
"description": "Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.",
"type": "string"
},
"repositoryError": {
"description": "Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR.",
"$ref": "RepositoryError"
},
"metadataHash": {
"description": "Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.",
"type": "string"
},
"structuredDataHash": {
"type": "string",
"description": "Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters."
},
"payload": {
"description": "Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.",
"format": "byte",
"type": "string"
}
}
},
"MatchRange": {
"properties": {
"end": {
"type": "integer",
"description": "End of the match in the snippet.",
"format": "int32"
},
"start": {
"description": "Starting position of the match in the snippet.",
"type": "integer",
"format": "int32"
}
},
"description": "Matched range of a snippet [start, end).",
"id": "MatchRange",
"type": "object"
},
"CustomerQueryStats": {
"id": "CustomerQueryStats",
"type": "object",
"properties": {
"queryCountByStatus": {
"items": {
"$ref": "QueryCountByStatus"
},
"type": "array"
},
"date": {
"$ref": "Date",
"description": "Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned."
}
}
},
"PollItemsRequest": {
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"description": "Maximum number of items to return. The maximum value is 100 and the default value is 20."
},
"debugOptions": {
"$ref": "DebugOptions",
"description": "Common debug options."
},
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"type": "string"
},
"queue": {
"description": "Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.",
"type": "string"
},
"statusCodes": {
"type": "array",
"items": {
"enumDescriptions": [
"Input-only value. Used with Items.list to list all items in the queue, regardless of status.",
"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.",
"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.",
"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.",
"API has accepted the up-to-date data of this item."
],
"type": "string",
"enum": [
"CODE_UNSPECIFIED",
"ERROR",
"MODIFIED",
"NEW_ITEM",
"ACCEPTED"
]
},
"description": "Limit the items polled to the ones with these statuses."
}
},
"type": "object",
"id": "PollItemsRequest"
},
"FacetBucket": {
"properties": {
"count": {
"type": "integer",
"format": "int32",
"description": "Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty."
},
"percentage": {
"type": "integer",
"description": "Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.",
"format": "int32"
},
"value": {
"$ref": "Value"
}
},
"type": "object",
"description": "A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.",
"id": "FacetBucket"
},
"ItemMetadata": {
"description": "Available metadata fields for the item.",
"type": "object",
"properties": {
"keywords": {
"description": "Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"interactions": {
"items": {
"$ref": "Interaction"
},
"type": "array",
"description": "A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000."
},
"hash": {
"type": "string",
"description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters."
},
"sourceRepositoryUrl": {
"type": "string",
"description": "Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters."
},
"createTime": {
"format": "google-datetime",
"description": "The time when the item was created in the source repository.",
"type": "string"
},
"contentLanguage": {
"type": "string",
"description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters."
},
"title": {
"type": "string",
"description": "The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters."
},
"searchQualityMetadata": {
"description": "Additional search quality metadata of the item",
"$ref": "SearchQualityMetadata"
},
"objectType": {
"description": "The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.",
"type": "string"
},
"mimeType": {
"description": "The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.",
"type": "string"
},
"updateTime": {
"description": "The time when the item was last modified in the source repository.",
"type": "string",
"format": "google-datetime"
},
"containerName": {
"type": "string",
"description": "The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters."
}
},
"id": "ItemMetadata"
},
"QueryInterpretationOptions": {
"type": "object",
"id": "QueryInterpretationOptions",
"properties": {
"disableNlInterpretation": {
"description": "Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.",
"type": "boolean"
},
"enableVerbatimMode": {
"type": "boolean",
"description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true."
}
},
"description": "Options to interpret user query."
},
"SearchApplicationQueryStats": {
"type": "object",
"id": "SearchApplicationQueryStats",
"properties": {
"date": {
"description": "Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.",
"$ref": "Date"
},
"queryCountByStatus": {
"type": "array",
"items": {
"$ref": "QueryCountByStatus"
}
}
}
},
"BooleanPropertyOptions": {
"type": "object",
"properties": {
"operatorOptions": {
"$ref": "BooleanOperatorOptions",
"description": "If set, describes how the boolean should be used as a search operator."
}
},
"id": "BooleanPropertyOptions",
"description": "Options for boolean properties."
},
"PropertyDisplayOptions": {
"properties": {
"displayLabel": {
"description": "The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters.",
"type": "string"
}
},
"description": "The display options for a property.",
"type": "object",
"id": "PropertyDisplayOptions"
},
"TimestampPropertyOptions": {
"type": "object",
"id": "TimestampPropertyOptions",
"properties": {
"operatorOptions": {
"$ref": "TimestampOperatorOptions",
"description": "If set, describes how the timestamp should be used as a search operator."
}
},
"description": "Options for timestamp properties."
},
"ObjectOptions": {
"type": "object",
"description": "The options for an object.",
"id": "ObjectOptions",
"properties": {
"displayOptions": {
"description": "Options that determine how the object is displayed in the Cloud Search results page.",
"$ref": "ObjectDisplayOptions"
},
"freshnessOptions": {
"description": "The freshness options for an object.",
"$ref": "FreshnessOptions"
}
}
},
"ErrorMessage": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string"
},
"source": {
"$ref": "Source"
}
},
"description": "Error message per source response.",
"id": "ErrorMessage"
},
"GetSearchApplicationSessionStatsResponse": {
"properties": {
"stats": {
"type": "array",
"items": {
"$ref": "SearchApplicationSessionStats"
}
}
},
"id": "GetSearchApplicationSessionStatsResponse",
"type": "object"
},
"DoubleOperatorOptions": {
"type": "object",
"id": "DoubleOperatorOptions",
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.",
"type": "string"
}
},
"description": "Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched."
},
"RestrictItem": {
"id": "RestrictItem",
"properties": {
"searchOperator": {
"type": "string",
"description": "The search restrict (e.g. \"after:2017-09-11 before:2017-09-12\")."
},
"driveFollowUpRestrict": {
"description": "LINT.ThenChange(//depot/google3/java/com/google/apps/search/quality/itemsuggest/utils/SubtypeRerankingUtils.java)",
"$ref": "DriveFollowUpRestrict"
},
"driveTimeSpanRestrict": {
"$ref": "DriveTimeSpanRestrict"
},
"driveMimeTypeRestrict": {
"description": "LINT.IfChange Drive Types.",
"$ref": "DriveMimeTypeRestrict"
},
"driveLocationRestrict": {
"$ref": "DriveLocationRestrict"
}
},
"description": "Information relevant only to a restrict entry. NextId: 12",
"type": "object"
},
"GetSearchApplicationUserStatsResponse": {
"type": "object",
"id": "GetSearchApplicationUserStatsResponse",
"properties": {
"stats": {
"items": {
"$ref": "SearchApplicationUserStats"
},
"type": "array"
}
}
},
"GetCustomerIndexStatsResponse": {
"properties": {
"stats": {
"description": "Summary of indexed item counts, one for each day in the requested range.",
"type": "array",
"items": {
"$ref": "CustomerIndexStats"
}
}
},
"type": "object",
"id": "GetCustomerIndexStatsResponse"
},
"ListQuerySourcesResponse": {
"description": "List sources response.",
"type": "object",
"id": "ListQuerySourcesResponse",
"properties": {
"nextPageToken": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"$ref": "QuerySource"
}
}
}
},
"ObjectValues": {
"properties": {
"values": {
"items": {
"$ref": "StructuredDataObject"
},
"type": "array"
}
},
"type": "object",
"id": "ObjectValues",
"description": "List of object values."
},
"UploadItemRef": {
"type": "object",
"description": "Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef.",
"id": "UploadItemRef",
"properties": {
"name": {
"type": "string",
"description": "Name of the content reference. The maximum length is 2048 characters."
}
}
},
"IndexItemOptions": {
"id": "IndexItemOptions",
"properties": {
"allowUnknownGsuitePrincipals": {
"type": "boolean",
"description": "Specifies if the index request should allow gsuite principals that do not exist or are deleted in the index request."
}
},
"type": "object"
},
"IndexItemRequest": {
"type": "object",
"id": "IndexItemRequest",
"properties": {
"indexItemOptions": {
"$ref": "IndexItemOptions"
},
"debugOptions": {
"description": "Common debug options.",
"$ref": "DebugOptions"
},
"connectorName": {
"type": "string",
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}"
},
"mode": {
"enumDescriptions": [
"Priority is not specified in the update request. Leaving priority unspecified results in an update failure.",
"For real-time updates.",
"For changes that are executed after the response is sent back to the caller."
],
"enum": [
"UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"description": "Required. The RequestMode for this request.",
"type": "string"
},
"item": {
"$ref": "Item",
"description": "Name of the item. Format: datasources/{source_id}/items/{item_id}"
}
}
},
"DoublePropertyOptions": {
"id": "DoublePropertyOptions",
"description": "Options for double properties.",
"type": "object",
"properties": {
"operatorOptions": {
"$ref": "DoubleOperatorOptions",
"description": "If set, describes how the double should be used as a search operator."
}
}
},
"BooleanOperatorOptions": {
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to isolate the boolean property. For example, if operatorName is *closed* and the property's name is *isClosed*, then queries like *closed:\u003cvalue\u003e* show results only where the value of the property named *isClosed* matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator returns all items where *\u003cvalue\u003e* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.",
"type": "string"
}
},
"type": "object",
"description": "Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
"id": "BooleanOperatorOptions"
},
"ScoringConfig": {
"type": "object",
"id": "ScoringConfig",
"description": "Scoring configurations for a source while processing a Search or Suggest request.",
"properties": {
"disablePersonalization": {
"type": "boolean",
"description": "Whether to personalize the results. By default, personal signals will be used to boost results."
},
"disableFreshness": {
"description": "Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.",
"type": "boolean"
}
}
},
"CustomerIndexStats": {
"type": "object",
"description": "Aggregation of items by status code as of the specified date.",
"properties": {
"itemCountByStatus": {
"type": "array",
"items": {
"$ref": "ItemCountByStatus"
},
"description": "Number of items aggregrated by status code."
},
"date": {
"description": "Date for which statistics were calculated.",
"$ref": "Date"
}
},
"id": "CustomerIndexStats"
},
"RequestOptions": {
"description": "Shared request options for all RPC methods.",
"id": "RequestOptions",
"properties": {
"debugOptions": {
"description": "Debug options of the request",
"$ref": "DebugOptions"
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.",
"type": "string"
},
"searchApplicationId": {
"description": "The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).",
"type": "string"
},
"timeZone": {
"type": "string",
"description": "Current user's time zone id, such as \"America/Los_Angeles\" or \"Australia/Sydney\". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used."
}
},
"type": "object"
},
"ValueFilter": {
"properties": {
"value": {
"description": "The value to be compared with.",
"$ref": "Value"
},
"operatorName": {
"description": "The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.",
"type": "string"
}
},
"type": "object",
"id": "ValueFilter"
},
"Status": {
"id": "Status",
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"code": {
"type": "integer",
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code."
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
},
"type": "array"
}
},
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"type": "object"
},
"Person": {
"id": "Person",
"type": "object",
"description": "Object to represent a person.",
"properties": {
"photos": {
"type": "array",
"description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.",
"items": {
"$ref": "Photo"
}
},
"emailAddresses": {
"description": "The person's email addresses",
"type": "array",
"items": {
"$ref": "EmailAddress"
}
},
"obfuscatedId": {
"type": "string",
"description": "Obfuscated ID of a person."
},
"name": {
"description": "The resource name of the person to provide information about. See People.get from Google People API.",
"type": "string"
},
"personNames": {
"items": {
"$ref": "Name"
},
"description": "The person's name",
"type": "array"
}
}
},
"Interaction": {
"properties": {
"principal": {
"$ref": "Principal",
"description": "The user that acted on the item."
},
"type": {
"enumDescriptions": [
"Invalid value.",
"This interaction indicates the user viewed the item.",
"This interaction indicates the user edited the item."
],
"enum": [
"UNSPECIFIED",
"VIEW",
"EDIT"
],
"type": "string"
},
"interactionTime": {
"description": "The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.",
"type": "string",
"format": "google-datetime"
}
},
"id": "Interaction",
"type": "object",
"description": "Represents an interaction between a user and an item."
},
"GetCustomerSessionStatsResponse": {
"id": "GetCustomerSessionStatsResponse",
"properties": {
"stats": {
"type": "array",
"items": {
"$ref": "CustomerSessionStats"
}
}
},
"type": "object"
},
"SearchQualityMetadata": {
"description": "Additional search quality metadata of the item.",
"id": "SearchQualityMetadata",
"properties": {
"quality": {
"type": "number",
"format": "double",
"description": "An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0."
}
},
"type": "object"
},
"FacetOptions": {
"type": "object",
"id": "FacetOptions",
"description": "Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.",
"properties": {
"operatorName": {
"description": "Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions",
"type": "string"
},
"objectType": {
"description": "If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.",
"type": "string"
},
"sourceName": {
"type": "string",
"description": "Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used."
},
"numFacetBuckets": {
"description": "Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.",
"format": "int32",
"type": "integer"
}
}
},
"Metadata": {
"type": "object",
"description": "Metadata of a matched search result.",
"properties": {
"objectType": {
"description": "Object type of the search result.",
"type": "string"
},
"fields": {
"items": {
"$ref": "NamedProperty"
},
"type": "array",
"description": "Indexed fields in structured data, returned as a generic named property."
},
"updateTime": {
"type": "string",
"format": "google-datetime",
"description": "The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time."
},
"owner": {
"$ref": "Person",
"description": "Owner (usually creator) of the document or object of the search result."
},
"source": {
"description": "The named source for the result, such as Gmail.",
"$ref": "Source"
},
"createTime": {
"description": "The creation time for this document or object in the search result.",
"format": "google-datetime",
"type": "string"
},
"mimeType": {
"description": "Mime type of the search result.",
"type": "string"
},
"displayOptions": {
"$ref": "ResultDisplayMetadata",
"description": "Options that specify how to display a structured data search result."
}
},
"id": "Metadata"
},
"StructuredResult": {
"type": "object",
"properties": {
"person": {
"description": "Representation of a person",
"$ref": "Person"
}
},
"id": "StructuredResult",
"description": "Structured results that are returned as part of search request."
},
"NamedProperty": {
"properties": {
"integerValues": {
"$ref": "IntegerValues"
},
"name": {
"type": "string",
"description": "The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters."
},
"dateValues": {
"$ref": "DateValues"
},
"enumValues": {
"$ref": "EnumValues"
},
"htmlValues": {
"$ref": "HtmlValues"
},
"objectValues": {
"$ref": "ObjectValues"
},
"booleanValue": {
"type": "boolean"
},
"timestampValues": {
"$ref": "TimestampValues"
},
"textValues": {
"$ref": "TextValues"
},
"doubleValues": {
"$ref": "DoubleValues"
}
},
"description": "A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.",
"id": "NamedProperty",
"type": "object"
},
"ListUnmappedIdentitiesResponse": {
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unmappedIdentities": {
"items": {
"$ref": "UnmappedIdentity"
},
"type": "array"
}
},
"id": "ListUnmappedIdentitiesResponse",
"type": "object"
},
"StructuredDataObject": {
"type": "object",
"id": "StructuredDataObject",
"properties": {
"properties": {
"items": {
"$ref": "NamedProperty"
},
"type": "array",
"description": "The properties for the object. The maximum number of elements is 1000."
}
},
"description": "A structured data object consisting of named properties."
},
"TimestampOperatorOptions": {
"id": "TimestampOperatorOptions",
"type": "object",
"properties": {
"operatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the timestamp property. For example, if operatorName is *closedon* and the property's name is *closeDate*, then queries like *closedon:\u003cvalue\u003e* show results only where the value of the property named *closeDate* matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator returns all items where *\u003cvalue\u003e* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
},
"lessThanOperatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the timestamp property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:\u003cvalue\u003e* show results only where the value of the property named *closeDate* is earlier than *\u003cvalue\u003e*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
},
"greaterThanOperatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the timestamp property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:\u003cvalue\u003e* show results only where the value of the property named *closeDate* is later than *\u003cvalue\u003e*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
}
},
"description": "Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched."
},
"UpdateSchemaRequest": {
"id": "UpdateSchemaRequest",
"properties": {
"schema": {
"description": "The new schema for the source.",
"$ref": "Schema"
},
"validateOnly": {
"type": "boolean",
"description": "If true, the schema will be checked for validity, but will not be registered with the data source, even if valid."
},
"debugOptions": {
"description": "Common debug options.",
"$ref": "DebugOptions"
}
},
"type": "object"
},
"Value": {
"description": "Definition of a single value with generic type.",
"type": "object",
"id": "Value",
"properties": {
"dateValue": {
"$ref": "Date"
},
"integerValue": {
"format": "int64",
"type": "string"
},
"timestampValue": {
"format": "google-datetime",
"type": "string"
},
"stringValue": {
"type": "string"
},
"doubleValue": {
"type": "number",
"format": "double"
},
"booleanValue": {
"type": "boolean"
}
}
},
"ListSearchApplicationsResponse": {
"type": "object",
"id": "ListSearchApplicationsResponse",
"properties": {
"searchApplications": {
"type": "array",
"items": {
"$ref": "SearchApplication"
}
},
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
}
}
},
"CustomerSessionStats": {
"properties": {
"searchSessionsCount": {
"type": "string",
"format": "int64",
"description": "The count of search sessions on the day"
},
"date": {
"description": "Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.",
"$ref": "Date"
}
},
"type": "object",
"id": "CustomerSessionStats"
},
"GetDataSourceIndexStatsResponse": {
"properties": {
"stats": {
"type": "array",
"items": {
"$ref": "DataSourceIndexStats"
},
"description": "Summary of indexed item counts, one for each day in the requested range."
}
},
"type": "object",
"id": "GetDataSourceIndexStatsResponse"
},
"EnumPropertyOptions": {
"type": "object",
"description": "Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.",
"id": "EnumPropertyOptions",
"properties": {
"orderedRanking": {
"description": "Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.",
"enum": [
"NO_ORDER",
"ASCENDING",
"DESCENDING"
],
"type": "string",
"enumDescriptions": [
"There is no ranking order for the property. Results aren't adjusted by this property's value.",
"This property is ranked in ascending order. Lower values indicate lower ranking.",
"This property is ranked in descending order. Lower values indicate higher ranking."
]
},
"possibleValues": {
"items": {
"$ref": "EnumValuePair"
},
"description": "The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.",
"type": "array"
},
"operatorOptions": {
"description": "If set, describes how the enum should be used as a search operator.",
"$ref": "EnumOperatorOptions"
}
}
},
"DriveLocationRestrict": {
"description": "Drive location search restricts (e.g. \"is:starred\").",
"type": "object",
"properties": {
"type": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"enum": [
"UNSPECIFIED",
"TRASHED",
"STARRED"
]
}
},
"id": "DriveLocationRestrict"
},
"SuggestResponse": {
"properties": {
"suggestResults": {
"type": "array",
"description": "List of suggestions.",
"items": {
"$ref": "SuggestResult"
}
}
},
"type": "object",
"id": "SuggestResponse",
"description": "Response of the suggest API."
},
"HtmlPropertyOptions": {
"properties": {
"retrievalImportance": {
"description": "Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE.",
"$ref": "RetrievalImportance"
},
"operatorOptions": {
"description": "If set, describes how the property should be used as a search operator.",
"$ref": "HtmlOperatorOptions"
}
},
"type": "object",
"id": "HtmlPropertyOptions",
"description": "Options for html properties."
},
"PollItemsResponse": {
"properties": {
"items": {
"items": {
"$ref": "Item"
},
"description": "Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue",
"type": "array"
}
},
"id": "PollItemsResponse",
"type": "object"
},
"CheckAccessResponse": {
"properties": {
"hasAccess": {
"description": "Returns true if principal has access. Returns false otherwise.",
"type": "boolean"
}
},
"type": "object",
"id": "CheckAccessResponse"
},
"RepositoryError": {
"type": "object",
"description": "Errors when the connector is communicating to the source repository.",
"properties": {
"type": {
"description": "Type of error.",
"enumDescriptions": [
"Unknown error.",
"Unknown or unreachable host.",
"DNS problem, such as the DNS server is not responding.",
"Cannot connect to the repository server.",
"Failed authentication due to incorrect credentials.",
"Service account is not authorized for the repository.",
"Repository server error.",
"Quota exceeded.",
"Server temporarily unavailable.",
"Client-related error, such as an invalid request from the connector to the repository server."
],
"type": "string",
"enum": [
"UNKNOWN",
"NETWORK_ERROR",
"DNS_ERROR",
"CONNECTION_ERROR",
"AUTHENTICATION_ERROR",
"AUTHORIZATION_ERROR",
"SERVER_ERROR",
"QUOTA_EXCEEDED",
"SERVICE_UNAVAILABLE",
"CLIENT_ERROR"
]
},
"httpStatusCode": {
"format": "int32",
"description": "Error codes. Matches the definition of HTTP status codes.",
"type": "integer"
},
"errorMessage": {
"type": "string",
"description": "Message that describes the error. The maximum allowable length of the message is 8192 characters."
}
},
"id": "RepositoryError"
},
"ResultDebugInfo": {
"properties": {
"formattedDebugInfo": {
"type": "string",
"description": "General debug info formatted for display."
}
},
"description": "Debugging information about the result.",
"id": "ResultDebugInfo",
"type": "object"
},
"Name": {
"properties": {
"displayName": {
"description": "The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.",
"type": "string"
}
},
"description": "A person's name.",
"id": "Name",
"type": "object"
},
"Metaline": {
"properties": {
"properties": {
"items": {
"$ref": "DisplayedProperty"
},
"description": "The list of displayed properties for the metaline. The maximum number of properties is 5.",
"type": "array"
}
},
"description": "A metaline is a list of properties that are displayed along with the search result to provide context.",
"type": "object",
"id": "Metaline"
},
"FilterOptions": {
"id": "FilterOptions",
"type": "object",
"description": "Filter options to be applied on query.",
"properties": {
"filter": {
"$ref": "Filter",
"description": "Generic filter to restrict the search, such as `lang:en`, `site:xyz`."
},
"objectType": {
"type": "string",
"description": "If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters."
}
}
},
"Schema": {
"type": "object",
"id": "Schema",
"description": "The schema definition for a data source.",
"properties": {
"objectDefinitions": {
"description": "The list of top-level objects for the data source. The maximum number of elements is 10.",
"items": {
"$ref": "ObjectDefinition"
},
"type": "array"
},
"operationIds": {
"items": {
"type": "string"
},
"description": "IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content.",
"type": "array"
}
}
},
"PeopleSuggestion": {
"type": "object",
"description": "This field contains information about the person being suggested.",
"properties": {
"person": {
"$ref": "Person",
"description": "Suggested person. All fields of the person object might not be populated."
}
},
"id": "PeopleSuggestion"
},
"DisplayedProperty": {
"type": "object",
"properties": {
"propertyName": {
"description": "The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema.",
"type": "string"
}
},
"description": "A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.",
"id": "DisplayedProperty"
},
"DataSourceRestriction": {
"type": "object",
"id": "DataSourceRestriction",
"description": "Restriction on Datasource.",
"properties": {
"source": {
"$ref": "Source",
"description": "The source of restriction."
},
"filterOptions": {
"type": "array",
"description": "Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: \"objecttype\", \"type\" and \"mimetype\". For now, schema specific filters cannot be used to filter suggestions.",
"items": {
"$ref": "FilterOptions"
}
}
}
},
"ItemAcl": {
"properties": {
"readers": {
"items": {
"$ref": "Principal"
},
"description": "List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.",
"type": "array"
},
"aclInheritanceType": {
"enumDescriptions": [
"The default value when this item does not inherit an ACL. Use NOT_APPLICABLE when inheritAclFrom is empty. An item without ACL inheritance can still have ACLs supplied by its own readers and deniedReaders fields.",
"During an authorization conflict, the ACL of the child item determines its read access.",
"During an authorization conflict, the ACL of the parent item specified in the inheritAclFrom field determines read access.",
"Access is granted only if this item and the parent item specified in the inheritAclFrom field both permit read access."
],
"enum": [
"NOT_APPLICABLE",
"CHILD_OVERRIDE",
"PARENT_OVERRIDE",
"BOTH_PERMIT"
],
"description": "Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.",
"type": "string"
},
"owners": {
"description": "Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.",
"type": "array",
"items": {
"$ref": "Principal"
}
},
"deniedReaders": {
"items": {
"$ref": "Principal"
},
"description": "List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.",
"type": "array"
},
"inheritAclFrom": {
"type": "string",
"description": "Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters."
}
},
"type": "object",
"id": "ItemAcl",
"description": "Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls)."
},
"DateValues": {
"type": "object",
"properties": {
"values": {
"items": {
"$ref": "Date"
},
"type": "array"
}
},
"id": "DateValues",
"description": "List of date values."
},
"StartUploadItemRequest": {
"properties": {
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"type": "string"
},
"debugOptions": {
"$ref": "DebugOptions",
"description": "Common debug options."
}
},
"type": "object",
"id": "StartUploadItemRequest",
"description": "Start upload file request."
},
"EnumValuePair": {
"properties": {
"integerValue": {
"format": "int32",
"type": "integer",
"description": "The integer value of the EnumValuePair which must be non-negative. Optional."
},
"stringValue": {
"type": "string",
"description": "The string value of the EnumValuePair. The maximum length is 32 characters."
}
},
"type": "object",
"description": "The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.",
"id": "EnumValuePair"
},
"ListItemNamesForUnmappedIdentityResponse": {
"id": "ListItemNamesForUnmappedIdentityResponse",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"itemNames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ErrorInfo": {
"description": "Error information about the response.",
"properties": {
"errorMessages": {
"type": "array",
"items": {
"$ref": "ErrorMessage"
}
}
},
"id": "ErrorInfo",
"type": "object"
},
"SearchApplicationSessionStats": {
"properties": {
"date": {
"description": "Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.",
"$ref": "Date"
},
"searchSessionsCount": {
"type": "string",
"format": "int64",
"description": "The count of search sessions on the day"
}
},
"id": "SearchApplicationSessionStats",
"type": "object"
},
"SearchItemsByViewUrlResponse": {
"id": "SearchItemsByViewUrlResponse",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
},
"items": {
"type": "array",
"items": {
"$ref": "Item"
}
}
}
},
"GetCustomerQueryStatsResponse": {
"properties": {
"stats": {
"type": "array",
"items": {
"$ref": "CustomerQueryStats"
}
}
},
"type": "object",
"id": "GetCustomerQueryStatsResponse"
},
"EnumValues": {
"id": "EnumValues",
"description": "List of enum values.",
"type": "object",
"properties": {
"values": {
"description": "The maximum allowable length for string values is 32 characters.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"EmailAddress": {
"description": "A person's email address.",
"id": "EmailAddress",
"type": "object",
"properties": {
"emailAddress": {
"description": "The email address.",
"type": "string"
}
}
},
"GetSearchApplicationQueryStatsResponse": {
"id": "GetSearchApplicationQueryStatsResponse",
"properties": {
"stats": {
"type": "array",
"items": {
"$ref": "SearchApplicationQueryStats"
}
}
},
"type": "object"
},
"QueryCountByStatus": {
"properties": {
"statusCode": {
"description": "This represents the http status code.",
"type": "integer",
"format": "int32"
},
"count": {
"type": "string",
"format": "int64"
}
},
"type": "object",
"id": "QueryCountByStatus"
},
"TimestampValues": {
"id": "TimestampValues",
"type": "object",
"description": "List of timestamp values.",
"properties": {
"values": {
"type": "array",
"items": {
"format": "google-datetime",
"type": "string"
}
}
}
},
"IntegerOperatorOptions": {
"description": "Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
"id": "IntegerOperatorOptions",
"type": "object",
"properties": {
"operatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:\u003cvalue\u003e* show results only where the value of the property named *priorityVal* matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator returns all items where *\u003cvalue\u003e* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
},
"lessThanOperatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:\u003cvalue\u003e* show results only where the value of the property named *priorityVal* is less than *\u003cvalue\u003e*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
},
"greaterThanOperatorName": {
"description": "Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:\u003cvalue\u003e* show results only where the value of the property named *priorityVal* is greater than *\u003cvalue\u003e*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.",
"type": "string"
}
}
},
"DriveFollowUpRestrict": {
"id": "DriveFollowUpRestrict",
"type": "object",
"description": "Drive follow-up search restricts (e.g. \"followup:suggestions\").",
"properties": {
"type": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"enum": [
"UNSPECIFIED",
"FOLLOWUP_SUGGESTIONS",
"FOLLOWUP_ACTION_ITEMS"
]
}
}
},
"UpdateDataSourceRequest": {
"type": "object",
"properties": {
"debugOptions": {
"$ref": "DebugOptions",
"description": "Common debug options."
},
"source": {
"$ref": "DataSource"
}
},
"id": "UpdateDataSourceRequest"
},
"UnreserveItemsRequest": {
"type": "object",
"properties": {
"queue": {
"description": "Name of a queue to unreserve items from.",
"type": "string"
},
"debugOptions": {
"description": "Common debug options.",
"$ref": "DebugOptions"
},
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"type": "string"
}
},
"id": "UnreserveItemsRequest"
},
"SearchItemsByViewUrlRequest": {
"properties": {
"debugOptions": {
"description": "Common debug options.",
"$ref": "DebugOptions"
},
"pageToken": {
"type": "string",
"description": "The next_page_token value returned from a previous request, if any."
},
"viewUrl": {
"description": "Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.",
"type": "string"
}
},
"type": "object",
"id": "SearchItemsByViewUrlRequest"
},
"SortOptions": {
"type": "object",
"properties": {
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Ascending is the default sort order",
"enumDescriptions": [
"",
""
],
"type": "string"
},
"operatorName": {
"type": "string",
"description": "Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable."
}
},
"id": "SortOptions"
},
"UnmappedIdentity": {
"type": "object",
"id": "UnmappedIdentity",
"properties": {
"resolutionStatusCode": {
"enumDescriptions": [
"Input-only value. Used to list all unmapped identities regardless of status.",
"The unmapped identity was not found in IDaaS, and needs to be provided by the user.",
"The identity source associated with the identity was either not found or deleted.",
"IDaaS does not understand the identity source, probably because the schema was modified in a non compatible way.",
"The number of users associated with the external identity is too large.",
"Internal error."
],
"type": "string",
"description": "The resolution status for the external identity.",
"enum": [
"CODE_UNSPECIFIED",
"NOT_FOUND",
"IDENTITY_SOURCE_NOT_FOUND",
"IDENTITY_SOURCE_MISCONFIGURED",
"TOO_MANY_MAPPINGS_FOUND",
"INTERNAL_ERROR"
]
},
"externalIdentity": {
"$ref": "Principal",
"description": "The resource name for an external user."
}
}
},
"CompositeFilter": {
"id": "CompositeFilter",
"properties": {
"subFilters": {
"items": {
"$ref": "Filter"
},
"description": "Sub filters.",
"type": "array"
},
"logicOperator": {
"enumDescriptions": [
"Logical operators, which can only be applied to sub filters.",
"",
"NOT can only be applied on a single sub filter."
],
"type": "string",
"description": "The logic operator of the sub filter.",
"enum": [
"AND",
"OR",
"NOT"
]
}
},
"type": "object"
},
"ObjectDisplayOptions": {
"properties": {
"objectDisplayLabel": {
"type": "string",
"description": "The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters."
},
"metalines": {
"type": "array",
"description": "Defines the properties that are displayed in the metalines of the search results. The property values are displayed in the order given here. If a property holds multiple values, all of the values are displayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3.",
"items": {
"$ref": "Metaline"
}
}
},
"type": "object",
"description": "The display options for an object.",
"id": "ObjectDisplayOptions"
},
"Snippet": {
"properties": {
"snippet": {
"type": "string",
"description": "The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering."
},
"matchRanges": {
"items": {
"$ref": "MatchRange"
},
"description": "The matched ranges in the snippet.",
"type": "array"
}
},
"type": "object",
"description": "Snippet of the search result, which summarizes the content of the resulting page.",
"id": "Snippet"
},
"DataSourceIndexStats": {
"description": "Aggregation of items by status code as of the specified date.",
"id": "DataSourceIndexStats",
"type": "object",
"properties": {
"itemCountByStatus": {
"type": "array",
"description": "Number of items aggregrated by status code.",
"items": {
"$ref": "ItemCountByStatus"
}
},
"date": {
"description": "Date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned.",
"$ref": "Date"
}
}
},
"DataSource": {
"id": "DataSource",
"properties": {
"indexingServiceAccounts": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of service accounts that have indexing access."
},
"disableServing": {
"description": "Disable serving any search or assist results.",
"type": "boolean"
},
"itemsVisibility": {
"items": {
"$ref": "GSuitePrincipal"
},
"description": "This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.",
"type": "array"
},
"operationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the Long Running Operations (LROs) currently running for this schema."
},
"displayName": {
"description": "Required. Display name of the datasource The maximum length is 300 characters.",
"type": "string"
},
"shortName": {
"description": "A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *\u003cvalue\u003e* then queries like *source:\u003cvalue\u003e* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource."
},
"disableModifications": {
"type": "boolean",
"description": "If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data."
}
},
"type": "object",
"description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search."
},
"PropertyDefinition": {
"id": "PropertyDefinition",
"description": "The definition of a property within an object.",
"properties": {
"isReturnable": {
"type": "boolean",
"description": "Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object."
},
"name": {
"type": "string",
"description": "The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters."
},
"displayOptions": {
"description": "Options that determine how the property is displayed in the Cloud Search results page if it is specified to be displayed in the object's display options .",
"$ref": "PropertyDisplayOptions"
},
"isSuggestable": {
"description": "Indicates that the property can be used for generating query suggestions.",
"type": "boolean"
},
"timestampPropertyOptions": {
"$ref": "TimestampPropertyOptions"
},
"htmlPropertyOptions": {
"$ref": "HtmlPropertyOptions"
},
"isFacetable": {
"description": "Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for Boolean, Enum, and Text properties.",
"type": "boolean"
},
"isSortable": {
"type": "boolean",
"description": "Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object or user identifier. IsReturnable must be true to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties."
},
"datePropertyOptions": {
"$ref": "DatePropertyOptions"
},
"textPropertyOptions": {
"$ref": "TextPropertyOptions"
},
"isWildcardSearchable": {
"description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable.",
"type": "boolean"
},
"doublePropertyOptions": {
"$ref": "DoublePropertyOptions"
},
"booleanPropertyOptions": {
"$ref": "BooleanPropertyOptions"
},
"isRepeatable": {
"type": "boolean",
"description": "Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value cause the indexing request for that item to be rejected."
},
"enumPropertyOptions": {
"$ref": "EnumPropertyOptions"
},
"objectPropertyOptions": {
"$ref": "ObjectPropertyOptions"
},
"integerPropertyOptions": {
"$ref": "IntegerPropertyOptions"
}
},
"type": "object"
},
"Item": {
"id": "Item",
"description": "Represents a single object that is an item in the search index, such as a file, folder, or a database record.",
"type": "object",
"properties": {
"name": {
"description": "Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.",
"type": "string"
},
"itemType": {
"description": "Type for this item.",
"enumDescriptions": [
"",
"An item that is indexed for the only purpose of serving information. These items cannot be referred in containerName or inheritAclFrom fields.",
"An item that gets indexed and whose purpose is to supply other items with ACLs and/or contain other items.",
"An item that does not get indexed, but otherwise has the same purpose as CONTAINER_ITEM."
],
"enum": [
"UNSPECIFIED",
"CONTENT_ITEM",
"CONTAINER_ITEM",
"VIRTUAL_CONTAINER_ITEM"
],
"type": "string"
},
"structuredData": {
"$ref": "ItemStructuredData",
"description": "The structured data for the item that should conform to a registered object definition in the schema for the data source."
},
"version": {
"format": "byte",
"description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.",
"type": "string"
},
"metadata": {
"description": "Metadata information.",
"$ref": "ItemMetadata"
},
"payload": {
"format": "byte",
"description": "Additional state connector can store for this item. The maximum length is 10000 bytes.",
"type": "string"
},
"status": {
"$ref": "ItemStatus",
"description": "Status of the item. Output only field."
},
"acl": {
"$ref": "ItemAcl",
"description": "Access control list for this item."
},
"queue": {
"description": "Queue this item belongs to. The maximum length is 100 characters.",
"type": "string"
},
"content": {
"$ref": "ItemContent",
"description": "Item content to be indexed and made text searchable."
}
}
},
"ItemStatus": {
"description": "This contains item's status and any errors.",
"properties": {
"repositoryErrors": {
"items": {
"$ref": "RepositoryError"
},
"type": "array",
"description": "Repository error reported by connector."
},
"processingErrors": {
"description": "Error details in case the item is in ERROR state.",
"items": {
"$ref": "ProcessingError"
},
"type": "array"
},
"code": {
"type": "string",
"description": "Status code.",
"enum": [
"CODE_UNSPECIFIED",
"ERROR",
"MODIFIED",
"NEW_ITEM",
"ACCEPTED"
],
"enumDescriptions": [
"Input-only value. Used with Items.list to list all items in the queue, regardless of status.",
"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.",
"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.",
"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.",
"API has accepted the up-to-date data of this item."
]
}
},
"type": "object",
"id": "ItemStatus"
},
"FreshnessOptions": {
"description": "Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.",
"id": "FreshnessOptions",
"type": "object",
"properties": {
"freshnessDuration": {
"format": "google-duration",
"type": "string",
"description": "The duration after which an object should be considered stale. The default value is 180 days (in seconds)."
},
"freshnessProperty": {
"description": "This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time.",
"type": "string"
}
}
},
"SearchRequest": {
"id": "SearchRequest",
"properties": {
"query": {
"description": "The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://support.google.com/a/users/answer/9299929)",
"type": "string"
},
"sortOptions": {
"$ref": "SortOptions",
"description": "The options for sorting the search results"
},
"requestOptions": {
"$ref": "RequestOptions",
"description": "Request options, such as the search application and user timezone."
},
"start": {
"description": "Starting index of the results.",
"format": "int32",
"type": "integer"
},
"queryInterpretationOptions": {
"description": "Options to interpret the user query.",
"$ref": "QueryInterpretationOptions"
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested."
},
"dataSourceRestrictions": {
"items": {
"$ref": "DataSourceRestriction"
},
"type": "array",
"description": "The sources to use for querying. If not specified, all data sources from the current search application are used."
},
"facetOptions": {
"items": {
"$ref": "FacetOptions"
},
"type": "array"
}
},
"description": "The search API request.",
"type": "object"
},
"FacetResult": {
"type": "object",
"description": "Source specific facet response",
"id": "FacetResult",
"properties": {
"operatorName": {
"description": "Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions",
"type": "string"
},
"sourceName": {
"type": "string",
"description": "Source name for which facet results are returned. Will not be empty."
},
"buckets": {
"type": "array",
"items": {
"$ref": "FacetBucket"
},
"description": "FacetBuckets for values in response containing at least a single result."
},
"objectType": {
"description": "Object type for which facet results are returned. Can be empty.",
"type": "string"
}
}
},
"SuggestResult": {
"type": "object",
"id": "SuggestResult",
"description": "One suggestion result.",
"properties": {
"querySuggestion": {
"$ref": "QuerySuggestion",
"description": "This field will be present if the suggested query is a word/phrase completion."
},
"suggestedQuery": {
"description": "The suggested query that will be used for search, when the user clicks on the suggestion",
"type": "string"
},
"peopleSuggestion": {
"description": "This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc.",
"$ref": "PeopleSuggestion"
},
"source": {
"$ref": "Source",
"description": "The source of the suggestion."
}
}
},
"SourceCrowdingConfig": {
"type": "object",
"properties": {
"numSuggestions": {
"type": "integer",
"description": "Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.",
"format": "int32"
},
"numResults": {
"type": "integer",
"format": "int32",
"description": "Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0."
}
},
"description": "Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host \"crowd out\" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.",
"id": "SourceCrowdingConfig"
},
"SearchResponse": {
"id": "SearchResponse",
"type": "object",
"properties": {
"debugInfo": {
"description": "Debugging information about the response.",
"$ref": "ResponseDebugInfo"
},
"spellResults": {
"description": "Suggested spelling for the query.",
"type": "array",
"items": {
"$ref": "SpellResult"
}
},
"structuredResults": {
"type": "array",
"items": {
"$ref": "StructuredResult"
},
"description": "Structured results for the user query. These results are not counted against the page_size."
},
"hasMoreResults": {
"description": "Whether there are more search results matching the query.",
"type": "boolean"
},
"resultCounts": {
"$ref": "ResultCounts",
"description": "Expanded result count information."
},
"facetResults": {
"items": {
"$ref": "FacetResult"
},
"description": "Repeated facet results.",
"type": "array"
},
"resultCountExact": {
"type": "string",
"format": "int64",
"description": "The exact result count for this query."
},
"errorInfo": {
"description": "Error information about the response.",
"$ref": "ErrorInfo"
},
"resultCountEstimate": {
"type": "string",
"description": "The estimated result count for this query.",
"format": "int64"
},
"results": {
"type": "array",
"description": "Results from a search query.",
"items": {
"$ref": "SearchResult"
}
},
"queryInterpretation": {
"$ref": "QueryInterpretation",
"description": "Query interpretation result for user query. Empty if query interpretation is disabled."
}
},
"description": "The search API response."
},
"EnumOperatorOptions": {
"properties": {
"operatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:\u003cvalue\u003e* show results only where the value of the property named *priorityVal* matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator returns all items where *\u003cvalue\u003e* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
}
},
"type": "object",
"id": "EnumOperatorOptions",
"description": "Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*."
},
"QuerySource": {
"description": "List of sources that the user can search using the query API.",
"properties": {
"source": {
"description": "Name of the source",
"$ref": "Source"
},
"shortName": {
"type": "string",
"description": "A short name or alias for the source. This value can be used with the 'source' operator."
},
"operators": {
"items": {
"$ref": "QueryOperator"
},
"type": "array",
"description": "List of all operators applicable for this source."
},
"displayName": {
"description": "Display name of the data source.",
"type": "string"
}
},
"id": "QuerySource",
"type": "object"
},
"RetrievalImportance": {
"id": "RetrievalImportance",
"properties": {
"importance": {
"description": "Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.",
"enumDescriptions": [
"Treat the match like a body text match.",
"Treat the match like a match against title of the item.",
"Treat the match with higher importance than body text.",
"Treat the match with lower importance than body text.",
"Do not match against this field during retrieval. The property can still be used for operator matching, faceting, and suggest if desired."
],
"type": "string",
"enum": [
"DEFAULT",
"HIGHEST",
"HIGH",
"LOW",
"NONE"
]
}
},
"type": "object"
},
"QueryOperator": {
"properties": {
"isSuggestable": {
"type": "boolean",
"description": "Can get suggestions for this field."
},
"isSortable": {
"description": "Can this operator be used to sort results.",
"type": "boolean"
},
"isReturnable": {
"description": "Will the property associated with this facet be returned as part of search results.",
"type": "boolean"
},
"lessThanOperatorName": {
"type": "string",
"description": "Indicates the operator name that can be used to isolate the property using the less-than operator."
},
"greaterThanOperatorName": {
"description": "Indicates the operator name that can be used to isolate the property using the greater-than operator.",
"type": "string"
},
"isFacetable": {
"description": "Can this operator be used to get facets.",
"type": "boolean"
},
"isRepeatable": {
"type": "boolean",
"description": "Indicates if multiple values can be set for this property."
},
"type": {
"type": "string",
"enum": [
"UNKNOWN",
"INTEGER",
"DOUBLE",
"TIMESTAMP",
"BOOLEAN",
"ENUM",
"DATE",
"TEXT",
"HTML"
],
"description": "Type of the operator.",
"enumDescriptions": [
"Invalid value.",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"operatorName": {
"type": "string",
"description": "The name of the operator."
},
"objectType": {
"description": "Name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators.",
"type": "string"
},
"enumValues": {
"description": "Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.",
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Display name of the operator",
"type": "string"
}
},
"description": "The definition of a operator that can be used in a Search/Suggest request.",
"type": "object",
"id": "QueryOperator"
},
"ObjectPropertyOptions": {
"properties": {
"subobjectProperties": {
"description": "The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.",
"items": {
"$ref": "PropertyDefinition"
},
"type": "array"
}
},
"description": "Options for object properties.",
"id": "ObjectPropertyOptions",
"type": "object"
},
"TextOperatorOptions": {
"id": "TextOperatorOptions",
"description": "Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
"type": "object",
"properties": {
"operatorName": {
"description": "Indicates the operator name required in the query in order to isolate the text property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:\u003cvalue\u003e* show results only where the value of the property named *subjectLine* matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator returns all items where *\u003cvalue\u003e* matches the value of any text properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.",
"type": "string"
},
"exactMatchWithOperator": {
"description": "If true, the text value is tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is \"genre\" and the value is \"science-fiction\" the query restrictions \"genre:science\" and \"genre:fiction\" doesn't match the item; \"genre:science-fiction\" does. Value matching is case-sensitive and does not remove special characters. If false, the text is tokenized. For example, if the value is \"science-fiction\" the queries \"genre:science\" and \"genre:fiction\" matches the item.",
"type": "boolean"
}
}
},
"DriveMimeTypeRestrict": {
"id": "DriveMimeTypeRestrict",
"description": "Drive mime-type search restricts (e.g. \"type:pdf\").",
"properties": {
"type": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"UNSPECIFIED",
"PDF",
"DOCUMENT",
"PRESENTATION",
"SPREADSHEET",
"FORM",
"DRAWING",
"SCRIPT",
"MAP",
"IMAGE",
"AUDIO",
"VIDEO",
"FOLDER",
"ARCHIVE",
"SITE"
]
}
},
"type": "object"
},
"PushItemRequest": {
"id": "PushItemRequest",
"type": "object",
"properties": {
"item": {
"description": "Item to push onto the queue.",
"$ref": "PushItem"
},
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"type": "string"
},
"debugOptions": {
"description": "Common debug options.",
"$ref": "DebugOptions"
}
}
},
"DoubleValues": {
"id": "DoubleValues",
"description": "List of double values.",
"properties": {
"values": {
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"IntegerValues": {
"id": "IntegerValues",
"properties": {
"values": {
"items": {
"type": "string",
"format": "int64"
},
"type": "array"
}
},
"type": "object",
"description": "List of integer values."
},
"ProcessingError": {
"id": "ProcessingError",
"properties": {
"errorMessage": {
"description": "Description of the error.",
"type": "string"
},
"fieldViolations": {
"items": {
"$ref": "FieldViolation"
},
"type": "array",
"description": "In case the item fields are invalid, this field contains the details about the validation errors."
},
"code": {
"description": "Error code indicating the nature of the error.",
"type": "string",
"enumDescriptions": [
"Input only value. Use this value in Items.",
"Item's ACL, metadata, or content is malformed or in invalid state. FieldViolations contains more details on where the problem is.",
"Countent format is unsupported.",
"Items with incomplete ACL information due to inheriting other items with broken ACL or having groups with unmapped descendants.",
"ACL inheritance graph formed a cycle."
],
"enum": [
"PROCESSING_ERROR_CODE_UNSPECIFIED",
"MALFORMED_REQUEST",
"UNSUPPORTED_CONTENT_FORMAT",
"INDIRECT_BROKEN_ACL",
"ACL_CYCLE"
]
}
},
"type": "object"
},
"FieldViolation": {
"id": "FieldViolation",
"properties": {
"description": {
"description": "Description of the error.",
"type": "string"
},
"field": {
"type": "string",
"description": "Path of field with violation."
}
},
"type": "object"
},
"ListOperationsResponse": {
"id": "ListOperationsResponse",
"type": "object",
"description": "The response message for Operations.ListOperations.",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"type": "array",
"items": {
"$ref": "Operation"
},
"description": "A list of operations that matches the specified filter in the request."
}
}
},
"DeleteQueueItemsRequest": {
"type": "object",
"id": "DeleteQueueItemsRequest",
"properties": {
"debugOptions": {
"$ref": "DebugOptions",
"description": "Common debug options."
},
"queue": {
"type": "string",
"description": "Name of a queue to delete items from."
},
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"type": "string"
}
}
},
"HtmlOperatorOptions": {
"description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
"id": "HtmlOperatorOptions",
"properties": {
"operatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:\u003cvalue\u003e* show results only where the value of the property named *subjectLine* matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator return all items where *\u003cvalue\u003e* matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
}
},
"type": "object"
},
"Filter": {
"type": "object",
"description": "A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.",
"properties": {
"valueFilter": {
"$ref": "ValueFilter"
},
"compositeFilter": {
"$ref": "CompositeFilter"
}
},
"id": "Filter"
},
"ListDataSourceResponse": {
"properties": {
"sources": {
"items": {
"$ref": "DataSource"
},
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
}
},
"type": "object",
"id": "ListDataSourceResponse"
},
"SpellResult": {
"properties": {
"suggestedQuery": {
"type": "string",
"description": "The suggested spelling of the query."
}
},
"id": "SpellResult",
"type": "object"
},
"CustomerUserStats": {
"id": "CustomerUserStats",
"properties": {
"thirtyDaysActiveUsersCount": {
"format": "int64",
"description": "The count of unique active users in the past thirty days",
"type": "string"
},
"sevenDaysActiveUsersCount": {
"description": "The count of unique active users in the past seven days",
"type": "string",
"format": "int64"
},
"date": {
"$ref": "Date",
"description": "Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned."
},
"oneDayActiveUsersCount": {
"description": "The count of unique active users in the past one day",
"type": "string",
"format": "int64"
}
},
"type": "object"
},
"ItemContent": {
"description": "Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.",
"properties": {
"contentDataRef": {
"description": "Upload reference ID of a previously uploaded content via write method.",
"$ref": "UploadItemRef"
},
"inlineContent": {
"type": "string",
"description": "Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).",
"format": "byte"
},
"hash": {
"description": "Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.",
"type": "string"
},
"contentFormat": {
"enumDescriptions": [
"Invalid value.",
"contentFormat is HTML.",
"contentFormat is free text.",
"contentFormat is raw bytes."
],
"type": "string",
"enum": [
"UNSPECIFIED",
"HTML",
"TEXT",
"RAW"
]
}
},
"type": "object",
"id": "ItemContent"
},
"Source": {
"properties": {
"name": {
"type": "string",
"description": "Source name for content indexed by the Indexing API."
},
"predefinedSource": {
"enumDescriptions": [
"",
"Suggests queries issued by the user in the past. Only valid when used with the suggest API. Ignored when used in the query API.",
"Suggests people in the organization. Only valid when used with the suggest API. Results in an error when used in the query API.",
"",
"",
"",
"",
"",
""
],
"description": "Predefined content source for Google Apps.",
"type": "string",
"enum": [
"NONE",
"QUERY_HISTORY",
"PERSON",
"GOOGLE_DRIVE",
"GOOGLE_GMAIL",
"GOOGLE_SITES",
"GOOGLE_GROUPS",
"GOOGLE_CALENDAR",
"GOOGLE_KEEP"
]
}
},
"id": "Source",
"type": "object",
"description": "Defines sources for the suggest/search APIs."
},
"Principal": {
"description": "Reference to a user, group, or domain.",
"id": "Principal",
"properties": {
"userResourceName": {
"type": "string",
"description": "This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}"
},
"gsuitePrincipal": {
"description": "This principal is a GSuite user, group or domain.",
"$ref": "GSuitePrincipal"
},
"groupResourceName": {
"type": "string",
"description": "This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}"
}
},
"type": "object"
},
"SearchResult": {
"description": "Results containing indexed information for a document.",
"id": "SearchResult",
"properties": {
"snippet": {
"description": "The concatenation of all snippets (summaries) available for this result.",
"$ref": "Snippet"
},
"url": {
"type": "string",
"description": "The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed."
},
"debugInfo": {
"$ref": "ResultDebugInfo",
"description": "Debugging information about this search result."
},
"metadata": {
"description": "Metadata of the search result.",
"$ref": "Metadata"
},
"title": {
"type": "string",
"description": "Title of the search result."
},
"clusteredResults": {
"description": "If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.",
"type": "array",
"items": {
"$ref": "SearchResult"
}
}
},
"type": "object"
},
"ResultDisplayLine": {
"type": "object",
"id": "ResultDisplayLine",
"properties": {
"fields": {
"items": {
"$ref": "ResultDisplayField"
},
"type": "array"
}
},
"description": "The collection of fields that make up a displayed line"
},
"Media": {
"type": "object",
"id": "Media",
"description": "Media resource.",
"properties": {
"resourceName": {
"type": "string",
"description": "Name of the media resource."
}
}
},
"TextPropertyOptions": {
"type": "object",
"description": "Options for text properties.",
"id": "TextPropertyOptions",
"properties": {
"operatorOptions": {
"description": "If set, describes how the property should be used as a search operator.",
"$ref": "TextOperatorOptions"
},
"retrievalImportance": {
"$ref": "RetrievalImportance",
"description": "Indicates the search quality importance of the tokens within the field when used for retrieval."
}
}
},
"ItemCountByStatus": {
"properties": {
"count": {
"description": "Number of items matching the status code.",
"format": "int64",
"type": "string"
},
"statusCode": {
"type": "string",
"description": "Status of the items.",
"enumDescriptions": [
"Input-only value. Used with Items.list to list all items in the queue, regardless of status.",
"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.",
"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.",
"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.",
"API has accepted the up-to-date data of this item."
],
"enum": [
"CODE_UNSPECIFIED",
"ERROR",
"MODIFIED",
"NEW_ITEM",
"ACCEPTED"
]
}
},
"type": "object",
"id": "ItemCountByStatus"
},
"Date": {
"properties": {
"year": {
"format": "int32",
"description": "Year of date. Must be from 1 to 9999.",
"type": "integer"
},
"month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"type": "integer"
},
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"id": "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."
},
"DriveTimeSpanRestrict": {
"description": "The time span search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").",
"id": "DriveTimeSpanRestrict",
"type": "object",
"properties": {
"type": {
"enumDescriptions": [
"",
"",
"",
"",
"Not Enabled",
"Not Enabled"
],
"type": "string",
"enum": [
"UNSPECIFIED",
"TODAY",
"YESTERDAY",
"LAST_7_DAYS",
"LAST_30_DAYS",
"LAST_90_DAYS"
]
}
}
},
"ItemStructuredData": {
"properties": {
"object": {
"description": "The structured data object that should conform to a registered object definition in the schema for the data source.",
"$ref": "StructuredDataObject"
},
"hash": {
"description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.",
"type": "string"
}
},
"type": "object",
"id": "ItemStructuredData",
"description": "Available structured data fields for the item."
},
"SourceResultCount": {
"description": "Per source result count information.",
"id": "SourceResultCount",
"properties": {
"resultCountExact": {
"type": "string",
"format": "int64",
"description": "The exact result count for this source."
},
"hasMoreResults": {
"description": "Whether there are more search results for this source.",
"type": "boolean"
},
"resultCountEstimate": {
"description": "The estimated result count for this source.",
"type": "string",
"format": "int64"
},
"source": {
"description": "The source the result count information is associated with.",
"$ref": "Source"
}
},
"type": "object"
},
"ResultCounts": {
"type": "object",
"id": "ResultCounts",
"description": "Result count information",
"properties": {
"sourceResultCounts": {
"items": {
"$ref": "SourceResultCount"
},
"type": "array",
"description": "Result count information for each source with results."
}
}
},
"Photo": {
"type": "object",
"id": "Photo",
"properties": {
"url": {
"description": "The URL of the photo.",
"type": "string"
}
},
"description": "A person's photo."
},
"ListItemsResponse": {
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "Item"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
}
},
"id": "ListItemsResponse"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"type": "object",
"properties": {
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"done": {
"type": "boolean",
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."
},
"metadata": {
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"response": {
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
}
}
},
"GetCustomerUserStatsResponse": {
"type": "object",
"id": "GetCustomerUserStatsResponse",
"properties": {
"stats": {
"type": "array",
"items": {
"$ref": "CustomerUserStats"
}
}
}
},
"QueryInterpretation": {
"type": "object",
"id": "QueryInterpretation",
"properties": {
"interpretationType": {
"enum": [
"NONE",
"BLEND",
"REPLACE"
],
"enumDescriptions": [
"Neither the natural language interpretation, nor a broader version of the query is used to fetch the search results.",
"The results from original query are blended with other results. The reason for blending these other results with the results from original query is populated in the 'Reason' field below.",
"The results from original query are replaced. The reason for replacing the results from original query is populated in the 'Reason' field below."
],
"type": "string"
},
"reason": {
"type": "string",
"enumDescriptions": [
"",
"Natural language interpretation of the query is used to fetch the search results.",
"Query and document terms similarity is used to selectively broaden the query to retrieve additional search results since enough results were not found for the user query. Interpreted query will be empty for this case."
],
"enum": [
"UNSPECIFIED",
"QUERY_HAS_NATURAL_LANGUAGE_INTENT",
"NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY"
],
"description": "The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE."
},
"interpretedQuery": {
"type": "string",
"description": "The interpretation of the query used in search. For example, queries with natural language intent like \"email from john\" will be interpreted as \"from:john source:mail\". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY."
}
}
},
"QuerySuggestion": {
"properties": {},
"type": "object",
"description": "This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.",
"id": "QuerySuggestion"
},
"HtmlValues": {
"type": "object",
"id": "HtmlValues",
"properties": {
"values": {
"description": "The maximum allowable length for html values is 2048 characters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"description": "List of html values."
},
"ObjectDefinition": {
"description": "The definition for an object within a data source.",
"properties": {
"options": {
"description": "The optional object-specific options.",
"$ref": "ObjectOptions"
},
"name": {
"type": "string",
"description": "Name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters."
},
"propertyDefinitions": {
"type": "array",
"description": "The property definitions for the object. The maximum number of elements is 1000.",
"items": {
"$ref": "PropertyDefinition"
}
}
},
"type": "object",
"id": "ObjectDefinition"
},
"SearchApplication": {
"properties": {
"name": {
"description": "Name of the Search Application. Format: searchapplications/{application_id}.",
"type": "string"
},
"defaultFacetOptions": {
"type": "array",
"description": "The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.",
"items": {
"$ref": "FacetOptions"
}
},
"displayName": {
"description": "Display name of the Search Application. The maximum length is 300 characters.",
"type": "string"
},
"sourceConfig": {
"items": {
"$ref": "SourceConfig"
},
"description": "Configuration for a sources specified in data_source_restrictions.",
"type": "array"
},
"operationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.",
"readOnly": true
},
"defaultSortOptions": {
"$ref": "SortOptions",
"description": "The default options for sorting the search results"
},
"dataSourceRestrictions": {
"type": "array",
"items": {
"$ref": "DataSourceRestriction"
},
"description": "Retrictions applied to the configurations. The maximum number of elements is 10."
},
"scoringConfig": {
"description": "Configuration for ranking results.",
"$ref": "ScoringConfig"
}
},
"description": "SearchApplication",
"type": "object",
"id": "SearchApplication"
},
"QueryItem": {
"type": "object",
"description": "Information relevant only to a query entry.",
"id": "QueryItem",
"properties": {
"isSynthetic": {
"description": "True if the text was generated by means other than a previous user search.",
"type": "boolean"
}
}
},
"ResultDisplayMetadata": {
"type": "object",
"properties": {
"metalines": {
"type": "array",
"description": "The metalines content to be displayed with the result.",
"items": {
"$ref": "ResultDisplayLine"
}
},
"objectTypeLabel": {
"type": "string",
"description": "The display label for the object."
}
},
"id": "ResultDisplayMetadata"
},
"DateOperatorOptions": {
"description": "Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
"type": "object",
"properties": {
"lessThanOperatorName": {
"type": "string",
"description": "Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:\u003cvalue\u003e* show results only where the value of the property named *closeDate* is earlier than *\u003cvalue\u003e*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
},
"greaterThanOperatorName": {
"description": "Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:\u003cvalue\u003e* show results only where the value of the property named *closeDate* is later than *\u003cvalue\u003e*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.",
"type": "string"
},
"operatorName": {
"type": "string",
"description": "Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:\u003cvalue\u003e* show results only where the value of the *closeDate* property matches *\u003cvalue\u003e*. By contrast, a search that uses the same *\u003cvalue\u003e* without an operator returns all items where *\u003cvalue\u003e* matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters."
}
},
"id": "DateOperatorOptions"
}
},
"protocol": "rest",
"basePath": "",
"rootUrl": "https://cloudsearch.googleapis.com/",
"name": "cloudsearch",
"kind": "discovery#restDescription",
"servicePath": "",
"ownerName": "Google",
"documentationLink": "https://developers.google.com/cloud-search/docs/guides/",
"title": "Cloud Search API",
"parameters": {
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"$.xgafv": {
"location": "query",
"enum": [
"1",
"2"
],
"type": "string",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
},
"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.",
"type": "string",
"location": "query"
},
"alt": {
"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",
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
]
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"oauth_token": {
"location": "query",
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"access_token": {
"location": "query",
"type": "string",
"description": "OAuth access token."
},
"quotaUser": {
"location": "query",
"type": "string",
"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."
}
},
"revision": "20201110",
"id": "cloudsearch:v1",
"canonicalName": "Cloud Search",
"resources": {
"settings": {
"resources": {
"searchapplications": {
"methods": {
"create": {
"flatPath": "v1/settings/searchapplications",
"id": "cloudsearch.settings.searchapplications.create",
"path": "v1/settings/searchapplications",
"parameterOrder": [],
"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"
],
"request": {
"$ref": "SearchApplication"
},
"description": "Creates a search application. **Note:** This API requires an admin account to execute.",
"httpMethod": "POST",
"parameters": {}
},
"reset": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"description": "Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.",
"httpMethod": "POST",
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}:reset",
"parameters": {
"name": {
"required": true,
"location": "path",
"pattern": "^searchapplications/[^/]+$",
"type": "string",
"description": "The name of the search application to be reset. Format: applications/{application_id}."
}
},
"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"
],
"path": "v1/settings/{+name}:reset",
"id": "cloudsearch.settings.searchapplications.reset",
"request": {
"$ref": "ResetSearchApplicationRequest"
}
},
"delete": {
"response": {
"$ref": "Operation"
},
"path": "v1/settings/{+name}",
"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"
],
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}",
"httpMethod": "DELETE",
"description": "Deletes a search application. **Note:** This API requires an admin account to execute.",
"parameters": {
"debugOptions.enableDebugging": {
"type": "boolean",
"location": "query",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
},
"name": {
"pattern": "^searchapplications/[^/]+$",
"type": "string",
"location": "path",
"description": "The name of the search application to be deleted. Format: applications/{application_id}.",
"required": true
}
},
"id": "cloudsearch.settings.searchapplications.delete",
"parameterOrder": [
"name"
]
},
"list": {
"parameters": {
"pageToken": {
"location": "query",
"description": "The next_page_token value returned from a previous List request, if any. The default value is 10",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"type": "boolean",
"location": "query"
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "The maximum number of items to return."
}
},
"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"
],
"response": {
"$ref": "ListSearchApplicationsResponse"
},
"httpMethod": "GET",
"flatPath": "v1/settings/searchapplications",
"parameterOrder": [],
"id": "cloudsearch.settings.searchapplications.list",
"path": "v1/settings/searchapplications",
"description": "Lists all search applications. **Note:** This API requires an admin account to execute."
},
"get": {
"httpMethod": "GET",
"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"
],
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}",
"id": "cloudsearch.settings.searchapplications.get",
"parameters": {
"name": {
"type": "string",
"pattern": "^searchapplications/[^/]+$",
"location": "path",
"description": "Name of the search application. Format: searchapplications/{application_id}.",
"required": true
},
"debugOptions.enableDebugging": {
"location": "query",
"type": "boolean",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
}
},
"description": "Gets the specified search application. **Note:** This API requires an admin account to execute.",
"parameterOrder": [
"name"
]
},
"update": {
"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"
],
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"type": "string",
"description": "Name of the Search Application. Format: searchapplications/{application_id}.",
"pattern": "^searchapplications/[^/]+$",
"required": true,
"location": "path"
}
},
"description": "Updates a search application. **Note:** This API requires an admin account to execute.",
"id": "cloudsearch.settings.searchapplications.update",
"httpMethod": "PUT",
"path": "v1/settings/{+name}",
"response": {
"$ref": "Operation"
},
"flatPath": "v1/settings/searchapplications/{searchapplicationsId}",
"request": {
"$ref": "SearchApplication"
}
}
}
},
"datasources": {
"methods": {
"create": {
"description": "Creates a datasource. **Note:** This API requires an admin account to execute.",
"parameters": {},
"request": {
"$ref": "DataSource"
},
"response": {
"$ref": "Operation"
},
"path": "v1/settings/datasources",
"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"
],
"flatPath": "v1/settings/datasources",
"httpMethod": "POST",
"id": "cloudsearch.settings.datasources.create",
"parameterOrder": []
},
"list": {
"httpMethod": "GET",
"id": "cloudsearch.settings.datasources.list",
"response": {
"$ref": "ListDataSourceResponse"
},
"path": "v1/settings/datasources",
"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"
],
"parameterOrder": [],
"parameters": {
"pageToken": {
"location": "query",
"type": "string",
"description": "Starting index of the results."
},
"debugOptions.enableDebugging": {
"type": "boolean",
"location": "query",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
},
"pageSize": {
"location": "query",
"description": "Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10",
"format": "int32",
"type": "integer"
}
},
"description": "Lists datasources. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/settings/datasources"
},
"get": {
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Name of the datasource resource. Format: datasources/{source_id}.",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/settings/{+name}",
"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"
],
"response": {
"$ref": "DataSource"
},
"id": "cloudsearch.settings.datasources.get",
"flatPath": "v1/settings/datasources/{datasourcesId}",
"description": "Gets a datasource. **Note:** This API requires an admin account to execute.",
"parameterOrder": [
"name"
]
},
"update": {
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.",
"required": true,
"type": "string",
"pattern": "^datasources/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/settings/datasources/{datasourcesId}",
"httpMethod": "PUT",
"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"
],
"id": "cloudsearch.settings.datasources.update",
"response": {
"$ref": "Operation"
},
"path": "v1/settings/{+name}",
"description": "Updates a datasource. **Note:** This API requires an admin account to execute.",
"request": {
"$ref": "UpdateDataSourceRequest"
}
},
"delete": {
"description": "Deletes a datasource. **Note:** This API requires an admin account to execute.",
"parameterOrder": [
"name"
],
"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"
],
"httpMethod": "DELETE",
"path": "v1/settings/{+name}",
"flatPath": "v1/settings/datasources/{datasourcesId}",
"response": {
"$ref": "Operation"
},
"id": "cloudsearch.settings.datasources.delete",
"parameters": {
"name": {
"pattern": "^datasources/[^/]+$",
"required": true,
"description": "Name of the datasource. Format: datasources/{source_id}.",
"type": "string",
"location": "path"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"type": "boolean",
"location": "query"
}
}
}
}
}
}
},
"query": {
"resources": {
"sources": {
"methods": {
"list": {
"path": "v1/query/sources",
"parameters": {
"requestOptions.debugOptions.enableDebugging": {
"type": "boolean",
"location": "query",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
},
"pageToken": {
"description": "Number of sources to return in the response.",
"location": "query",
"type": "string"
},
"requestOptions.searchApplicationId": {
"type": "string",
"description": "The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).",
"location": "query"
},
"requestOptions.timeZone": {
"description": "Current user's time zone id, such as \"America/Los_Angeles\" or \"Australia/Sydney\". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.",
"location": "query",
"type": "string"
},
"requestOptions.languageCode": {
"location": "query",
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query."
}
},
"response": {
"$ref": "ListQuerySourcesResponse"
},
"parameterOrder": [],
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
],
"description": "Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).",
"httpMethod": "GET",
"flatPath": "v1/query/sources",
"id": "cloudsearch.query.sources.list"
}
}
}
},
"methods": {
"suggest": {
"parameters": {},
"description": "Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).",
"httpMethod": "POST",
"flatPath": "v1/query/suggest",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
],
"response": {
"$ref": "SuggestResponse"
},
"parameterOrder": [],
"id": "cloudsearch.query.suggest",
"request": {
"$ref": "SuggestRequest"
},
"path": "v1/query/suggest"
},
"search": {
"id": "cloudsearch.query.search",
"flatPath": "v1/query/search",
"parameterOrder": [],
"description": "The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
],
"httpMethod": "POST",
"request": {
"$ref": "SearchRequest"
},
"path": "v1/query/search",
"response": {
"$ref": "SearchResponse"
},
"parameters": {}
}
}
},
"stats": {
"resources": {
"index": {
"resources": {
"datasources": {
"methods": {
"get": {
"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"
],
"description": "Gets indexed item statistics for a single data source. **Note:** This API requires a standard end user account to execute.",
"path": "v1/stats/index/{+name}",
"id": "cloudsearch.stats.index.datasources.get",
"parameters": {
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"location": "query",
"format": "int32",
"type": "integer"
},
"name": {
"description": "The resource id of the data source to retrieve statistics for, in the following format: \"datasources/{source_id}\"",
"location": "path",
"type": "string",
"required": true,
"pattern": "^datasources/[^/]+$"
},
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"location": "query",
"format": "int32",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"type": "integer",
"format": "int32",
"location": "query"
},
"fromDate.year": {
"type": "integer",
"format": "int32",
"location": "query",
"description": "Year of date. Must be from 1 to 9999."
},
"fromDate.day": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"toDate.day": {
"location": "query",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32",
"type": "integer"
}
},
"flatPath": "v1/stats/index/datasources/{datasourcesId}",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GetDataSourceIndexStatsResponse"
}
}
}
}
}
},
"user": {
"resources": {
"searchapplications": {
"methods": {
"get": {
"description": "Get the users statistics for search application. **Note:** This API requires a standard end user account to execute.",
"parameters": {
"toDate.day": {
"location": "query",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer",
"format": "int32"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"location": "query",
"format": "int32",
"type": "integer"
},
"fromDate.day": {
"type": "integer",
"location": "query",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"format": "int32"
},
"name": {
"description": "The resource id of the search application session stats, in the following format: searchapplications/{application_id}",
"pattern": "^searchapplications/[^/]+$",
"location": "path",
"type": "string",
"required": true
},
"fromDate.year": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Year of date. Must be from 1 to 9999."
},
"fromDate.month": {
"format": "int32",
"location": "query",
"description": "Month of date. Must be from 1 to 12.",
"type": "integer"
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"type": "integer",
"format": "int32",
"location": "query"
}
},
"flatPath": "v1/stats/user/searchapplications/{searchapplicationsId}",
"id": "cloudsearch.stats.user.searchapplications.get",
"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"
],
"httpMethod": "GET",
"response": {
"$ref": "GetSearchApplicationUserStatsResponse"
},
"parameterOrder": [
"name"
],
"path": "v1/stats/user/{+name}"
}
}
}
}
},
"session": {
"resources": {
"searchapplications": {
"methods": {
"get": {
"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"
],
"parameters": {
"toDate.day": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"name": {
"type": "string",
"required": true,
"location": "path",
"description": "The resource id of the search application session stats, in the following format: searchapplications/{application_id}",
"pattern": "^searchapplications/[^/]+$"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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": {
"format": "int32",
"type": "integer",
"description": "Month of date. Must be from 1 to 12.",
"location": "query"
},
"fromDate.year": {
"location": "query",
"description": "Year of date. Must be from 1 to 9999.",
"type": "integer",
"format": "int32"
},
"toDate.year": {
"type": "integer",
"description": "Year of date. Must be from 1 to 9999.",
"location": "query",
"format": "int32"
}
},
"description": "Get the # of search sessions, % of successful sessions with a click query statistics for search application. **Note:** This API requires a standard end user account to execute.",
"response": {
"$ref": "GetSearchApplicationSessionStatsResponse"
},
"flatPath": "v1/stats/session/searchapplications/{searchapplicationsId}",
"path": "v1/stats/session/{+name}",
"id": "cloudsearch.stats.session.searchapplications.get",
"parameterOrder": [
"name"
],
"httpMethod": "GET"
}
}
}
}
},
"query": {
"resources": {
"searchapplications": {
"methods": {
"get": {
"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"
],
"flatPath": "v1/stats/query/searchapplications/{searchapplicationsId}",
"parameters": {
"fromDate.day": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"toDate.year": {
"type": "integer",
"description": "Year of date. Must be from 1 to 9999.",
"location": "query",
"format": "int32"
},
"name": {
"pattern": "^searchapplications/[^/]+$",
"description": "The resource id of the search application query stats, in the following format: searchapplications/{application_id}",
"required": true,
"location": "path",
"type": "string"
},
"toDate.day": {
"type": "integer",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"location": "query",
"format": "int32"
},
"fromDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"type": "integer",
"format": "int32",
"description": "Month of date. Must be from 1 to 12.",
"location": "query"
},
"toDate.month": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Month of date. Must be from 1 to 12."
}
},
"httpMethod": "GET",
"path": "v1/stats/query/{+name}",
"description": "Get the query statistics for search application. **Note:** This API requires a standard end user account to execute.",
"id": "cloudsearch.stats.query.searchapplications.get",
"response": {
"$ref": "GetSearchApplicationQueryStatsResponse"
},
"parameterOrder": [
"name"
]
}
}
}
}
}
},
"methods": {
"getSession": {
"id": "cloudsearch.stats.getSession",
"parameterOrder": [],
"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"
],
"path": "v1/stats/session",
"flatPath": "v1/stats/session",
"response": {
"$ref": "GetCustomerSessionStatsResponse"
},
"parameters": {
"fromDate.month": {
"type": "integer",
"description": "Month of date. Must be from 1 to 12.",
"location": "query",
"format": "int32"
},
"toDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"type": "integer",
"location": "query",
"format": "int32"
},
"toDate.day": {
"location": "query",
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer"
},
"fromDate.day": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"toDate.year": {
"format": "int32",
"location": "query",
"type": "integer",
"description": "Year of date. Must be from 1 to 9999."
},
"fromDate.year": {
"format": "int32",
"location": "query",
"type": "integer",
"description": "Year of date. Must be from 1 to 9999."
}
},
"description": "Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.",
"httpMethod": "GET"
},
"getIndex": {
"description": "Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. **Note:** This API requires a standard end user account to execute.",
"parameters": {
"toDate.month": {
"format": "int32",
"description": "Month of date. Must be from 1 to 12.",
"location": "query",
"type": "integer"
},
"fromDate.month": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "Month of date. Must be from 1 to 12."
},
"fromDate.year": {
"location": "query",
"description": "Year of date. Must be from 1 to 9999.",
"format": "int32",
"type": "integer"
},
"fromDate.day": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"toDate.day": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"toDate.year": {
"description": "Year of date. Must be from 1 to 9999.",
"location": "query",
"format": "int32",
"type": "integer"
}
},
"id": "cloudsearch.stats.getIndex",
"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"
],
"flatPath": "v1/stats/index",
"response": {
"$ref": "GetCustomerIndexStatsResponse"
},
"parameterOrder": [],
"path": "v1/stats/index",
"httpMethod": "GET"
},
"getQuery": {
"flatPath": "v1/stats/query",
"description": "Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.",
"parameters": {
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"location": "query",
"type": "integer",
"format": "int32"
},
"fromDate.year": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "Year of date. Must be from 1 to 9999."
},
"toDate.year": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "Year of date. Must be from 1 to 9999."
},
"toDate.month": {
"type": "integer",
"format": "int32",
"description": "Month of date. Must be from 1 to 12.",
"location": "query"
},
"fromDate.day": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
},
"toDate.day": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month."
}
},
"path": "v1/stats/query",
"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"
],
"id": "cloudsearch.stats.getQuery",
"response": {
"$ref": "GetCustomerQueryStatsResponse"
},
"parameterOrder": [],
"httpMethod": "GET"
},
"getUser": {
"description": "Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.",
"path": "v1/stats/user",
"httpMethod": "GET",
"parameterOrder": [],
"response": {
"$ref": "GetCustomerUserStatsResponse"
},
"flatPath": "v1/stats/user",
"id": "cloudsearch.stats.getUser",
"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"
],
"parameters": {
"fromDate.month": {
"description": "Month of date. Must be from 1 to 12.",
"format": "int32",
"location": "query",
"type": "integer"
},
"toDate.month": {
"type": "integer",
"format": "int32",
"location": "query",
"description": "Month of date. Must be from 1 to 12."
},
"fromDate.year": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Year of date. Must be from 1 to 9999."
},
"toDate.year": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Year of date. Must be from 1 to 9999."
},
"toDate.day": {
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer",
"location": "query"
},
"fromDate.day": {
"format": "int32",
"type": "integer",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"location": "query"
}
}
}
}
},
"media": {
"methods": {
"upload": {
"response": {
"$ref": "Media"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"supportsMediaUpload": true,
"id": "cloudsearch.media.upload",
"flatPath": "v1/media/{mediaId}",
"parameterOrder": [
"resourceName"
],
"request": {
"$ref": "Media"
},
"path": "v1/media/{+resourceName}",
"parameters": {
"resourceName": {
"pattern": "^.*$",
"type": "string",
"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.",
"required": true,
"location": "path"
}
},
"description": "Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.",
"mediaUpload": {
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1/media/{+resourceName}"
}
},
"accept": [
"*/*"
]
},
"httpMethod": "POST"
}
}
},
"indexing": {
"resources": {
"datasources": {
"resources": {
"items": {
"methods": {
"deleteQueueItems": {
"description": "Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"path": "v1/indexing/{+name}/items:deleteQueueItems",
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "DeleteQueueItemsRequest"
},
"parameters": {
"name": {
"description": "Name of the Data Source to delete items in a queue. Format: datasources/{source_id}",
"type": "string",
"pattern": "^datasources/[^/]+$",
"required": true,
"location": "path"
}
},
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:deleteQueueItems",
"parameterOrder": [
"name"
],
"id": "cloudsearch.indexing.datasources.items.deleteQueueItems",
"httpMethod": "POST"
},
"poll": {
"response": {
"$ref": "PollItemsResponse"
},
"path": "v1/indexing/{+name}/items:poll",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:poll",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"description": "Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"id": "cloudsearch.indexing.datasources.items.poll",
"request": {
"$ref": "PollItemsRequest"
},
"parameters": {
"name": {
"location": "path",
"required": true,
"type": "string",
"pattern": "^datasources/[^/]+$",
"description": "Name of the Data Source to poll items. Format: datasources/{source_id}"
}
},
"parameterOrder": [
"name"
],
"httpMethod": "POST"
},
"unreserve": {
"id": "cloudsearch.indexing.datasources.items.unreserve",
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^datasources/[^/]+$",
"description": "Name of the Data Source to unreserve all items. Format: datasources/{source_id}",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:unreserve",
"path": "v1/indexing/{+name}/items:unreserve",
"request": {
"$ref": "UnreserveItemsRequest"
},
"response": {
"$ref": "Operation"
},
"description": "Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source."
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"parameters": {
"debugOptions.enableDebugging": {
"location": "query",
"type": "boolean",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
},
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"name": {
"description": "Name of the item to get info. Format: datasources/{source_id}/items/{item_id}",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"location": "path",
"type": "string"
}
},
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}",
"id": "cloudsearch.indexing.datasources.items.get",
"description": "Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"path": "v1/indexing/{+name}",
"response": {
"$ref": "Item"
}
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"id": "cloudsearch.indexing.datasources.items.delete",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}",
"parameters": {
"mode": {
"type": "string",
"enum": [
"UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"description": "Required. The RequestMode for this request.",
"enumDescriptions": [
"Priority is not specified in the update request. Leaving priority unspecified results in an update failure.",
"For real-time updates.",
"For changes that are executed after the response is sent back to the caller."
],
"location": "query"
},
"name": {
"pattern": "^datasources/[^/]+/items/[^/]+$",
"description": "Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id}",
"type": "string",
"location": "path",
"required": true
},
"debugOptions.enableDebugging": {
"type": "boolean",
"location": "query",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
},
"version": {
"location": "query",
"type": "string",
"description": "Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.",
"format": "byte"
},
"connectorName": {
"location": "query",
"type": "string",
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}"
}
},
"httpMethod": "DELETE",
"response": {
"$ref": "Operation"
},
"path": "v1/indexing/{+name}",
"parameterOrder": [
"name"
],
"description": "Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source."
},
"list": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"parameterOrder": [
"name"
],
"description": "Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"response": {
"$ref": "ListItemsResponse"
},
"path": "v1/indexing/{+name}/items",
"id": "cloudsearch.indexing.datasources.items.list",
"parameters": {
"name": {
"pattern": "^datasources/[^/]+$",
"description": "Name of the Data Source to list Items. Format: datasources/{source_id}",
"location": "path",
"type": "string",
"required": true
},
"brief": {
"type": "boolean",
"description": "When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.",
"location": "query"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. The default value is 10",
"location": "query",
"format": "int32",
"type": "integer"
},
"connectorName": {
"description": "Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"type": "string",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The next_page_token value returned from a previous List request, if any."
}
},
"flatPath": "v1/indexing/datasources/{datasourcesId}/items"
},
"upload": {
"id": "cloudsearch.indexing.datasources.items.upload",
"description": "Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"parameters": {
"name": {
"type": "string",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"description": "Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes.",
"location": "path",
"required": true
}
},
"response": {
"$ref": "UploadItemRef"
},
"request": {
"$ref": "StartUploadItemRequest"
},
"path": "v1/indexing/{+name}:upload",
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:upload"
},
"index": {
"parameterOrder": [
"name"
],
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:index",
"response": {
"$ref": "Operation"
},
"id": "cloudsearch.indexing.datasources.items.index",
"description": "Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"path": "v1/indexing/{+name}:index",
"request": {
"$ref": "IndexItemRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"httpMethod": "POST",
"parameters": {
"name": {
"required": true,
"location": "path",
"type": "string",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"description": "Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters."
}
}
},
"push": {
"description": "Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"id": "cloudsearch.indexing.datasources.items.push",
"path": "v1/indexing/{+name}:push",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:push",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"httpMethod": "POST",
"parameters": {
"name": {
"type": "string",
"required": true,
"description": "Name of the item to push into the indexing queue. Format: datasources/{source_id}/items/{ID} This is a required field. The maximum length is 1536 characters.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$"
}
},
"response": {
"$ref": "Item"
},
"request": {
"$ref": "PushItemRequest"
},
"parameterOrder": [
"name"
]
}
}
}
},
"methods": {
"getSchema": {
"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"
],
"path": "v1/indexing/{+name}/schema",
"description": "Gets the schema of a data source. **Note:** This API requires an admin or service account to execute.",
"parameterOrder": [
"name"
],
"id": "cloudsearch.indexing.datasources.getSchema",
"response": {
"$ref": "Schema"
},
"httpMethod": "GET",
"parameters": {
"debugOptions.enableDebugging": {
"location": "query",
"type": "boolean",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field."
},
"name": {
"required": true,
"type": "string",
"location": "path",
"pattern": "^datasources/[^/]+$",
"description": "Name of the data source to get Schema. Format: datasources/{source_id}"
}
},
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema"
},
"deleteSchema": {
"description": "Deletes the schema of a data source. **Note:** This API requires an admin or service account to execute.",
"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"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"type": "boolean",
"location": "query"
},
"name": {
"type": "string",
"required": true,
"location": "path",
"pattern": "^datasources/[^/]+$",
"description": "Name of the data source to delete Schema. Format: datasources/{source_id}"
}
},
"parameterOrder": [
"name"
],
"id": "cloudsearch.indexing.datasources.deleteSchema",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"response": {
"$ref": "Operation"
},
"httpMethod": "DELETE",
"path": "v1/indexing/{+name}/schema"
},
"updateSchema": {
"response": {
"$ref": "Operation"
},
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"parameterOrder": [
"name"
],
"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"
],
"path": "v1/indexing/{+name}/schema",
"request": {
"$ref": "UpdateSchemaRequest"
},
"httpMethod": "PUT",
"id": "cloudsearch.indexing.datasources.updateSchema",
"description": "Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema. **Note:** This API requires an admin or service account to execute.",
"parameters": {
"name": {
"location": "path",
"required": true,
"type": "string",
"pattern": "^datasources/[^/]+$",
"description": "Name of the data source to update Schema. Format: datasources/{source_id}"
}
}
}
}
}
}
},
"operations": {
"methods": {
"get": {
"id": "cloudsearch.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"httpMethod": "GET",
"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"
],
"flatPath": "v1/operations/{operationsId}",
"parameters": {
"name": {
"location": "path",
"type": "string",
"pattern": "^operations/.*$",
"required": true,
"description": "The name of the operation resource."
}
},
"path": "v1/{+name}",
"parameterOrder": [
"name"
]
}
},
"resources": {
"lro": {
"methods": {
"list": {
"parameters": {
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"required": true,
"type": "string",
"pattern": "^operations/.*$"
},
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
},
"pageSize": {
"format": "int32",
"location": "query",
"description": "The standard list page size.",
"type": "integer"
},
"pageToken": {
"type": "string",
"description": "The standard list page token.",
"location": "query"
}
},
"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"
],
"response": {
"$ref": "ListOperationsResponse"
},
"id": "cloudsearch.operations.lro.list",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/operations/{operationsId}/lro",
"parameterOrder": [
"name"
],
"path": "v1/{+name}/lro",
"httpMethod": "GET"
}
}
}
}
},
"debug": {
"resources": {
"datasources": {
"resources": {
"items": {
"resources": {
"unmappedids": {
"methods": {
"list": {
"path": "v1/debug/{+parent}/unmappedids",
"response": {
"$ref": "ListUnmappedIdentitiesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"flatPath": "v1/debug/datasources/{datasourcesId}/items/{itemsId}/unmappedids",
"parameters": {
"parent": {
"required": true,
"pattern": "^datasources/[^/]+/items/[^/]+$",
"location": "path",
"description": "The name of the item, in the following format: datasources/{source_id}/items/{ID}",
"type": "string"
},
"pageSize": {
"type": "integer",
"description": "Maximum number of items to fetch in a request. Defaults to 100.",
"format": "int32",
"location": "query"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"type": "boolean",
"location": "query"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
}
},
"description": "List all unmapped identities for a specific item. **Note:** This API requires an admin account to execute.",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
],
"id": "cloudsearch.debug.datasources.items.unmappedids.list"
}
}
}
},
"methods": {
"checkAccess": {
"response": {
"$ref": "CheckAccessResponse"
},
"parameters": {
"debugOptions.enableDebugging": {
"type": "boolean",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query"
},
"name": {
"type": "string",
"required": true,
"pattern": "^datasources/[^/]+/items/[^/]+$",
"location": "path",
"description": "Item name, format: datasources/{source_id}/items/{item_id}"
}
},
"request": {
"$ref": "Principal"
},
"flatPath": "v1/debug/datasources/{datasourcesId}/items/{itemsId}:checkAccess",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
],
"httpMethod": "POST",
"description": "Checks whether an item is accessible by specified principal. **Note:** This API requires an admin account to execute.",
"path": "v1/debug/{+name}:checkAccess",
"id": "cloudsearch.debug.datasources.items.checkAccess",
"parameterOrder": [
"name"
]
},
"searchByViewUrl": {
"httpMethod": "POST",
"request": {
"$ref": "SearchItemsByViewUrlRequest"
},
"id": "cloudsearch.debug.datasources.items.searchByViewUrl",
"response": {
"$ref": "SearchItemsByViewUrlResponse"
},
"parameterOrder": [
"name"
],
"path": "v1/debug/{+name}/items:searchByViewUrl",
"parameters": {
"name": {
"location": "path",
"description": "Source name, format: datasources/{source_id}",
"type": "string",
"required": true,
"pattern": "^datasources/[^/]+$"
}
},
"flatPath": "v1/debug/datasources/{datasourcesId}/items:searchByViewUrl",
"description": "Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
}
}
},
"identitysources": {
"resources": {
"unmappedids": {
"methods": {
"list": {
"response": {
"$ref": "ListUnmappedIdentitiesResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"id": "cloudsearch.debug.identitysources.unmappedids.list",
"parameters": {
"parent": {
"required": true,
"pattern": "^identitysources/[^/]+$",
"type": "string",
"description": "The name of the identity source, in the following format: identitysources/{source_id}",
"location": "path"
},
"resolutionStatusCode": {
"enum": [
"CODE_UNSPECIFIED",
"NOT_FOUND",
"IDENTITY_SOURCE_NOT_FOUND",
"IDENTITY_SOURCE_MISCONFIGURED",
"TOO_MANY_MAPPINGS_FOUND",
"INTERNAL_ERROR"
],
"enumDescriptions": [
"Input-only value. Used to list all unmapped identities regardless of status.",
"The unmapped identity was not found in IDaaS, and needs to be provided by the user.",
"The identity source associated with the identity was either not found or deleted.",
"IDaaS does not understand the identity source, probably because the schema was modified in a non compatible way.",
"The number of users associated with the external identity is too large.",
"Internal error."
],
"description": "Limit users selection to this status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request. Defaults to 100.",
"location": "query",
"format": "int32",
"type": "integer"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The next_page_token value returned from a previous List request, if any."
},
"debugOptions.enableDebugging": {
"type": "boolean",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query"
}
},
"description": "Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/identitysources/{identitysourcesId}/unmappedids",
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
],
"path": "v1/debug/{+parent}/unmappedids"
}
}
},
"items": {
"methods": {
"listForunmappedidentity": {
"id": "cloudsearch.debug.identitysources.items.listForunmappedidentity",
"flatPath": "v1/debug/identitysources/{identitysourcesId}/items:forunmappedidentity",
"description": "Lists names of items associated with an unmapped identity. **Note:** This API requires an admin account to execute.",
"parameters": {
"parent": {
"required": true,
"type": "string",
"description": "The name of the identity source, in the following format: identitysources/{source_id}}",
"pattern": "^identitysources/[^/]+$",
"location": "path"
},
"groupResourceName": {
"location": "query",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Maximum number of items to fetch in a request. Defaults to 100.",
"location": "query",
"type": "integer"
},
"userResourceName": {
"type": "string",
"location": "query"
},
"pageToken": {
"location": "query",
"description": "The next_page_token value returned from a previous List request, if any.",
"type": "string"
},
"debugOptions.enableDebugging": {
"location": "query",
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"type": "boolean"
}
},
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListItemNamesForUnmappedIdentityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
],
"path": "v1/debug/{+parent}/items:forunmappedidentity",
"httpMethod": "GET"
}
}
}
}
}
}
}
},
"version": "v1",
"mtlsRootUrl": "https://cloudsearch.mtls.googleapis.com/",
"version_module": true,
"ownerDomain": "google.com",
"baseUrl": "https://cloudsearch.googleapis.com/",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"batchPath": "batch",
"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",
"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.stats": {
"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": {
"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"
},
"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.debug": {
"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.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
}
}
}
}
}