Security News
OpenJS: “XZ Utils Cyberattack Likely Not an Isolated Incident”
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
@datafire/google_customsearch
Advanced tools
Weekly downloads
Readme
Client library for Custom Search API
npm install --save @datafire/google_customsearch
let google_customsearch = require('@datafire/google_customsearch').create();
.then(data => {
console.log(data);
});
Searches over a website or collection of websites
Returns metadata about the search performed, metadata about the engine used for the search, and the search results.
google_customsearch.search.cse.list({}, context)
object
string
: 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)string
: 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.string
: The Programmable Search Engine ID to use for this request.string
: 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.string
: Identifies a phrase that all documents in the search results must contain.string
: Identifies a word or phrase that should not appear in any documents in the search results.string
: Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center.string
: 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.string
: 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.string
: 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.string
: Specifies the ending value for a search range. * Use lowRange
and highRange
to append an inclusive search range of lowRange...highRange
to the query.string
: 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.string
: Appends the specified query terms to the query, as if they were combined with a logical AND operator.string
(values: imgColorTypeUndefined, mono, gray, color, trans): Returns black and white, grayscale, transparent, or color images. Acceptable values are: * "color"
* "gray"
* "mono"
: black and white * "trans"
: transparent backgroundstring
(values: imgDominantColorUndefined, black, blue, brown, gray, green, orange, pink, purple, red, teal, white, yellow): Returns images of a specific dominant color. Acceptable values are: * "black"
* "blue"
* "brown"
* "gray"
* "green"
* "orange"
* "pink"
* "purple"
* "red"
* "teal"
* "white"
* "yellow"
string
(values: imgSizeUndefined, HUGE, ICON, LARGE, MEDIUM, SMALL, XLARGE, XXLARGE): Returns images of a specified size. Acceptable values are: * "huge"
* "icon"
* "large"
* "medium"
* "small"
* "xlarge"
* "xxlarge"
string
(values: imgTypeUndefined, clipart, face, lineart, stock, photo, animated): Returns images of a type. Acceptable values are: * "clipart"
* "face"
* "lineart"
* "stock"
* "photo"
* "animated"
string
: Specifies that all search results should contain a link to a particular URL.string
: Specifies the starting value for a search range. Use lowRange
and highRange
to append an inclusive search range of lowRange...highRange
to the query.string
: 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)integer
: Number of search results to return. * Valid values are integers between 1 and 10, inclusive.string
: 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.string
: Querystring
: Specifies that all search results should be pages that are related to the specified URL.string
: Filters based on licensing. Supported values include: cc_publicdomain
, cc_attribute
, cc_sharealike
, cc_noncommercial
, cc_nonderived
and combinations of these. See typical combinations.string
(values: safeUndefined, active, high, medium, off): Search safety level. Acceptable values are: * "active"
: Enables SafeSearch filtering. * "off"
: Disables SafeSearch filtering. (default)string
(values: searchTypeUndefined, image): Specifies the search type: image
. If unspecified, results are limited to webpages. Acceptable values are: * "image"
: custom image search.string
: Specifies a given site which should always be included or excluded from results (see siteSearchFilter
parameter, below).string
(values: siteSearchFilterUndefined, e, i): Controls whether to include or exclude results from the site named in the siteSearch
parameter. Acceptable values are: * "e"
: exclude * "i"
: includestring
: 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.integer
: The index of the first result to return. The default number of results per page is 10, so &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.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_customsearch.search.cse.siterestrict.list({}, context)
object
string
: 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)string
: 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.string
: The Programmable Search Engine ID to use for this request.string
: 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.string
: Identifies a phrase that all documents in the search results must contain.string
: Identifies a word or phrase that should not appear in any documents in the search results.string
: Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center.string
: 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.string
: 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.string
: 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.string
: Specifies the ending value for a search range. * Use lowRange
and highRange
to append an inclusive search range of lowRange...highRange
to the query.string
: 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.string
: Appends the specified query terms to the query, as if they were combined with a logical AND operator.string
(values: imgColorTypeUndefined, mono, gray, color, trans): Returns black and white, grayscale, transparent, or color images. Acceptable values are: * "color"
* "gray"
* "mono"
: black and white * "trans"
: transparent backgroundstring
(values: imgDominantColorUndefined, black, blue, brown, gray, green, orange, pink, purple, red, teal, white, yellow): Returns images of a specific dominant color. Acceptable values are: * "black"
* "blue"
* "brown"
* "gray"
* "green"
* "orange"
* "pink"
* "purple"
* "red"
* "teal"
* "white"
* "yellow"
string
(values: imgSizeUndefined, HUGE, ICON, LARGE, MEDIUM, SMALL, XLARGE, XXLARGE): Returns images of a specified size. Acceptable values are: * "huge"
* "icon"
* "large"
* "medium"
* "small"
* "xlarge"
* "xxlarge"
string
(values: imgTypeUndefined, clipart, face, lineart, stock, photo, animated): Returns images of a type. Acceptable values are: * "clipart"
* "face"
* "lineart"
* "stock"
* "photo"
* "animated"
string
: Specifies that all search results should contain a link to a particular URL.string
: Specifies the starting value for a search range. Use lowRange
and highRange
to append an inclusive search range of lowRange...highRange
to the query.string
: 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)integer
: Number of search results to return. * Valid values are integers between 1 and 10, inclusive.string
: 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.string
: Querystring
: Specifies that all search results should be pages that are related to the specified URL.string
: Filters based on licensing. Supported values include: cc_publicdomain
, cc_attribute
, cc_sharealike
, cc_noncommercial
, cc_nonderived
and combinations of these. See typical combinations.string
(values: safeUndefined, active, high, medium, off): Search safety level. Acceptable values are: * "active"
: Enables SafeSearch filtering. * "off"
: Disables SafeSearch filtering. (default)string
(values: searchTypeUndefined, image): Specifies the search type: image
. If unspecified, results are limited to webpages. Acceptable values are: * "image"
: custom image search.string
: Specifies a given site which should always be included or excluded from results (see siteSearchFilter
parameter, below).string
(values: siteSearchFilterUndefined, e, i): Controls whether to include or exclude results from the site named in the siteSearch
parameter. Acceptable values are: * "e"
: exclude * "i"
: includestring
: 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.integer
: The index of the first result to return. The default number of results per page is 10, so &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.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").object
: Promotion result.
array
: An array of block objects for this promotion. See Google WebSearch Protocol reference for more information.
object
: Block object belonging to a promotion.
string
: The block object's text in HTML, if it has text.string
: The anchor text of the block object's link, if it has a link.string
: The block object's text, if it has text.string
: The URL of the block object's link, if it has one.string
: An abridged version of this search's result URL, e.g. www.example.com.string
: The title of the promotion, in HTML.object
: Image belonging to a promotion.
integer
: Image height in pixels.string
: URL of the image for this promotion link.integer
: Image width in pixels.string
: The URL of the promotion.string
: The title of the promotion.object
: A custom search result.
string
: Indicates the ID of Google's cached version of the search result.string
: An abridged version of this search result’s URL, e.g. www.example.com.string
: The file format of the search result.string
: The URL displayed after the snippet for each search result.string
: The HTML-formatted URL displayed after the snippet for each search result.string
: The snippet of the search result, in HTML.string
: The title of the search result, in HTML.object
: Image belonging to a custom search result.
integer
: The size of the image, in pixels.string
: A URL pointing to the webpage hosting the image.integer
: The height of the image, in pixels.integer
: The height of the thumbnail image, in pixels.string
: A URL to the thumbnail image.integer
: The width of the thumbnail image, in pixels.integer
: The width of the image, in pixels.string
: A unique identifier for the type of current object. For this API, it is customsearch#result.
array
: Encapsulates all information about refinement labels.
object
: Refinement label associated with a custom search result.
string
: The display name of a refinement label. This is the name you should display in your user interface.string
: Refinement label and the associated refinement operation.string
: The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.string
: The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.string
: The MIME type of the search result.object
: Contains PageMap information for this search result.string
: The snippet of the search result, in plain text.string
: The title of the search result, in plain text.object
: Response to a custom search request.
object
: Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of facet objects (refinements) you can use for refining a search.array
: The current set of custom search results.
string
: Unique identifier for the type of current object. For this API, it is customsearch#search.array
: The set of promotions. Present only if the custom search engine's configuration files define any promotions for the given query.
object
: Query metadata for the previous, current, and next pages of results.
array
: Metadata representing the next page of results, if applicable.
object
: Custom search request metadata.
integer
: Number of search results returned in this set.string
: 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.string
: 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.string
: 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.string
: Enables or disables the Simplified and Traditional Chinese Search feature. Supported values are: * 0
: enabled (default) * 1
: disabledstring
: Identifies a phrase that all documents in the search results must contain.string
: Identifies a word or phrase that should not appear in any documents in the search results.string
: 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.string
: 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.string
: 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.string
: Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.string
: 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.string
: 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.string
: Appends the specified query terms to the query, as if they were combined with a logical AND
operator.string
: Restricts results to images of a specified color type. Supported values are: * mono
(black and white) * gray
(grayscale) * color
(color)string
: Restricts results to images with a specific dominant color. Supported values are: * red
* orange
* yellow
* green
* teal
* blue
* purple
* pink
* white
* gray
* black
* brown
string
: Restricts results to images of a specified size. Supported values are: * icon
(small) * small | medium | large | xlarge
(medium) * xxlarge
(large) * huge
(extra-large)string
: 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)string
: The character encoding supported for search requests.string
: The language of the search results.string
: Specifies that all results should contain a link to a specific URL.string
: 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.string
: 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.string
: The character encoding supported for search results.string
: Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.string
: Filters based on licensing. Supported values include: * cc_publicdomain
* cc_attribute
* cc_sharealike
* cc_noncommercial
* cc_nonderived
string
: 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 SafeSearchstring
: The search terms entered by the user.string
: Allowed values are web
or image
. If unspecified, results are limited to webpages.string
: Restricts results to URLs from a specified site.string
: 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 sitestring
: Specifies that results should be sorted according to the specified expression. For example, sort by date.integer
: The index of the current set of search results into the total set of results, where the index of the first result is 1.integer
: The page number of this set of results, where the page length is set by the count
property.string
: A description of the query.string
: Estimated number of total search results. May not be accurate.array
: Metadata representing the previous page of results, if applicable.
object
: Custom search request metadata.
integer
: Number of search results returned in this set.string
: 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.string
: 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.string
: 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.string
: Enables or disables the Simplified and Traditional Chinese Search feature. Supported values are: * 0
: enabled (default) * 1
: disabledstring
: Identifies a phrase that all documents in the search results must contain.string
: Identifies a word or phrase that should not appear in any documents in the search results.string
: 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.string
: 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.string
: 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.string
: Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.string
: 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.string
: 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.string
: Appends the specified query terms to the query, as if they were combined with a logical AND
operator.string
: Restricts results to images of a specified color type. Supported values are: * mono
(black and white) * gray
(grayscale) * color
(color)string
: Restricts results to images with a specific dominant color. Supported values are: * red
* orange
* yellow
* green
* teal
* blue
* purple
* pink
* white
* gray
* black
* brown
string
: Restricts results to images of a specified size. Supported values are: * icon
(small) * small | medium | large | xlarge
(medium) * xxlarge
(large) * huge
(extra-large)string
: 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)string
: The character encoding supported for search requests.string
: The language of the search results.string
: Specifies that all results should contain a link to a specific URL.string
: 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.string
: 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.string
: The character encoding supported for search results.string
: Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.string
: Filters based on licensing. Supported values include: * cc_publicdomain
* cc_attribute
* cc_sharealike
* cc_noncommercial
* cc_nonderived
string
: 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 SafeSearchstring
: The search terms entered by the user.string
: Allowed values are web
or image
. If unspecified, results are limited to webpages.string
: Restricts results to URLs from a specified site.string
: 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 sitestring
: Specifies that results should be sorted according to the specified expression. For example, sort by date.integer
: The index of the current set of search results into the total set of results, where the index of the first result is 1.integer
: The page number of this set of results, where the page length is set by the count
property.string
: A description of the query.string
: Estimated number of total search results. May not be accurate.array
: Metadata representing the current request.
object
: Custom search request metadata.
integer
: Number of search results returned in this set.string
: 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.string
: 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.string
: 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.string
: Enables or disables the Simplified and Traditional Chinese Search feature. Supported values are: * 0
: enabled (default) * 1
: disabledstring
: Identifies a phrase that all documents in the search results must contain.string
: Identifies a word or phrase that should not appear in any documents in the search results.string
: 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.string
: 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.string
: 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.string
: Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.string
: 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.string
: 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.string
: Appends the specified query terms to the query, as if they were combined with a logical AND
operator.string
: Restricts results to images of a specified color type. Supported values are: * mono
(black and white) * gray
(grayscale) * color
(color)string
: Restricts results to images with a specific dominant color. Supported values are: * red
* orange
* yellow
* green
* teal
* blue
* purple
* pink
* white
* gray
* black
* brown
string
: Restricts results to images of a specified size. Supported values are: * icon
(small) * small | medium | large | xlarge
(medium) * xxlarge
(large) * huge
(extra-large)string
: 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)string
: The character encoding supported for search requests.string
: The language of the search results.string
: Specifies that all results should contain a link to a specific URL.string
: 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.string
: 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.string
: The character encoding supported for search results.string
: Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.string
: Filters based on licensing. Supported values include: * cc_publicdomain
* cc_attribute
* cc_sharealike
* cc_noncommercial
* cc_nonderived
string
: 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 SafeSearchstring
: The search terms entered by the user.string
: Allowed values are web
or image
. If unspecified, results are limited to webpages.string
: Restricts results to URLs from a specified site.string
: 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 sitestring
: Specifies that results should be sorted according to the specified expression. For example, sort by date.integer
: The index of the current set of search results into the total set of results, where the index of the first result is 1.integer
: The page number of this set of results, where the page length is set by the count
property.string
: A description of the query.string
: Estimated number of total search results. May not be accurate.object
: Metadata about a search operation.
string
: The time taken for the server to return search results, formatted according to locale style.string
: The total number of search results, formatted according to locale style.number
: The time taken for the server to return search results.string
: The total number of search results returned by the query.object
: Spell correction information for a query.
string
: The corrected query.string
: The corrected query, formatted in HTML.object
: OpenSearch template and URL.
string
: The actual OpenSearch template for this API.string
: The MIME type of the OpenSearch URL template for the Custom Search JSON API.FAQs
DataFire integration for Custom Search API
The npm package @datafire/google_customsearch receives a total of 0 weekly downloads. As such, @datafire/google_customsearch popularity was classified as not popular.
We found that @datafire/google_customsearch demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
Company News
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.
Security News
OSI is starting a conversation aimed at removing the excuse of the SaaS loophole for companies navigating licensing and the complexities of doing business with open source.