Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 2.4 KB

File metadata and controls

15 lines (12 loc) · 2.4 KB

# SearchRequest

Properties

Name Type Description Notes
entity_types string[] One or more types of resources expected in the response. Currently only `driveItem` is supported.
query \OpenAPI\Client\Model\SearchQuery
from int Specifies the offset for the search results. Offset 0 returns the very first result. Used together with the `size` property for pagination. [optional] [default to 0]
size int The size of the page to be retrieved. The maximum value is 500. Set to 0 to return only aggregations without any hits. [optional] [default to 25]
aggregations \OpenAPI\Client\Model\AggregationOption[] Specifies aggregations (also known as refiners or facets) to be returned alongside the search results. Optional. [optional]
aggregation_filters string[] Contains one or more filters to narrow search results to specific buckets of a prior aggregation. Build each filter from the response of a prior search that aggregated on the same field: take the `aggregationFilterToken` of the wanted `searchBucket` and combine it with the field as `{field}:{aggregationFilterToken}`, e.g. `audio.artist:"ǂǂ5361786f6e"` for a terms bucket or `audio.year:range(1980, 1990)` for a range bucket. Several buckets of the same field are combined with `{field}:or({aggregationFilterToken},{aggregationFilterToken})`. Whitespace after the commas of `range(...)` and `or(...)` is optional. Multiple filters can be provided as separate array items. This results in a logical AND between the filters. Filters that are not built from server-issued tokens are rejected with `invalidRequest`. [optional]
sort_properties \OpenAPI\Client\Model\SortProperty[] Contains the ordered collection of fields to sort the results on, primary sort key first. At most 5 sort properties. If absent, the results are sorted by relevance. See `sortProperty.name` for the set of sortable fields. Ties are broken by relevance, and results missing the sort property are placed last. Optional. [optional]

[Back to Model list] [Back to API list] [Back to README]