Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.

Represents the settings for Cloud audit logging

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.

The options for boolean properties.

A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Aggregation of items by status code as of the specified date.

Search application stats for a customer for the given date.

Represents settings at a customer level.

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.

Aggregation of items by status code as of the specified date.

Restriction on Datasource.

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. The date must be a valid calendar date between the year 1 and 9999.

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.

The options for date properties.

List of date values.

Additional options for CloudSearch#debugDatasourcesItemsCheckAccess.

Additional options for CloudSearch#debugDatasourcesItemsUnmappedidsList.

Additional options for CloudSearch#debugIdentitysourcesItemsListForunmappedidentity.

Additional options for CloudSearch#debugIdentitysourcesUnmappedidsList.

Shared request debug options for all cloudsearch RPC methods.

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.

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.

The options for double properties.

List of double values.

Drive follow-up search restricts (e.g. "followup:suggestions").

Drive location search restricts (e.g. "is:starred").

Drive mime-type search restricts (e.g. "type:pdf").

The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").

A person's email address.

An AgendaEntry, e.g., a Calendar Event.

The context that resulted in the generation of the card.

A list of answers represented as free text.

An answer with a corresponding label.

Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. "what can I search for?").

Contains a list of suggested queries for a single category.

Wrapper proto for the Assist cards.

Card metadata.

Container of debugging information in all object levels. Extend as needed.

Representation of a document. NEXT_TAG: 15

Meta data for drive documents.

Justification of why we are reporting the document.

Common representation of a person.

Conflicting meetings card proto.

Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.

Response to find meeting time among a set of people.

Get and keep ahead card

A list of events where all guests declined.

Errors in the creation of meeting notes.

Information about the meeting notes created.

Meeting notes card request.

Metadata about the NLP interpretation of the query.

Metadata for disambiguation.

A person that also matches the query, but was not selected due to a lower affinity with the requesting user.

Recommended header to display for the card.

An answer card for a single person.

An answer card for a list of people that are related to the subject of the query.

Person.

Personalized docs card proto.

Ranking params.

Details about scheduled meetings.

Share meeting docs card proto.

Slot of time.

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.

The 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.

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.

List of enum values.

Error information about the response.

Error message per source response.

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.

Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.

Source specific facet response

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.

Filter options to be applied on query.

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.

Response format for search application stats for a customer.

Response format for getting query stats for a search application between given dates.

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.

The options for html properties.

List of html values.

Additional options for CloudSearch#indexingDatasourcesDeleteSchema.

Additional options for CloudSearch#indexingDatasourcesGetSchema.

Additional options for CloudSearch#indexingDatasourcesItemsDelete.

Additional options for CloudSearch#indexingDatasourcesItemsGet.

Additional options for CloudSearch#indexingDatasourcesItemsList.

Request message for InitializeCustomer method.

Used to specify integer faceting options.

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.

The options for integer properties.

List of integer values.

Represents an interaction between a user and an item.

Represents a single object that is an item in the search index, such as a file, folder, or a database record.

Access control list information for the item. For more information see Map ACLs.

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.

Available metadata fields for the item.

This contains item's status and any errors.

Available structured data fields for the item.

The response message for Operations.ListOperations.

List sources response.

Geo information used for rendering a map that shows the user's work location.

Information used to render a map tile image in the proper location on a map.

Matched range of a snippet [start, end).

Media resource.

Metadata of a matched search result.

A metaline is a list of properties that are displayed along with the search result to provide context.

A person's name.

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.

The definition for an object within a data source.

The display options for an object.

The options for an object.

The options for object properties.

List of object values.

This resource represents a long-running operation that is the result of a network API call.

Additional options for CloudSearch#operationsLroList.

This field contains information about the person being suggested.

Object to represent a person.

Information for rendering a person. NEXT ID: 37

A person's Phone Number

A person's photo.

Reference to a user, group, or domain.

The definition of a property within an object.

The display options for a property.

Represents an item to be pushed to the indexing queue.

Details about a user's query activity.

Default options to interpret user query.

Options to interpret user query.

Information relevant only to a query entry.

The definition of a operator that can be used in a Search/Suggest request.

List of sources that the user can search using the query API.

Additional options for CloudSearch#querySourcesList.

This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.

Remove Logged Activity Request.

Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.

Errors when the connector is communicating to the source repository.

Shared request options for all RPC methods.

Debugging information about the response.

Information relevant only to a restrict entry. NextId: 12

Result count information

Debugging information about the result.

Display Fields for Search Results

The collection of fields that make up a displayed line

IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.

Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.

The schema definition for a data source.

Scoring configurations for a source while processing a Search or Suggest request.

SearchApplication

Search application level query stats per date

Additional search quality metadata of the item.

The search API request.

The search API response.

Results containing indexed information for a document.

Additional options for CloudSearch#settingsDatasourcesDelete.

Additional options for CloudSearch#settingsDatasourcesGet.

Additional options for CloudSearch#settingsDatasourcesList.

Additional options for CloudSearch#settingsDatasourcesPatch.

Additional options for CloudSearch#settingsSearchapplicationsDelete.

Additional options for CloudSearch#settingsSearchapplicationsGet.

Additional options for CloudSearch#settingsSearchapplicationsList.

Additional options for CloudSearch#settingsSearchapplicationsPatch.

Additional options for CloudSearch#settingsSearchapplicationsUpdate.

Additional options for CloudSearch#settingsUpdateCustomer.

Snippet of the search result, which summarizes the content of the resulting page.

Defines sources for the suggest/search APIs.

Configurations for a source while processing a Search or Suggest request.

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.

Per source result count information.

Set the scoring configuration. This allows modifying the ranking of results for a source.

Start upload file request.

Additional options for CloudSearch#statsGetIndex.

Additional options for CloudSearch#statsGetQuery.

Additional options for CloudSearch#statsGetSearchapplication.

Additional options for CloudSearch#statsGetSession.

Additional options for CloudSearch#statsGetUser.

Additional options for CloudSearch#statsIndexDatasourcesGet.

Additional options for CloudSearch#statsQuerySearchapplicationsGet.

Additional options for CloudSearch#statsSessionSearchapplicationsGet.

Additional options for CloudSearch#statsUserSearchapplicationsGet.

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. 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.

A structured data object consisting of named properties.

Structured results that are returned as part of search request.

Request of suggest API.

Response of the suggest API.

One suggestion result.

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.

The options for text properties.

List of text values.

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.

The options for timestamp properties.

List of timestamp values.

Represents an upload session reference. This reference is created via upload method. This reference is valid for 30 days after its creation. Updating of item content may refer to this uploaded content via contentDataRef.

User's single or bulk query activity. This can be a logging query or deletion query.

Definition of a single value with generic type.