|
customsearch
v1
|
Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns. More...
Public Types | |
| enum | ImgColorTypeEnum { ImgColorTypeUndefined, Mono, Gray, Color, Trans } |
| Returns black and white, grayscale, transparent, or color images. 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 | 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... | |
| 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... | |
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 | 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< ImgColorTypeEnum > | ImgColorType [get, set] |
| Returns black and white, grayscale, transparent, or color images. Acceptable values are: More... | |
| virtual System.Nullable< ImgDominantColorEnum > | ImgDominantColor [get, set] |
| Returns images of a specific dominant color. 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... | |
| 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 string | C2coff [get, set] |
| Enables or disables Simplified and Traditional Chinese Search. More... | |
| virtual System.Nullable< ImgTypeEnum > | ImgType [get, set] |
| Returns images of a type. Acceptable values are: 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 | Gl [get, set] |
| Geolocation of end user. More... | |
| virtual string | Hl [get, set] |
| Sets the user interface language. 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 | Q [get, set] |
| Query 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... | |
| 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... | |
Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns.
Returns black and white, grayscale, transparent, or color images. Acceptable values are:
"color""gray""mono": black and white"trans": transparent backgroundReturns images of a specific dominant color. Acceptable values are:
"black""blue""brown""gray""green""orange""pink""purple""red""teal""white""yellow"Returns images of a specified size. Acceptable values are:
"huge""icon""large""medium""small""xlarge""xxlarge"Returns images of a type. Acceptable values are:
"clipart""face""lineart""stock""photo""animated"Search safety level. Acceptable values are:
"active": Enables SafeSearch filtering."off": Disables SafeSearch filtering. (default)Specifies the search type: image. If unspecified, results are limited to webpages.
Acceptable values are:
"image": custom image search.Controls whether to include or exclude results from the site named in the siteSearch parameter.
Acceptable values are:
"e": exclude"i": include
|
inline |
Constructs a new List request.
|
inlineprotected |
Initializes List parameter list.
|
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: Disabled0: Enabled (default)
|
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:
See the Country Parameter Values page for a list of valid values for this parameter.
|
getset |
The custom search engine ID to use for this request.
|
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.
|
getset |
Identifies a phrase that all documents in the search results must contain.
|
getset |
Identifies a word or phrase that should not appear in any documents in the search results.
|
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.
|
getset |
Controls turning on or off the duplicate content filter.
Acceptable values are:
0: Turns off duplicate content filter.1: Turns on duplicate content filter.
|
getset |
Geolocation of end user.
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.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.
|
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.
|
getset |
Specifies the ending value for a search range.
lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.
|
getset |
Sets the user interface language.
|
getset |
Appends the specified query terms to the query, as if they were combined with a logical AND operator.
|
get |
summary>Gets the REST path.
|
getset |
Returns black and white, grayscale, transparent, or color images. Acceptable values are:
"color""gray""mono": black and white"trans": transparent background
|
getset |
Returns images of a specific dominant color. Acceptable values are:
"black""blue""brown""gray""green""orange""pink""purple""red""teal""white""yellow"
|
getset |
Returns images of a specified size. Acceptable values are:
"huge""icon""large""medium""small""xlarge""xxlarge"
|
getset |
Returns images of a type. Acceptable values are:
"clipart""face""lineart""stock""photo""animated"
|
getset |
Specifies that all search results should contain a link to a particular URL.
|
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.
|
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)
|
get |
summary>Gets the HTTP method.
|
getset |
Number of search results to return.
|
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.
|
getset |
Query
|
getset |
Specifies that all search results should be pages that are related to the specified URL.
|
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.
summary>Gets the method name.
|
getset |
Search safety level. Acceptable values are:
"active": Enables SafeSearch filtering."off": Disables SafeSearch filtering. (default)
|
getset |
Specifies the search type: image. If unspecified, results are limited to webpages.
Acceptable values are:
"image": custom image search.
|
getset |
Specifies a given site which should always be included or excluded from results (see siteSearchFilter parameter, below).
|
getset |
Controls whether to include or exclude results from the site named in the siteSearch parameter.
Acceptable values are:
"e": exclude"i": include
|
getset |
The sort expression to apply to the results.
|
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.