Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. More...

Inheritance diagram for Google.Apis.Customsearch.v1.CseResource.ListRequest:

Public Types
enum	SearchTypeEnum { SearchTypeUndefined, Image }
	Specifies the search type: `image`. If unspecified, results are limited to webpages. More...

enum	ImgTypeEnum { ImgTypeUndefined, Clipart, Face, Lineart, Stock, Photo, Animated }
	Returns images of a type. Acceptable values are: More...

enum	ImgSizeEnum { ImgSizeUndefined, HUGE, ICON, LARGE, MEDIUM, SMALL, XLARGE, XXLARGE }
	Returns images of a specified size. Acceptable values are: More...

enum	ImgDominantColorEnum { ImgDominantColorUndefined, Black, Blue, Brown, Gray, Green, Orange, Pink, Purple, Red, Teal, White, Yellow }
	Returns images of a specific dominant color. Acceptable values are: More...

enum	ImgColorTypeEnum { ImgColorTypeUndefined, Mono, Gray, Color, Trans }
	Returns black and white, grayscale, transparent, or color images. Acceptable values are: More...

enum	SafeEnum { SafeUndefined, Active, High, Medium, Off }
	Search safety level. Acceptable values are: More...

enum	SiteSearchFilterEnum { SiteSearchFilterUndefined, E, I }
	Controls whether to include or exclude results from the site named in the `siteSearch` parameter. More...

Public Member Functions
	ListRequest (Google.Apis.Services.IClientService service)
	Constructs a new List request. More...

Protected Member Functions
override void	InitParameters ()
	Initializes List parameter list. More...

Protected Member Functions inherited from Google.Apis.Customsearch.v1.CustomsearchBaseServiceRequest< Google.Apis.Customsearch.v1.Data.Search >
	CustomsearchBaseServiceRequest (Google.Apis.Services.IClientService service)
	Constructs a new CustomsearchBaseServiceRequest instance. More...

override void	InitParameters ()
	Initializes Customsearch parameter list. More...

Properties
virtual string	Sort `[get, set]`
	The sort expression to apply to the results. More...

virtual string	LinkSite `[get, set]`
	Specifies that all search results should contain a link to a particular URL. 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 System.Nullable< SearchTypeEnum >	SearchType `[get, set]`
	Specifies the search type: `image`. If unspecified, results are limited to webpages. More...

virtual string	FileType `[get, set]`
	Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center. More...

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

virtual string	SiteSearch `[get, set]`
	Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). 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	ExactTerms `[get, set]`
	Identifies a phrase that all documents in the search results must contain. More...

virtual System.Nullable< int >	Num `[get, set]`
	Number of search results to return. More...

virtual System.Nullable< ImgTypeEnum >	ImgType `[get, set]`
	Returns images of a type. Acceptable values are: More...

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

virtual string	Filter `[get, set]`
	Controls turning on or off the duplicate content filter. More...

virtual string	HighRange `[get, set]`
	Specifies the ending value for a search range. More...

virtual string	Hl `[get, set]`
	Sets the user interface language. More...

virtual string	Gl `[get, set]`
	Geolocation of end user. More...

virtual string	Googlehost `[get, set]`
	Deprecated. Use the `gl` parameter for a similar effect. More...

virtual System.Nullable< ImgSizeEnum >	ImgSize `[get, set]`
	Returns images of a specified size. Acceptable values are: 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	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. More...

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

virtual string	Rights `[get, set]`
	Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See typical combinations. More...

virtual string	Q `[get, set]`
	Query More...

virtual string	Cx `[get, set]`
	The custom search engine ID to use for this request. More...

virtual string	LowRange `[get, set]`
	Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. More...

virtual string	Lr `[get, set]`
	Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). More...

virtual System.Nullable< ImgDominantColorEnum >	ImgDominantColor `[get, set]`
	Returns images of a specific dominant color. Acceptable values are: More...

virtual System.Nullable< ImgColorTypeEnum >	ImgColorType `[get, set]`
	Returns black and white, grayscale, transparent, or color images. Acceptable values are: More...

virtual System.Nullable< SafeEnum >	Safe `[get, set]`
	Search safety level. Acceptable values are: More...

virtual System.Nullable< SiteSearchFilterEnum >	SiteSearchFilter `[get, set]`
	Controls whether to include or exclude results from the site named in the `siteSearch` parameter. More...

virtual System.Nullable< long >	Start `[get, set]`
	The index of the first result to return. The default number of results per page is 10, so `=11` would start at the top of the second page of results. Note: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. More...

override string	MethodName `[get]`
	summary>Gets the HTTP method. More...

override string	HttpMethod `[get]`
	summary>Gets the REST path. More...

override string	RestPath `[get]`

Properties inherited from Google.Apis.Customsearch.v1.CustomsearchBaseServiceRequest< Google.Apis.Customsearch.v1.Data.Search >
virtual System.Nullable< XgafvEnum >	Xgafv `[get, set]`
	V1 error format. More...

virtual string	AccessToken `[get, set]`
	OAuth access token. More...

virtual System.Nullable< AltEnum >	Alt `[get, set]`
	Data format for response. More...

virtual string	Callback `[get, set]`
	JSONP More...

virtual string	Fields `[get, set]`
	Selector specifying which fields to include in a partial response. More...

virtual string	Key `[get, set]`
	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...

virtual string	OauthToken `[get, set]`
	OAuth 2.0 token for the current user. More...

virtual System.Nullable< bool >	PrettyPrint `[get, set]`
	Returns response with indentations and line breaks. More...

virtual string	QuotaUser `[get, set]`
	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. More...

virtual string	UploadType `[get, set]`
	Legacy upload protocol for media (e.g. "media", "multipart"). More...

virtual string	UploadProtocol `[get, set]`
	Upload protocol for media (e.g. "raw", "multipart"). More...

Detailed Description

Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.

Member Enumeration Documentation

◆ ImgColorTypeEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgColorTypeEnum

strong

Returns black and white, grayscale, transparent, or color images. Acceptable values are:

"color"
"gray"
"mono": black and white
"trans": transparent background

◆ ImgDominantColorEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgDominantColorEnum

strong

Returns images of a specific dominant color. Acceptable values are:

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

◆ ImgSizeEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgSizeEnum

strong

Returns images of a specified size. Acceptable values are:

"huge"
"icon"
"large"
"medium"
"small"
"xlarge"
"xxlarge"

◆ ImgTypeEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgTypeEnum

strong

Returns images of a type. Acceptable values are:

"clipart"
"face"
"lineart"
"stock"
"photo"
"animated"

◆ SafeEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.SafeEnum

strong

Search safety level. Acceptable values are:

"active": Enables SafeSearch filtering.
"off": Disables SafeSearch filtering. (default)

◆ SearchTypeEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.SearchTypeEnum

strong

Specifies the search type: image. If unspecified, results are limited to webpages.

Acceptable values are:

"image": custom image search.

◆ SiteSearchFilterEnum

enum Google.Apis.Customsearch.v1.CseResource.ListRequest.SiteSearchFilterEnum

strong

Controls whether to include or exclude results from the site named in the siteSearch parameter.

Acceptable values are:

"e": exclude
"i": include

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Customsearch.v1.CseResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService service )

inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Customsearch.v1.CseResource.ListRequest.InitParameters ( )

inlineprotected

Initializes List parameter list.

Property Documentation

◆ C2coff

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.C2coff

getset

Enables or disables Simplified and Traditional Chinese Search.

The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are:

1: Disabled
0: Enabled (default)

◆ Cr

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Cr

getset

Restricts search results to documents originating in a particular country. You may use Boolean operators in the cr parameter's value.

Google Search determines the country of a document by analyzing:

the top-level domain (TLD) of the document's URL
the geographic location of the Web server's IP address

See the Country Parameter Values page for a list of valid values for this parameter.

◆ Cx

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Cx

getset

The custom search engine ID to use for this request.

◆ DateRestrict

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.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.

◆ ExactTerms

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.ExactTerms

getset

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

◆ ExcludeTerms

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.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.CseResource.ListRequest.FileType

getset

Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center.

◆ Filter

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Filter

getset

Controls turning on or off the duplicate content filter.

See Automatic Filtering for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches.
By default, Google applies filtering to all search results to improve the quality of those results.

Acceptable values are:

0: Turns off duplicate content filter.
1: Turns on duplicate content filter.

◆ Gl

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Gl

getset

Geolocation of end user.

The gl parameter value is a two-letter country code. The gl parameter boosts search results whose country of origin matches the parameter value. See the Country Codes page for a list of valid values.
Specifying a gl parameter value should lead to more relevant 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.CseResource.ListRequest.Googlehost

getset

**Deprecated**. Use the gl parameter for a similar effect.

The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.

◆ HighRange

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.HighRange

getset

Specifies the ending value for a search range.

Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

◆ Hl

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Hl

getset

Sets the user interface language.

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)[https://developers.google.com/custom- search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages.

◆ Hq

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Hq

getset

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

◆ HttpMethod

override string Google.Apis.Customsearch.v1.CseResource.ListRequest.HttpMethod

get

summary>Gets the REST path.

◆ ImgColorType

virtual System.Nullable<ImgColorTypeEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgColorType

getset

Returns black and white, grayscale, transparent, or color images. Acceptable values are:

"color"
"gray"
"mono": black and white
"trans": transparent background

◆ ImgDominantColor

virtual System.Nullable<ImgDominantColorEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgDominantColor

getset

Returns images of a specific dominant color. Acceptable values are:

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

◆ ImgSize

virtual System.Nullable<ImgSizeEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgSize

getset

Returns images of a specified size. Acceptable values are:

"huge"
"icon"
"large"
"medium"
"small"
"xlarge"
"xxlarge"

◆ ImgType

virtual System.Nullable<ImgTypeEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.ImgType

getset

Returns images of a type. Acceptable values are:

"clipart"
"face"
"lineart"
"stock"
"photo"
"animated"

◆ LinkSite

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.LinkSite

getset

Specifies that all search results should contain a link to a particular URL.

◆ LowRange

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.LowRange

getset

Specifies the starting value for a search range. Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

◆ Lr

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Lr

getset

Restricts the search to documents written in a particular language (e.g., lr=lang_ja).

Acceptable values are:

"lang_ar": Arabic
"lang_bg": Bulgarian
"lang_ca": Catalan
"lang_cs": Czech
"lang_da": Danish
"lang_de": German
"lang_el": Greek
"lang_en": English
"lang_es": Spanish
"lang_et": Estonian
"lang_fi": Finnish
"lang_fr": French
"lang_hr": Croatian
"lang_hu": Hungarian
"lang_id": Indonesian
"lang_is": Icelandic
"lang_it": Italian
"lang_iw": Hebrew
"lang_ja": Japanese
"lang_ko": Korean
"lang_lt": Lithuanian
"lang_lv": Latvian
"lang_nl": Dutch
"lang_no": Norwegian
"lang_pl": Polish
"lang_pt": Portuguese
"lang_ro": Romanian
"lang_ru": Russian
"lang_sk": Slovak
"lang_sl": Slovenian
"lang_sr": Serbian
"lang_sv": Swedish
"lang_tr": Turkish
"lang_zh-CN": Chinese (Simplified)
"lang_zh-TW": Chinese (Traditional)

◆ MethodName

override string Google.Apis.Customsearch.v1.CseResource.ListRequest.MethodName

get

summary>Gets the HTTP method.

◆ Num

virtual System.Nullable<int> Google.Apis.Customsearch.v1.CseResource.ListRequest.Num

getset

Number of search results to return.

Valid values are integers between 1 and 10, inclusive.

◆ OrTerms

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.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.

◆ Q

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Q

getset

Query

◆ RelatedSite

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.RelatedSite

getset

Specifies that all search results should be pages that are related to the specified URL.

◆ Rights

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Rights

getset

Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See typical combinations.

◆ Safe

virtual System.Nullable<SafeEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.Safe

getset

Search safety level. Acceptable values are:

"active": Enables SafeSearch filtering.
"off": Disables SafeSearch filtering. (default)

◆ SearchType

virtual System.Nullable<SearchTypeEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.SearchType

getset

Specifies the search type: image. If unspecified, results are limited to webpages.

Acceptable values are:

"image": custom image search.

◆ SiteSearch

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.SiteSearch

getset

Specifies a given site which should always be included or excluded from results (see siteSearchFilter parameter, below).

◆ SiteSearchFilter

virtual System.Nullable<SiteSearchFilterEnum> Google.Apis.Customsearch.v1.CseResource.ListRequest.SiteSearchFilter

getset

Controls whether to include or exclude results from the site named in the siteSearch parameter.

Acceptable values are:

"e": exclude
"i": include

◆ Sort

virtual string Google.Apis.Customsearch.v1.CseResource.ListRequest.Sort

getset

The sort expression to apply to the results.

◆ Start

virtual System.Nullable<long> Google.Apis.Customsearch.v1.CseResource.ListRequest.Start

getset

The index of the first result to return. The default number of results per page is 10, so =11 would start at the top of the second page of results. Note: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of start + num to a number greater than 100 will produce an error. Also note that the maximum value for num is 10.

summary>Gets the method name.

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

Google.Apis.Customsearch.v1.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ImgColorTypeEnum

◆ ImgDominantColorEnum

◆ ImgSizeEnum

◆ ImgTypeEnum

◆ SafeEnum

◆ SearchTypeEnum

◆ SiteSearchFilterEnum

Constructor & Destructor Documentation

◆ ListRequest()

Member Function Documentation

◆ InitParameters()

Property Documentation

◆ C2coff

◆ Cr

◆ Cx

◆ DateRestrict

◆ ExactTerms

◆ ExcludeTerms

◆ FileType

◆ Filter

◆ Gl

◆ Googlehost

◆ HighRange

◆ Hl

◆ Hq

◆ HttpMethod

◆ ImgColorType

◆ ImgDominantColor

◆ ImgSize

◆ ImgType

◆ LinkSite

◆ LowRange

◆ Lr

◆ MethodName

◆ Num

◆ OrTerms

◆ Q

◆ RelatedSite

◆ Rights

◆ Safe

◆ SearchType

◆ SiteSearch

◆ SiteSearchFilter

◆ Sort

◆ Start