Class CseResource.ListRequest

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

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Search>
CustomSearchAPIBaseServiceRequest<Search>
CseResource.ListRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Search>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CustomSearchAPI.v1
Assembly: Google.Apis.CustomSearchAPI.v1.dll
Syntax
public class ListRequest : CustomSearchAPIBaseServiceRequest<Search>, IClientServiceRequest<Search>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
Google.Apis.Services.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 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 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 for more information, and Supported Interface Languages 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.HttpMethod

ImgColorType

Returns black and white, grayscale, transparent, or color images. Acceptable values are: * &quot;color&quot; * &quot;gray&quot; * &quot;mono&quot;: black and white * &quot;trans&quot;: transparent background

Declaration
[RequestParameter("imgColorType", RequestParameterType.Query)]
public virtual CseResource.ListRequest.ImgColorTypeEnum? ImgColorType { get; set; }
Property Value
Type Description
System.Nullable<CseResource.ListRequest.ImgColorTypeEnum>

ImgDominantColor

Returns images of a specific dominant color. Acceptable values are: * &quot;black&quot; * &quot;blue&quot; * &quot;brown&quot; * &quot;gray&quot; * &quot;green&quot; * &quot;orange&quot; * &quot;pink&quot; * &quot;purple&quot; * &quot;red&quot; * &quot;teal&quot; * &quot;white&quot; * &quot;yellow&quot;

Declaration
[RequestParameter("imgDominantColor", RequestParameterType.Query)]
public virtual CseResource.ListRequest.ImgDominantColorEnum? ImgDominantColor { get; set; }
Property Value
Type Description
System.Nullable<CseResource.ListRequest.ImgDominantColorEnum>

ImgSize

Returns images of a specified size. Acceptable values are: * &quot;huge&quot; * &quot;icon&quot; * &quot;large&quot; * &quot;medium&quot; * &quot;small&quot; * &quot;xlarge&quot; * &quot;xxlarge&quot;

Declaration
[RequestParameter("imgSize", RequestParameterType.Query)]
public virtual CseResource.ListRequest.ImgSizeEnum? ImgSize { get; set; }
Property Value
Type Description
System.Nullable<CseResource.ListRequest.ImgSizeEnum>

ImgType

Returns images of a type. Acceptable values are: * &quot;clipart&quot; * &quot;face&quot; * &quot;lineart&quot; * &quot;stock&quot; * &quot;photo&quot; * &quot;animated&quot;

Declaration
[RequestParameter("imgType", RequestParameterType.Query)]
public virtual CseResource.ListRequest.ImgTypeEnum? ImgType { get; set; }
Property Value
Type Description
System.Nullable<CseResource.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: * &quot;lang_ar&quot;: Arabic * &quot;lang_bg&quot;: Bulgarian * &quot;lang_ca&quot;: Catalan * &quot;lang_cs&quot;: Czech * &quot;lang_da&quot;: Danish * &quot;lang_de&quot;: German * &quot;lang_el&quot;: Greek * &quot;lang_en&quot;: English * &quot;lang_es&quot;: Spanish * &quot;lang_et&quot;: Estonian * &quot;lang_fi&quot;: Finnish * &quot;lang_fr&quot;: French * &quot;lang_hr&quot;: Croatian * &quot;lang_hu&quot;: Hungarian * &quot;lang_id&quot;: Indonesian * &quot;lang_is&quot;: Icelandic * &quot;lang_it&quot;: Italian * &quot;lang_iw&quot;: Hebrew * &quot;lang_ja&quot;: Japanese * &quot;lang_ko&quot;: Korean * &quot;lang_lt&quot;: Lithuanian * &quot;lang_lv&quot;: Latvian * &quot;lang_nl&quot;: Dutch * &quot;lang_no&quot;: Norwegian * &quot;lang_pl&quot;: Polish * &quot;lang_pt&quot;: Portuguese * &quot;lang_ro&quot;: Romanian * &quot;lang_ru&quot;: Russian * &quot;lang_sk&quot;: Slovak * &quot;lang_sl&quot;: Slovenian

  • &quot;lang_sr&quot;: Serbian * &quot;lang_sv&quot;: Swedish * &quot;lang_tr&quot;: Turkish * &quot;lang_zh-CN&quot;: Chinese (Simplified) * &quot;lang_zh-TW&quot;: 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.MethodName

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.RestPath

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: * &quot;active&quot;: Enables SafeSearch filtering. * &quot;off&quot;: Disables SafeSearch filtering. (default)

Declaration
[RequestParameter("safe", RequestParameterType.Query)]
public virtual CseResource.ListRequest.SafeEnum? Safe { get; set; }
Property Value
Type Description
System.Nullable<CseResource.ListRequest.SafeEnum>

SearchType

Specifies the search type: image. If unspecified, results are limited to webpages. Acceptable values are: * &quot;image&quot;: custom image search.

Declaration
[RequestParameter("searchType", RequestParameterType.Query)]
public virtual CseResource.ListRequest.SearchTypeEnum? SearchType { get; set; }
Property Value
Type Description
System.Nullable<CseResource.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: * &quot;e&quot;: exclude * &quot;i&quot;: include

Declaration
[RequestParameter("siteSearchFilter", RequestParameterType.Query)]
public virtual CseResource.ListRequest.SiteSearchFilterEnum? SiteSearchFilter { get; set; }
Property Value
Type Description
System.Nullable<CseResource.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.

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 &amp;amp;start=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()
Overrides
Google.Apis.CustomSearchAPI.v1.CustomSearchAPIBaseServiceRequest<Google.Apis.CustomSearchAPI.v1.Data.Search>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest