class Google::Apis::CustomsearchV1::Search::Queries::NextPage

Custom search request metadata.

Attributes

count[RW]

Number of search results returned in this set. Corresponds to the JSON property `count` @return [Fixnum]

cr[RW]

Restricts search results to documents originating in a particular country. You may use [Boolean operators](developers.google.com/custom-search/docs/ xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top- level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](developers. google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter. Corresponds to the JSON property `cr` @return [String]

cx[RW]

The identifier of an engine created using the Programmable Search Engine [ Control Panel](programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is required. Corresponds to the JSON property `cx` @return [String]

date_restrict[RW]

Restricts results to URLs based on date. Supported values include: * `d `: requests results from the specified number of past days. * `w`: requests results from the specified number of past weeks. * `m`: requests results from the specified number of past months. * `y`: requests results from the specified number of past years. Corresponds to the JSON property `dateRestrict` @return [String]

disable_cn_tw_translation[RW]

Enables or disables the [Simplified and Traditional Chinese Search](https:// developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled Corresponds to the JSON property `disableCnTwTranslation` @return [String]

exact_terms[RW]

Identifies a phrase that all documents in the search results must contain. Corresponds to the JSON property `exactTerms` @return [String]

exclude_terms[RW]

Identifies a word or phrase that should not appear in any documents in the search results. Corresponds to the JSON property `excludeTerms` @return [String]

file_type[RW]

Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (` ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, ` wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (` swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https:// support.google.com/webmasters/answer/35287). Corresponds to the JSON property `fileType` @return [String]

filter[RW]

Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](developers.google.com/custom-search/docs/ xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) Note: By default, Google applies filtering to all search results to improve the quality of those results. Corresponds to the JSON property `filter` @return [String]

gl[RW]

Boosts search results whose country of origin matches the parameter value. See [Country Codes](developers.google.com/custom-search/docs/xml_results# countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States. Corresponds to the JSON property `gl` @return [String]

google_host[RW]

Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. Corresponds to the JSON property `googleHost` @return [String]

high_range[RW]

Specifies the ending value for a search range. Use `cse:lowRange` and `cse: highrange` to append an inclusive search range of `lowRange…highRange` to the query. Corresponds to the JSON property `highRange` @return [String]

hl[RW]

Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](developers.google. com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [ Internationalizing Queries and Results Presentation](developers.google. com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](developers.google.com/custom- search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages. Corresponds to the JSON property `hl` @return [String]

hq[RW]

Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. Corresponds to the JSON property `hq` @return [String]

img_color_type[RW]

Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) Corresponds to the JSON property `imgColorType` @return [String]

img_dominant_color[RW]

Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * ` pink` * `white` * `gray` * `black` * `brown` Corresponds to the JSON property `imgDominantColor` @return [String]

img_size[RW]

Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * ` huge` (extra-large) Corresponds to the JSON property `imgSize` @return [String]

img_type[RW]

Restricts results to images of a specified type. Supported values are: * ` clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` ( Photo) * `animated` (Animated) * `stock` (Stock) Corresponds to the JSON property `imgType` @return [String]

input_encoding[RW]

The character encoding supported for search requests. Corresponds to the JSON property `inputEncoding` @return [String]

language[RW]

The language of the search results. Corresponds to the JSON property `language` @return [String]

low_range[RW]

Specifies the starting value for a search range. Use `cse:lowRange` and `cse: highrange` to append an inclusive search range of `lowRange…highRange` to the query. Corresponds to the JSON property `lowRange` @return [String]

or_terms[RW]

Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](developers.google.com/ custom-search/docs/xml_results#BooleanOrqt) query term for this type of query. Corresponds to the JSON property `orTerms` @return [String]

output_encoding[RW]

The character encoding supported for search results. Corresponds to the JSON property `outputEncoding` @return [String]

rights[RW]

Filters based on licensing. Supported values include: * `cc_publicdomain` * ` cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` Corresponds to the JSON property `rights` @return [String]

safe[RW]

Specifies the [SafeSearch level](developers.google.com/custom-search/ docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `“off”`: Disable SafeSearch * `“active”`: Enable SafeSearch Corresponds to the JSON property `safe` @return [String]

search_terms[RW]

The search terms entered by the user. Corresponds to the JSON property `searchTerms` @return [String]

search_type[RW]

Allowed values are `web` or `image`. If unspecified, results are limited to webpages. Corresponds to the JSON property `searchType` @return [String]

site_search_filter[RW]

Specifies whether to include or exclude results from the site named in the ` sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site Corresponds to the JSON property `siteSearchFilter` @return [String]

sort[RW]

Specifies that results should be sorted according to the specified expression. For example, sort by date. Corresponds to the JSON property `sort` @return [String]

start_index[RW]

The index of the current set of search results into the total set of results, where the index of the first result is 1. Corresponds to the JSON property `startIndex` @return [Fixnum]

start_page[RW]

The page number of this set of results, where the page length is set by the ` count` property. Corresponds to the JSON property `startPage` @return [Fixnum]

title[RW]

A description of the query. Corresponds to the JSON property `title` @return [String]

total_results[RW]

Estimated number of total search results. May not be accurate. Corresponds to the JSON property `totalResults` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/customsearch_v1/classes.rb, line 688
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 693
def update!(**args)
  @count = args[:count] if args.key?(:count)
  @cr = args[:cr] if args.key?(:cr)
  @cx = args[:cx] if args.key?(:cx)
  @date_restrict = args[:date_restrict] if args.key?(:date_restrict)
  @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation)
  @exact_terms = args[:exact_terms] if args.key?(:exact_terms)
  @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms)
  @file_type = args[:file_type] if args.key?(:file_type)
  @filter = args[:filter] if args.key?(:filter)
  @gl = args[:gl] if args.key?(:gl)
  @google_host = args[:google_host] if args.key?(:google_host)
  @high_range = args[:high_range] if args.key?(:high_range)
  @hl = args[:hl] if args.key?(:hl)
  @hq = args[:hq] if args.key?(:hq)
  @img_color_type = args[:img_color_type] if args.key?(:img_color_type)
  @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color)
  @img_size = args[:img_size] if args.key?(:img_size)
  @img_type = args[:img_type] if args.key?(:img_type)
  @input_encoding = args[:input_encoding] if args.key?(:input_encoding)
  @language = args[:language] if args.key?(:language)
  @link_site = args[:link_site] if args.key?(:link_site)
  @low_range = args[:low_range] if args.key?(:low_range)
  @or_terms = args[:or_terms] if args.key?(:or_terms)
  @output_encoding = args[:output_encoding] if args.key?(:output_encoding)
  @related_site = args[:related_site] if args.key?(:related_site)
  @rights = args[:rights] if args.key?(:rights)
  @safe = args[:safe] if args.key?(:safe)
  @search_terms = args[:search_terms] if args.key?(:search_terms)
  @search_type = args[:search_type] if args.key?(:search_type)
  @site_search = args[:site_search] if args.key?(:site_search)
  @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter)
  @sort = args[:sort] if args.key?(:sort)
  @start_index = args[:start_index] if args.key?(:start_index)
  @start_page = args[:start_page] if args.key?(:start_page)
  @title = args[:title] if args.key?(:title)
  @total_results = args[:total_results] if args.key?(:total_results)
end