Class: Google::Apis::CustomsearchV1::CustomsearchService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/customsearch_v1/service.rb

Overview

Custom Search API

Searches over a website or collection of websites

Examples:

require 'google/apis/customsearch_v1'

Customsearch = Google::Apis::CustomsearchV1 # Alias the module
service = Customsearch::CustomsearchService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCustomsearchService

Returns a new instance of CustomsearchService.



45
46
47
48
# File 'generated/google/apis/customsearch_v1/service.rb', line 45

def initialize
  super('https://customsearch.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns 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.

Returns:

  • (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.



38
39
40
# File 'generated/google/apis/customsearch_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns 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.

Returns:

  • (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.



43
44
45
# File 'generated/google/apis/customsearch_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#list_cse_siterestricts(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CustomsearchV1::Search

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.

Parameters:

  • c2coff (String) (defaults to: nil)

    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)
  • cr (String) (defaults to: nil)

    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.
  • cx (String) (defaults to: nil)

    The custom search engine ID to use for this request.

  • date_restrict (String) (defaults to: nil)

    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.
  • exact_terms (String) (defaults to: nil)

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

  • exclude_terms (String) (defaults to: nil)

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

  • file_type (String) (defaults to: nil)

    Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center.

  • filter (String) (defaults to: nil)

    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.
  • gl (String) (defaults to: nil)

    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.
  • googlehost (String) (defaults to: nil)

    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.

  • high_range (String) (defaults to: nil)

    Specifies the ending value for a search range.

    • Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.
  • hl (String) (defaults to: nil)

    Sets the user interface language.

  • hq (String) (defaults to: nil)

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

  • img_color_type (String) (defaults to: nil)

    Returns black and white, grayscale, transparent, or color images. Acceptable values are:

    • "color"
    • "gray"
    • "mono": black and white
    • "trans": transparent background
  • img_dominant_color (String) (defaults to: nil)

    Returns images of a specific dominant color. Acceptable values are:

    • "black"
    • "blue"
    • "brown"
    • "gray"
    • "green"
    • "orange"
    • "pink"
    • "purple"
    • "red"
    • "teal"
    • "white"
    • "yellow"
  • img_size (String) (defaults to: nil)

    Returns images of a specified size. Acceptable values are:

    • "huge"
    • "icon"
    • "large"
    • "medium"
    • "small"
    • "xlarge"
    • "xxlarge"
  • img_type (String) (defaults to: nil)

    Returns images of a type. Acceptable values are:

    • "clipart"
    • "face"
    • "lineart"
    • "stock"
    • "photo"
    • "animated"
  • link_site (String) (defaults to: nil)

    Specifies that all search results should contain a link to a particular URL.

  • low_range (String) (defaults to: nil)

    Specifies the starting value for a search range. Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

  • lr (String) (defaults to: nil)

    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)
  • num (Fixnum) (defaults to: nil)

    Number of search results to return.

    • Valid values are integers between 1 and 10, inclusive.
  • or_terms (String) (defaults to: nil)

    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.

  • q (String) (defaults to: nil)

    Query

  • related_site (String) (defaults to: nil)

    Specifies that all search results should be pages that are related to the specified URL.

  • rights (String) (defaults to: nil)

    Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See typical combinations.

  • safe (String) (defaults to: nil)

    Search safety level. Acceptable values are:

    • "active": Enables SafeSearch filtering.
    • "off": Disables SafeSearch filtering. (default)
  • search_type (String) (defaults to: nil)

    Specifies the search type: image. If unspecified, results are limited to webpages. Acceptable values are:

    • "image": custom image search.
  • site_search (String) (defaults to: nil)

    Specifies a given site which should always be included or excluded from results (see siteSearchFilter parameter, below).

  • site_search_filter (String) (defaults to: nil)

    Controls whether to include or exclude results from the site named in the siteSearch parameter. Acceptable values are:

    • "e": exclude
    • "i": include
  • sort (String) (defaults to: nil)

    The sort expression to apply to the results.

  • start (Fixnum) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
# File 'generated/google/apis/customsearch_v1/service.rb', line 559

def list_cse_siterestricts(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'customsearch/v1/siterestrict', options)
  command.response_representation = Google::Apis::CustomsearchV1::Search::Representation
  command.response_class = Google::Apis::CustomsearchV1::Search
  command.query['c2coff'] = c2coff unless c2coff.nil?
  command.query['cr'] = cr unless cr.nil?
  command.query['cx'] = cx unless cx.nil?
  command.query['dateRestrict'] = date_restrict unless date_restrict.nil?
  command.query['exactTerms'] = exact_terms unless exact_terms.nil?
  command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil?
  command.query['fileType'] = file_type unless file_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['gl'] = gl unless gl.nil?
  command.query['googlehost'] = googlehost unless googlehost.nil?
  command.query['highRange'] = high_range unless high_range.nil?
  command.query['hl'] = hl unless hl.nil?
  command.query['hq'] = hq unless hq.nil?
  command.query['imgColorType'] = img_color_type unless img_color_type.nil?
  command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil?
  command.query['imgSize'] = img_size unless img_size.nil?
  command.query['imgType'] = img_type unless img_type.nil?
  command.query['linkSite'] = link_site unless link_site.nil?
  command.query['lowRange'] = low_range unless low_range.nil?
  command.query['lr'] = lr unless lr.nil?
  command.query['num'] = num unless num.nil?
  command.query['orTerms'] = or_terms unless or_terms.nil?
  command.query['q'] = q unless q.nil?
  command.query['relatedSite'] = related_site unless related_site.nil?
  command.query['rights'] = rights unless rights.nil?
  command.query['safe'] = safe unless safe.nil?
  command.query['searchType'] = search_type unless search_type.nil?
  command.query['siteSearch'] = site_search unless site_search.nil?
  command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['start'] = start unless start.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_cses(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CustomsearchV1::Search

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

Parameters:

  • c2coff (String) (defaults to: nil)

    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)
  • cr (String) (defaults to: nil)

    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.
  • cx (String) (defaults to: nil)

    The custom search engine ID to use for this request.

  • date_restrict (String) (defaults to: nil)

    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.
  • exact_terms (String) (defaults to: nil)

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

  • exclude_terms (String) (defaults to: nil)

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

  • file_type (String) (defaults to: nil)

    Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console Help Center.

  • filter (String) (defaults to: nil)

    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.
  • gl (String) (defaults to: nil)

    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.
  • googlehost (String) (defaults to: nil)

    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.

  • high_range (String) (defaults to: nil)

    Specifies the ending value for a search range.

    • Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.
  • hl (String) (defaults to: nil)

    Sets the user interface language.

  • hq (String) (defaults to: nil)

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

  • img_color_type (String) (defaults to: nil)

    Returns black and white, grayscale, transparent, or color images. Acceptable values are:

    • "color"
    • "gray"
    • "mono": black and white
    • "trans": transparent background
  • img_dominant_color (String) (defaults to: nil)

    Returns images of a specific dominant color. Acceptable values are:

    • "black"
    • "blue"
    • "brown"
    • "gray"
    • "green"
    • "orange"
    • "pink"
    • "purple"
    • "red"
    • "teal"
    • "white"
    • "yellow"
  • img_size (String) (defaults to: nil)

    Returns images of a specified size. Acceptable values are:

    • "huge"
    • "icon"
    • "large"
    • "medium"
    • "small"
    • "xlarge"
    • "xxlarge"
  • img_type (String) (defaults to: nil)

    Returns images of a type. Acceptable values are:

    • "clipart"
    • "face"
    • "lineart"
    • "stock"
    • "photo"
    • "animated"
  • link_site (String) (defaults to: nil)

    Specifies that all search results should contain a link to a particular URL.

  • low_range (String) (defaults to: nil)

    Specifies the starting value for a search range. Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

  • lr (String) (defaults to: nil)

    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)
  • num (Fixnum) (defaults to: nil)

    Number of search results to return.

    • Valid values are integers between 1 and 10, inclusive.
  • or_terms (String) (defaults to: nil)

    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.

  • q (String) (defaults to: nil)

    Query

  • related_site (String) (defaults to: nil)

    Specifies that all search results should be pages that are related to the specified URL.

  • rights (String) (defaults to: nil)

    Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See typical combinations.

  • safe (String) (defaults to: nil)

    Search safety level. Acceptable values are:

    • "active": Enables SafeSearch filtering.
    • "off": Disables SafeSearch filtering. (default)
  • search_type (String) (defaults to: nil)

    Specifies the search type: image. If unspecified, results are limited to webpages. Acceptable values are:

    • "image": custom image search.
  • site_search (String) (defaults to: nil)

    Specifies a given site which should always be included or excluded from results (see siteSearchFilter parameter, below).

  • site_search_filter (String) (defaults to: nil)

    Controls whether to include or exclude results from the site named in the siteSearch parameter. Acceptable values are:

    • "e": exclude
    • "i": include
  • sort (String) (defaults to: nil)

    The sort expression to apply to the results.

  • start (Fixnum) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'generated/google/apis/customsearch_v1/service.rb', line 284

def list_cses(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'customsearch/v1', options)
  command.response_representation = Google::Apis::CustomsearchV1::Search::Representation
  command.response_class = Google::Apis::CustomsearchV1::Search
  command.query['c2coff'] = c2coff unless c2coff.nil?
  command.query['cr'] = cr unless cr.nil?
  command.query['cx'] = cx unless cx.nil?
  command.query['dateRestrict'] = date_restrict unless date_restrict.nil?
  command.query['exactTerms'] = exact_terms unless exact_terms.nil?
  command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil?
  command.query['fileType'] = file_type unless file_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['gl'] = gl unless gl.nil?
  command.query['googlehost'] = googlehost unless googlehost.nil?
  command.query['highRange'] = high_range unless high_range.nil?
  command.query['hl'] = hl unless hl.nil?
  command.query['hq'] = hq unless hq.nil?
  command.query['imgColorType'] = img_color_type unless img_color_type.nil?
  command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil?
  command.query['imgSize'] = img_size unless img_size.nil?
  command.query['imgType'] = img_type unless img_type.nil?
  command.query['linkSite'] = link_site unless link_site.nil?
  command.query['lowRange'] = low_range unless low_range.nil?
  command.query['lr'] = lr unless lr.nil?
  command.query['num'] = num unless num.nil?
  command.query['orTerms'] = or_terms unless or_terms.nil?
  command.query['q'] = q unless q.nil?
  command.query['relatedSite'] = related_site unless related_site.nil?
  command.query['rights'] = rights unless rights.nil?
  command.query['safe'] = safe unless safe.nil?
  command.query['searchType'] = search_type unless search_type.nil?
  command.query['siteSearch'] = site_search unless site_search.nil?
  command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['start'] = start unless start.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end