google_api_custom_search v0.14.2 GoogleApi.CustomSearch.V1.Model.Search View Source

Response to a custom search request.

Attributes

context (type: map(), default: nil) - Metadata and refinements associated with the given search engine, including:
- The name of the search engine that was used for the query.
- A set of facet objects (refinements) you can use for refining a search.
items (type: list(GoogleApi.CustomSearch.V1.Model.Result.t), default: nil) - The current set of custom search results.
kind (type: String.t, default: nil) - Unique identifier for the type of current object. For this API, it is customsearch#search.
promotions (type: list(GoogleApi.CustomSearch.V1.Model.Promotion.t), default: nil) - The set of promotions. Present only if the custom search engine's configuration files define any promotions for the given query.
queries (type: GoogleApi.CustomSearch.V1.Model.SearchQueries.t, default: nil) - Query metadata for the previous, current, and next pages of results.
searchInformation (type: GoogleApi.CustomSearch.V1.Model.SearchSearchInformation.t, default: nil) - Metadata about a search operation.
spelling (type: GoogleApi.CustomSearch.V1.Model.SearchSpelling.t, default: nil) - Spell correction information for a query.
url (type: GoogleApi.CustomSearch.V1.Model.SearchUrl.t, default: nil) - OpenSearch template and URL.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

Specs

t() :: %GoogleApi.CustomSearch.V1.Model.Search{
  context: map(),
  items: [GoogleApi.CustomSearch.V1.Model.Result.t()],
  kind: String.t(),
  promotions: [GoogleApi.CustomSearch.V1.Model.Promotion.t()],
  queries: GoogleApi.CustomSearch.V1.Model.SearchQueries.t(),
  searchInformation:
    GoogleApi.CustomSearch.V1.Model.SearchSearchInformation.t(),
  spelling: GoogleApi.CustomSearch.V1.Model.SearchSpelling.t(),
  url: GoogleApi.CustomSearch.V1.Model.SearchUrl.t()
}

Link to this section Functions

decode(value, options)

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.