Class Search.QueriesData.RequestData

Metadata representing the current request.

Inheritance
object
Search.QueriesData.RequestData
Inherited Members
Namespace: Google.Apis.CustomSearchAPI.v1.Data
Assembly: Google.Apis.CustomSearchAPI.v1.dll
Syntax
public class Search.QueriesData.RequestData

Properties

Count

Number of search results returned in this set.

Declaration
[JsonProperty("count")]
public virtual int? Count { get; set; }
Property Value
Type Description
int?

Cr

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.

Declaration
[JsonProperty("cr")]
public virtual string Cr { get; set; }
Property Value
Type Description
string

Cx

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.

Declaration
[JsonProperty("cx")]
public virtual string Cx { get; set; }
Property Value
Type Description
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
[JsonProperty("dateRestrict")]
public virtual string DateRestrict { get; set; }
Property Value
Type Description
string

DisableCnTwTranslation

Enables or disables the Simplified and Traditional Chinese Search feature. Supported values are: * 0: enabled (default) * 1: disabled

Declaration
[JsonProperty("disableCnTwTranslation")]
public virtual string DisableCnTwTranslation { get; set; }
Property Value
Type Description
string

ExactTerms

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

Declaration
[JsonProperty("exactTerms")]
public virtual string ExactTerms { get; set; }
Property Value
Type Description
string

ExcludeTerms

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

Declaration
[JsonProperty("excludeTerms")]
public virtual string ExcludeTerms { get; set; }
Property Value
Type Description
string

FileType

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.

Declaration
[JsonProperty("fileType")]
public virtual string FileType { get; set; }
Property Value
Type Description
string

Filter

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.

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

Gl

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.

Declaration
[JsonProperty("gl")]
public virtual string Gl { get; set; }
Property Value
Type Description
string

GoogleHost

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

Declaration
[JsonProperty("googleHost")]
public virtual string GoogleHost { get; set; }
Property Value
Type Description
string

HighRange

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.

Declaration
[JsonProperty("highRange")]
public virtual string HighRange { get; set; }
Property Value
Type Description
string

Hl

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.

Declaration
[JsonProperty("hl")]
public virtual string Hl { get; set; }
Property Value
Type Description
string

Hq

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

Declaration
[JsonProperty("hq")]
public virtual string Hq { get; set; }
Property Value
Type Description
string

ImgColorType

Restricts results to images of a specified color type. Supported values are: * mono (black and white) * gray (grayscale) * color (color)

Declaration
[JsonProperty("imgColorType")]
public virtual string ImgColorType { get; set; }
Property Value
Type Description
string

ImgDominantColor

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

  • yellow * green * teal * blue * purple * pink * white * gray * black * brown
Declaration
[JsonProperty("imgDominantColor")]
public virtual string ImgDominantColor { get; set; }
Property Value
Type Description
string

ImgSize

Restricts results to images of a specified size. Supported values are: * icon (small) * small | medium | large | xlarge (medium) * xxlarge (large) * huge (extra-large)

Declaration
[JsonProperty("imgSize")]
public virtual string ImgSize { get; set; }
Property Value
Type Description
string

ImgType

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)

Declaration
[JsonProperty("imgType")]
public virtual string ImgType { get; set; }
Property Value
Type Description
string

InputEncoding

The character encoding supported for search requests.

Declaration
[JsonProperty("inputEncoding")]
public virtual string InputEncoding { get; set; }
Property Value
Type Description
string

Language

The language of the search results.

Declaration
[JsonProperty("language")]
public virtual string Language { get; set; }
Property Value
Type Description
string

LinkSite

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

Declaration
[JsonProperty("linkSite")]
public virtual string LinkSite { get; set; }
Property Value
Type Description
string

LowRange

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.

Declaration
[JsonProperty("lowRange")]
public virtual string LowRange { get; set; }
Property Value
Type Description
string

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. You can also use the Boolean OR query term for this type of query.

Declaration
[JsonProperty("orTerms")]
public virtual string OrTerms { get; set; }
Property Value
Type Description
string

OutputEncoding

The character encoding supported for search results.

Declaration
[JsonProperty("outputEncoding")]
public virtual string OutputEncoding { get; set; }
Property Value
Type Description
string

RelatedSite

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

Declaration
[JsonProperty("relatedSite")]
public virtual string RelatedSite { get; set; }
Property Value
Type Description
string

Rights

Filters based on licensing. Supported values include: * cc_publicdomain * cc_attribute * cc_sharealike * cc_noncommercial * cc_nonderived

Declaration
[JsonProperty("rights")]
public virtual string Rights { get; set; }
Property Value
Type Description
string

Safe

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

Declaration
[JsonProperty("safe")]
public virtual string Safe { get; set; }
Property Value
Type Description
string

SearchTerms

The search terms entered by the user.

Declaration
[JsonProperty("searchTerms")]
public virtual string SearchTerms { get; set; }
Property Value
Type Description
string

SearchType

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

Declaration
[JsonProperty("searchType")]
public virtual string SearchType { get; set; }
Property Value
Type Description
string

SiteSearch

Restricts results to URLs from a specified site.

Declaration
[JsonProperty("siteSearch")]
public virtual string SiteSearch { get; set; }
Property Value
Type Description
string

SiteSearchFilter

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

Declaration
[JsonProperty("siteSearchFilter")]
public virtual string SiteSearchFilter { get; set; }
Property Value
Type Description
string

Sort

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

Declaration
[JsonProperty("sort")]
public virtual string Sort { get; set; }
Property Value
Type Description
string

StartIndex

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

Declaration
[JsonProperty("startIndex")]
public virtual int? StartIndex { get; set; }
Property Value
Type Description
int?

StartPage

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

Declaration
[JsonProperty("startPage")]
public virtual int? StartPage { get; set; }
Property Value
Type Description
int?

Title

A description of the query.

Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type Description
string

TotalResults

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

Declaration
[JsonProperty("totalResults")]
public virtual long? TotalResults { get; set; }
Property Value
Type Description
long?