Custom search request metadata. More...

Properties
virtual System.Nullable< int >	Count `[get, set]`
	Number of search results returned in this set. More...

virtual string	Cr `[get, set]`
	Restricts search results to documents originating in a particular country. You may use Boolean operators in the `cr` parameter's value. More...

virtual string	Cx `[get, set]`
	The identifier of a custom search engine created using the Custom Search Control Panel. This is a custom property not defined in the OpenSearch spec. This parameter is required. More...

virtual string	DateRestrict `[get, set]`
	Restricts results to URLs based on date. Supported values include: More...

virtual string	DisableCnTwTranslation `[get, set]`
	Enables or disables the Simplified and Traditional Chinese Search feature. More...

virtual string	ExactTerms `[get, set]`
	Identifies a phrase that all documents in the search results must contain. More...

virtual string	ExcludeTerms `[get, set]`
	Identifies a word or phrase that should not appear in any documents in the search results. More...

virtual string	FileType `[get, set]`
	Restricts results to files of a specified extension. Filetypes supported by Google include: More...

virtual string	Filter `[get, set]`
	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: More...

virtual string	Gl `[get, set]`
	Boosts search results whose country of origin matches the parameter value. See Country Codes for a list of valid values. More...

virtual string	GoogleHost `[get, set]`
	Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. More...

virtual string	HighRange `[get, set]`
	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. More...

virtual string	Hl `[get, set]`
	Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. More...

virtual string	Hq `[get, set]`
	Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. More...

virtual string	ImgColorType `[get, set]`
	Restricts results to images of a specified color type. Supported values are: More...

virtual string	ImgDominantColor `[get, set]`
	Restricts results to images with a specific dominant color. Supported values are: More...

virtual string	ImgSize `[get, set]`
	Restricts results to images of a specified size. Supported values are: More...

virtual string	ImgType `[get, set]`
	Restricts results to images of a specified type. Supported values are: More...

virtual string	InputEncoding `[get, set]`
	The character encoding supported for search requests. More...

virtual string	Language `[get, set]`
	The language of the search results. More...

virtual string	LinkSite `[get, set]`
	Specifies that all results should contain a link to a specific URL. More...

virtual string	LowRange `[get, set]`
	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. More...

virtual string	OrTerms `[get, set]`
	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. More...

virtual string	OutputEncoding `[get, set]`
	The character encoding supported for search results. More...

virtual string	RelatedSite `[get, set]`
	Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. More...

virtual string	Rights `[get, set]`
	Filters based on licensing. Supported values include: More...

virtual string	Safe `[get, set]`
	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: More...

virtual string	SearchTerms `[get, set]`
	The search terms entered by the user. More...

virtual string	SearchType `[get, set]`
	Allowed values are `web` or `image`. If unspecified, results are limited to webpages. More...

virtual string	SiteSearch `[get, set]`
	Restricts results to URLs from a specified site. More...

virtual string	SiteSearchFilter `[get, set]`
	Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: More...

virtual string	Sort `[get, set]`
	Specifies that results should be sorted according to the specified expression. For example, sort by date. More...

virtual System.Nullable< int >	StartIndex `[get, set]`
	The index of the current set of search results into the total set of results, where the index of the first result is 1. More...

virtual System.Nullable< int >	StartPage `[get, set]`
	The page number of this set of results, where the page length is set by the `count` property. More...

virtual string	Title `[get, set]`
	A description of the query. More...

virtual System.Nullable< long >	TotalResults `[get, set]`
	Estimated number of total search results. May not be accurate. More...

Detailed Description

Custom search request metadata.

Property Documentation

◆ Count

virtual System.Nullable<int> Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Count

getset

Number of search results returned in this set.

◆ Cr

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Cr

getset

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.

◆ Cx

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Cx

getset

The identifier of a custom search engine created using the Custom Search Control Panel. This is a custom property not defined in the OpenSearch spec. This parameter is required.

◆ DateRestrict

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.DateRestrict

getset

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.

◆ DisableCnTwTranslation

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.DisableCnTwTranslation

getset

Enables or disables the Simplified and Traditional Chinese Search feature.

Supported values are:

0: enabled (default)
1: disabled

◆ ExactTerms

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.ExactTerms

getset

Identifies a phrase that all documents in the search results must contain.

◆ ExcludeTerms

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.ExcludeTerms

getset

Identifies a word or phrase that should not appear in any documents in the search results.

◆ FileType

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.FileType

getset

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.

◆ Filter

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Filter

getset

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.

◆ Gl

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Gl

getset

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.

◆ GoogleHost

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.GoogleHost

getset

Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

◆ HighRange

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.HighRange

getset

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.

◆ Hl

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Hl

getset

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.

◆ Hq

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Hq

getset

Appends the specified query terms to the query, as if they were combined with a logical AND operator.

◆ ImgColorType

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.ImgColorType

getset

Restricts results to images of a specified color type. Supported values are:

mono (black and white)
gray (grayscale)
color (color)

◆ ImgDominantColor

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.ImgDominantColor

getset

Restricts results to images with a specific dominant color. Supported values are:

red
orange
yellow
green
teal
blue
purple
pink
white
gray
black
brown

◆ ImgSize

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.ImgSize

getset

Restricts results to images of a specified size. Supported values are:

icon (small)
small | medium | large | xlarge (medium)
xxlarge (large)
huge (extra-large)

◆ ImgType

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.ImgType

getset

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)

◆ InputEncoding

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.InputEncoding

getset

The character encoding supported for search requests.

◆ Language

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Language

getset

The language of the search results.

◆ LinkSite

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.LinkSite

getset

Specifies that all results should contain a link to a specific URL.

◆ LowRange

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.LowRange

getset

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.

◆ OrTerms

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.OrTerms

getset

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.

◆ OutputEncoding

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.OutputEncoding

getset

The character encoding supported for search results.

◆ RelatedSite

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.RelatedSite

getset

Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

◆ Rights

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Rights

getset

Filters based on licensing. Supported values include:

cc_publicdomain
cc_attribute
cc_sharealike
cc_noncommercial
cc_nonderived

◆ Safe

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Safe

getset

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

◆ SearchTerms

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.SearchTerms

getset

The search terms entered by the user.

◆ SearchType

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.SearchType

getset

Allowed values are web or image. If unspecified, results are limited to webpages.

◆ SiteSearch

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.SiteSearch

getset

Restricts results to URLs from a specified site.

◆ SiteSearchFilter

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.SiteSearchFilter

getset

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

◆ Sort

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Sort

getset

Specifies that results should be sorted according to the specified expression. For example, sort by date.

◆ StartIndex

virtual System.Nullable<int> Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.StartIndex

getset

The index of the current set of search results into the total set of results, where the index of the first result is 1.

◆ StartPage

virtual System.Nullable<int> Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.StartPage

getset

The page number of this set of results, where the page length is set by the count property.

◆ Title

virtual string Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.Title

getset

A description of the query.

◆ TotalResults

virtual System.Nullable<long> Google.Apis.Customsearch.v1.Data.Search.QueriesData.NextPageData.TotalResults

getset

Estimated number of total search results. May not be accurate.

The documentation for this class was generated from the following file:

Google.Apis.Customsearch.v1.cs

Properties

Detailed Description

Property Documentation

◆ Count

◆ Cr

◆ Cx

◆ DateRestrict

◆ DisableCnTwTranslation

◆ ExactTerms

◆ ExcludeTerms

◆ FileType

◆ Filter

◆ Gl

◆ GoogleHost

◆ HighRange

◆ Hl

◆ Hq

◆ ImgColorType

◆ ImgDominantColor

◆ ImgSize

◆ ImgType

◆ InputEncoding

◆ Language

◆ LinkSite

◆ LowRange

◆ OrTerms

◆ OutputEncoding

◆ RelatedSite

◆ Rights

◆ Safe

◆ SearchTerms

◆ SearchType

◆ SiteSearch

◆ SiteSearchFilter

◆ Sort

◆ StartIndex

◆ StartPage

◆ Title

◆ TotalResults