Class CseResource.SiterestrictResource.ListRequest
Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.
Inheritance
Inherited Members
Namespace: Google.Apis.Customsearch.v1
Assembly: Google.Apis.Customsearch.v1.dll
Syntax
public class ListRequest : CustomsearchBaseServiceRequest<Search>, IClientServiceRequest<Search>, IClientServiceRequest
Constructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
C2coff
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)
Declaration
[RequestParameter("c2coff", RequestParameterType.Query)]
public virtual string C2coff { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Cr
Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom- search/docs/xml_results_appendices#booleanOperators) 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.
Declaration
[RequestParameter("cr", RequestParameterType.Query)]
public virtual string Cr { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Cx
The Programmable Search Engine ID to use for this request.
Declaration
[RequestParameter("cx", RequestParameterType.Query)]
public virtual string Cx { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DateRestrict
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.
Declaration
[RequestParameter("dateRestrict", RequestParameterType.Query)]
public virtual string DateRestrict { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExactTerms
Identifies a phrase that all documents in the search results must contain.
Declaration
[RequestParameter("exactTerms", RequestParameterType.Query)]
public virtual string ExactTerms { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExcludeTerms
Identifies a word or phrase that should not appear in any documents in the search results.
Declaration
[RequestParameter("excludeTerms", RequestParameterType.Query)]
public virtual string ExcludeTerms { get; set; }
Property Value
Type | Description |
---|---|
System.String |
FileType
Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center.
Declaration
[RequestParameter("fileType", RequestParameterType.Query)]
public virtual string FileType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Filter
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.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Gl
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](https://developers.google.com/custom-
search/docs/xml_results_appendices#countryCodes) 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.
Declaration
[RequestParameter("gl", RequestParameterType.Query)]
public virtual string Gl { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Googlehost
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.
Declaration
[RequestParameter("googlehost", RequestParameterType.Query)]
public virtual string Googlehost { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HighRange
Specifies the ending value for a search range. * Use lowRange
and highRange
to append
an inclusive search range of lowRange...highRange
to the query.
Declaration
[RequestParameter("highRange", RequestParameterType.Query)]
public virtual string HighRange { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Hl
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](https://developers.google.com /custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom- search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages.
Declaration
[RequestParameter("hl", RequestParameterType.Query)]
public virtual string Hl { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Hq
Appends the specified query terms to the query, as if they were combined with a logical AND operator.
Declaration
[RequestParameter("hq", RequestParameterType.Query)]
public virtual string Hq { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
ImgColorType
Returns black and white, grayscale, transparent, or color images. Acceptable values are: *
"color"
* "gray"
* "mono"
: black and white * "trans"
: transparent background
Declaration
[RequestParameter("imgColorType", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.ImgColorTypeEnum? ImgColorType { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.ImgColorTypeEnum> |
ImgDominantColor
Returns images of a specific dominant color. Acceptable values are: * "black"
* "blue"
"brown"
*"gray"
*"green"
*"orange"
*"pink"
*"purple"
*"red"
*"teal"
*"white"
*"yellow"
Declaration
[RequestParameter("imgDominantColor", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.ImgDominantColorEnum? ImgDominantColor { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.ImgDominantColorEnum> |
ImgSize
Returns images of a specified size. Acceptable values are: * "huge"
* "icon"
*
"large"
* "medium"
* "small"
* "xlarge"
* "xxlarge"
Declaration
[RequestParameter("imgSize", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.ImgSizeEnum? ImgSize { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.ImgSizeEnum> |
ImgType
Returns images of a type. Acceptable values are: * "clipart"
* "face"
* "lineart"
*
"stock"
* "photo"
* "animated"
Declaration
[RequestParameter("imgType", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.ImgTypeEnum? ImgType { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.ImgTypeEnum> |
LinkSite
Specifies that all search results should contain a link to a particular URL.
Declaration
[RequestParameter("linkSite", RequestParameterType.Query)]
public virtual string LinkSite { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LowRange
Specifies the starting value for a search range. Use lowRange
and highRange
to append
an inclusive search range of lowRange...highRange
to the query.
Declaration
[RequestParameter("lowRange", RequestParameterType.Query)]
public virtual string LowRange { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Lr
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)
Declaration
[RequestParameter("lr", RequestParameterType.Query)]
public virtual string Lr { get; set; }
Property Value
Type | Description |
---|---|
System.String |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Num
Number of search results to return. * Valid values are integers between 1 and 10, inclusive.
Declaration
[RequestParameter("num", RequestParameterType.Query)]
public virtual int? Num { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
OrTerms
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.
Declaration
[RequestParameter("orTerms", RequestParameterType.Query)]
public virtual string OrTerms { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Q
Query
Declaration
[RequestParameter("q", RequestParameterType.Query)]
public virtual string Q { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RelatedSite
Specifies that all search results should be pages that are related to the specified URL.
Declaration
[RequestParameter("relatedSite", RequestParameterType.Query)]
public virtual string RelatedSite { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Rights
Filters based on licensing. Supported values include: cc_publicdomain
, cc_attribute
,
cc_sharealike
, cc_noncommercial
, cc_nonderived
and combinations of these. See typical
combinations.
Declaration
[RequestParameter("rights", RequestParameterType.Query)]
public virtual string Rights { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Safe
Search safety level. Acceptable values are: * "active"
: Enables SafeSearch filtering. *
"off"
: Disables SafeSearch filtering. (default)
Declaration
[RequestParameter("safe", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.SafeEnum? Safe { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.SafeEnum> |
SearchType
Specifies the search type: image
. If unspecified, results are limited to webpages.
Acceptable values are: * "image"
: custom image search.
Declaration
[RequestParameter("searchType", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.SearchTypeEnum? SearchType { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.SearchTypeEnum> |
SiteSearch
Specifies a given site which should always be included or excluded from results (see
siteSearchFilter
parameter, below).
Declaration
[RequestParameter("siteSearch", RequestParameterType.Query)]
public virtual string SiteSearch { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SiteSearchFilter
Controls whether to include or exclude results from the site named in the siteSearch
parameter. Acceptable values are: * "e"
: exclude * "i"
: include
Declaration
[RequestParameter("siteSearchFilter", RequestParameterType.Query)]
public virtual CseResource.SiterestrictResource.ListRequest.SiteSearchFilterEnum? SiteSearchFilter { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CseResource.SiterestrictResource.ListRequest.SiteSearchFilterEnum> |
Sort
The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by- attribute).
Declaration
[RequestParameter("sort", RequestParameterType.Query)]
public virtual string Sort { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Start
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.
Declaration
[RequestParameter("start", RequestParameterType.Query)]
public virtual long? Start { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()