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

Inherits:

Google::Apis::Core::BaseService

• Object
• Google::Apis::Core::BaseService
• Google::Apis::CustomsearchV1::CustomsearchService

Defined in:

generated/google/apis/customsearch_v1/service.rb

Overview

CustomSearch 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:

• https://developers.google.com/custom-search/v1/using_rest

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  An opaque string that represents a user for quota purposes.

• #user_ip ⇒ String

  Deprecated.

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

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

Instance Method Summary

• #initialize ⇒ CustomsearchService constructor

  A new instance of CustomsearchService.

• #list_cse_siterestricts(q, 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, 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, user_ip: 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.

• #list_cses(q, 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, 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, user_ip: 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.

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

#batch, #batch_upload, #fetch_all, #http

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

#logger

Constructor Details

#initialize ⇒ CustomsearchService

Returns a new instance of CustomsearchService

# File 'generated/google/apis/customsearch_v1/service.rb', line 49

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

Instance Attribute Details

#key ⇒ String

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.

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

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

• (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

• (String) —

  Deprecated. Please use quotaUser instead.

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

def user_ip
  @user_ip
end

Instance Method Details

#list_cse_siterestricts(q, 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, 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, user_ip: 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:

• q (String) —

  Query

• c2coff (String) —

  Turns off the translation between zh-CN and zh-TW.

• cr (String) —

  Country restrict(s).

• cx (String) —

  The custom search engine ID to scope this search query

• date_restrict (String) —

  Specifies all search results are from a time period

• exact_terms (String) —

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

• exclude_terms (String) —

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

• file_type (String) —

  Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...

• filter (String) —

  Controls turning on or off the duplicate content filter.

• gl (String) —

  Geolocation of end user.

• googlehost (String) —

  The local Google domain to use to perform the search.

• high_range (String) —

  Creates a range in form as_nlo value..as_nhi value and attempts to append it to query

• hl (String) —

  Sets the user interface language.

• hq (String) —

  Appends the extra query terms to the query.

• img_color_type (String) —

  Returns black and white, grayscale, or color images: mono, gray, and color.

• img_dominant_color (String) —

  Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.

• img_size (String) —

  Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.

• img_type (String) —

  Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.

• link_site (String) —

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

• low_range (String) —

  Creates a range in form as_nlo value..as_nhi value and attempts to append it to query

• lr (String) —

  The language restriction for the search results

• num (Fixnum) —

  Number of search results to return

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

• related_site (String) —

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

• rights (String) —

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

• safe (String) —

  Search safety level

• search_type (String) —

  Specifies the search type: image.

• site_search (String) —

  Specifies all search results should be pages from a given site

• site_search_filter (String) —

  Controls whether to include or exclude results from the site named in the as_sitesearch parameter

• sort (String) —

  The sort expression to apply to the results

• start (Fixnum) —

  The index of the first result to return

• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CustomsearchV1::Search) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CustomsearchV1::Search)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/customsearch_v1/service.rb', line 288

def list_cse_siterestricts(q, 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, 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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_cses(q, 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, 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, user_ip: 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:

• q (String) —

  Query

• c2coff (String) —

  Turns off the translation between zh-CN and zh-TW.

• cr (String) —

  Country restrict(s).

• cx (String) —

  The custom search engine ID to scope this search query

• date_restrict (String) —

  Specifies all search results are from a time period

• exact_terms (String) —

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

• exclude_terms (String) —

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

• file_type (String) —

  Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...

• filter (String) —

  Controls turning on or off the duplicate content filter.

• gl (String) —

  Geolocation of end user.

• googlehost (String) —

  The local Google domain to use to perform the search.

• high_range (String) —

  Creates a range in form as_nlo value..as_nhi value and attempts to append it to query

• hl (String) —

  Sets the user interface language.

• hq (String) —

  Appends the extra query terms to the query.

• img_color_type (String) —

  Returns black and white, grayscale, or color images: mono, gray, and color.

• img_dominant_color (String) —

  Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.

• img_size (String) —

  Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.

• img_type (String) —

  Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.

• link_site (String) —

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

• low_range (String) —

  Creates a range in form as_nlo value..as_nhi value and attempts to append it to query

• lr (String) —

  The language restriction for the search results

• num (Fixnum) —

  Number of search results to return

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

• related_site (String) —

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

• rights (String) —

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

• safe (String) —

  Search safety level

• search_type (String) —

  Specifies the search type: image.

• site_search (String) —

  Specifies all search results should be pages from a given site

• site_search_filter (String) —

  Controls whether to include or exclude results from the site named in the as_sitesearch parameter

• sort (String) —

  The sort expression to apply to the results

• start (Fixnum) —

  The index of the first result to return

• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CustomsearchV1::Search) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CustomsearchV1::Search)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/customsearch_v1/service.rb', line 150

def list_cses(q, 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, 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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end