class Google::Apis::CustomsearchV1::Search

Response to a custom search request.

Attributes

context[RW]

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](developers.google.com/custom-search/docs/refinements#create) ( refinements) you can use for refining a search. Corresponds to the JSON property `context` @return [Hash<String,Object>]

items[RW]

The current set of custom search results. Corresponds to the JSON property `items` @return [Array<Google::Apis::CustomsearchV1::Result>]

kind[RW]

Unique identifier for the type of current object. For this API, it is customsearch#search. Corresponds to the JSON property `kind` @return [String]

promotions[RW]

The set of [promotions](developers.google.com/custom-search/docs/ promotions). Present only if the custom search engine's configuration files define any promotions for the given query. Corresponds to the JSON property `promotions` @return [Array<Google::Apis::CustomsearchV1::Promotion>]

queries[RW]

Query metadata for the previous, current, and next pages of results. Corresponds to the JSON property `queries` @return [Google::Apis::CustomsearchV1::Search::Queries]

search_information[RW]

Metadata about a search operation. Corresponds to the JSON property `searchInformation` @return [Google::Apis::CustomsearchV1::Search::SearchInformation]

spelling[RW]

Spell correction information for a query. Corresponds to the JSON property `spelling` @return [Google::Apis::CustomsearchV1::Search::Spelling]

url[RW]

OpenSearch template and URL. Corresponds to the JSON property `url` @return [Google::Apis::CustomsearchV1::Search::Url]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/customsearch_v1/classes.rb, line 389
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/customsearch_v1/classes.rb, line 394
def update!(**args)
  @context = args[:context] if args.key?(:context)
  @items = args[:items] if args.key?(:items)
  @kind = args[:kind] if args.key?(:kind)
  @promotions = args[:promotions] if args.key?(:promotions)
  @queries = args[:queries] if args.key?(:queries)
  @search_information = args[:search_information] if args.key?(:search_information)
  @spelling = args[:spelling] if args.key?(:spelling)
  @url = args[:url] if args.key?(:url)
end