View Source GoogleApi.CustomSearch.V1.Model.SearchQueriesNextPage (google_api_custom_search v0.22.0)

Custom search request metadata.

Attributes

rights (type: String.t, default: nil) - Filters based on licensing. Supported values include: cc_publicdomain cc_attribute cc_sharealike cc_noncommercial * cc_nonderived
hq (type: String.t, default: nil) - Appends the specified query terms to the query, as if they were combined with a logical AND operator.
imgDominantColor (type: String.t, default: nil) - Restricts results to images with a specific dominant color. Supported values are: red orange yellow green teal blue purple pink white gray black brown
inputEncoding (type: String.t, default: nil) - The character encoding supported for search requests.
cx (type: String.t, default: nil) - The identifier of an engine created using the Programmable Search Engine Control Panel. This is a custom property not defined in the OpenSearch spec. This parameter is required.
excludeTerms (type: String.t, default: nil) - Identifies a word or phrase that should not appear in any documents in the search results.
outputEncoding (type: String.t, default: nil) - The character encoding supported for search results.
startPage (type: integer(), default: nil) - The page number of this set of results, where the page length is set by the count property.
siteSearchFilter (type: String.t, default: nil) - 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
dateRestrict (type: String.t, default: nil) - Restricts results to URLs based on date. Supported values include: d[number]: requests results from the specified number of past days. w[number]: requests results from the specified number of past weeks. m[number]: requests results from the specified number of past months. y[number]: requests results from the specified number of past years.
totalResults (type: String.t, default: nil) - Estimated number of total search results. May not be accurate.
count (type: integer(), default: nil) - Number of search results returned in this set.
relatedSite (type: String.t, default: nil) - Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.
googleHost (type: String.t, default: nil) - Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.
siteSearch (type: String.t, default: nil) - Restricts results to URLs from a specified site.
gl (type: String.t, default: nil) - Boosts search results whose country of origin matches the parameter value. See Country Codes 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.
exactTerms (type: String.t, default: nil) - Identifies a phrase that all documents in the search results must contain.
searchType (type: String.t, default: nil) - Allowed values are web or image. If unspecified, results are limited to webpages.
searchTerms (type: String.t, default: nil) - The search terms entered by the user.
imgColorType (type: String.t, default: nil) - Restricts results to images of a specified color type. Supported values are: mono (black and white) gray (grayscale) * color (color)
imgType (type: String.t, default: nil) - 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)
filter (type: String.t, default: nil) - Activates or deactivates the automatic filtering of Google search results. See Automatic Filtering 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.
language (type: String.t, default: nil) - The language of the search results.
sort (type: String.t, default: nil) - Specifies that results should be sorted according to the specified expression. For example, sort by date.
lowRange (type: String.t, default: nil) - 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.
imgSize (type: String.t, default: nil) - Restricts results to images of a specified size. Supported values are: icon (small) small | medium | large | xlarge (medium) xxlarge (large) huge (extra-large)
startIndex (type: integer(), default: nil) - The index of the current set of search results into the total set of results, where the index of the first result is 1.
fileType (type: String.t, default: nil) - 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.
safe (type: String.t, default: nil) - Specifies the SafeSearch level 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
linkSite (type: String.t, default: nil) - Specifies that all results should contain a link to a specific URL.
highRange (type: String.t, default: nil) - 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.
orTerms (type: String.t, default: nil) - 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 query term for this type of query.
hl (type: String.t, default: nil) - 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 section of Internationalizing Queries and Results Presentation for more information, and Supported Interface Languages for a list of supported languages.
cr (type: String.t, default: nil) - Restricts search results to documents originating in a particular country. You may use Boolean operators 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 for a list of valid values for this parameter.
title (type: String.t, default: nil) - A description of the query.
disableCnTwTranslation (type: String.t, default: nil) - Enables or disables the Simplified and Traditional Chinese Search feature. Supported values are: 0: enabled (default) 1: disabled

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.CustomSearch.V1.Model.SearchQueriesNextPage{
  count: integer() | nil,
  cr: String.t() | nil,
  cx: String.t() | nil,
  dateRestrict: String.t() | nil,
  disableCnTwTranslation: String.t() | nil,
  exactTerms: String.t() | nil,
  excludeTerms: String.t() | nil,
  fileType: String.t() | nil,
  filter: String.t() | nil,
  gl: String.t() | nil,
  googleHost: String.t() | nil,
  highRange: String.t() | nil,
  hl: String.t() | nil,
  hq: String.t() | nil,
  imgColorType: String.t() | nil,
  imgDominantColor: String.t() | nil,
  imgSize: String.t() | nil,
  imgType: String.t() | nil,
  inputEncoding: String.t() | nil,
  language: String.t() | nil,
  linkSite: String.t() | nil,
  lowRange: String.t() | nil,
  orTerms: String.t() | nil,
  outputEncoding: String.t() | nil,
  relatedSite: String.t() | nil,
  rights: String.t() | nil,
  safe: String.t() | nil,
  searchTerms: String.t() | nil,
  searchType: String.t() | nil,
  siteSearch: String.t() | nil,
  siteSearchFilter: String.t() | nil,
  sort: String.t() | nil,
  startIndex: integer() | nil,
  startPage: integer() | nil,
  title: String.t() | nil,
  totalResults: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.