class Query extends Resource (View source)

The "query" collection of methods.

Typical usage is:

 $cloudsearchService = new Google\Service\CloudSearch(...);
 $query = $cloudsearchService->query;

Methods

debugSearch(SearchRequest $postBody, array $optParams = [])

Returns Debug information for Cloud Search Query API provides the search method. 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 Google Workspace domain-wide delegation of authority. (query.debugSearch)

removeActivity(RemoveActivityRequest $postBody, array $optParams = [])

Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients Note: This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority. (query.removeActivity)

search(SearchRequest $postBody, array $optParams = [])

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace 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 Google Workspace domain-wide delegation of authority. (query.search)

suggest(SuggestRequest $postBody, array $optParams = [])

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 Google Workspace domain-wide delegation of authority. (query.suggest)

Details

DebugResponse debugSearch(SearchRequest $postBody, array $optParams = [])

Returns Debug information for Cloud Search Query API provides the search method. 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 Google Workspace domain-wide delegation of authority. (query.debugSearch)

Parameters

SearchRequest $postBody
array $optParams

Optional parameters.

Return Value

DebugResponse

Exceptions

Exception

RemoveActivityResponse removeActivity(RemoveActivityRequest $postBody, array $optParams = [])

Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients Note: This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority. (query.removeActivity)

Parameters

RemoveActivityRequest $postBody
array $optParams

Optional parameters.

Return Value

RemoveActivityResponse

Exceptions

Exception

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace 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 Google Workspace domain-wide delegation of authority. (query.search)

Parameters

SearchRequest $postBody
array $optParams

Optional parameters.

Return Value

SearchResponse

Exceptions

Exception

SuggestResponse suggest(SuggestRequest $postBody, array $optParams = [])

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 Google Workspace domain-wide delegation of authority. (query.suggest)

Parameters

SuggestRequest $postBody
array $optParams

Optional parameters.

Return Value

SuggestResponse

Exceptions

Exception