Class: Google::Apis::CustomsearchV1::Search::Queries::NextPage

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/customsearch_v1/classes.rb,
generated/google/apis/customsearch_v1/representations.rb,
generated/google/apis/customsearch_v1/representations.rb

Overview

Custom search request metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NextPage

Returns a new instance of NextPage.



688
689
690
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 688

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#count ⇒ Fixnum

Number of search results returned in this set. Corresponds to the JSON property count

Returns:

  • (Fixnum) 


442
443
444
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 442

def count
  @count
end

#cr ⇒ 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. Corresponds to the JSON property cr

Returns:

  • (String) 


454
455
456
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 454

def cr
  @cr
end

#cx ⇒ 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. Corresponds to the JSON property cx

Returns:

  • (String) 


461
462
463
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 461

def cx
  @cx
end

#date_restrict ⇒ 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. Corresponds to the JSON property dateRestrict

Returns:

  • (String) 


470
471
472
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 470

def date_restrict
  @date_restrict
end

#disable_cn_tw_translation ⇒ String

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

Returns:

  • (String) 


477
478
479
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 477

def disable_cn_tw_translation
  @disable_cn_tw_translation
end

#exact_terms ⇒ String

Identifies a phrase that all documents in the search results must contain. Corresponds to the JSON property exactTerms

Returns:

  • (String) 


482
483
484
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 482

def exact_terms
  @exact_terms
end

#exclude_terms ⇒ String

Identifies a word or phrase that should not appear in any documents in the search results. Corresponds to the JSON property excludeTerms

Returns:

  • (String) 


488
489
490
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 488

def exclude_terms
  @exclude_terms
end

#file_type ⇒ 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. Corresponds to the JSON property fileType

Returns:

  • (String) 


501
502
503
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 501

def file_type
  @file_type
end

#filter ⇒ 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. Corresponds to the JSON property filter

Returns:

  • (String) 


511
512
513
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 511

def filter
  @filter
end

#gl ⇒ 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. Corresponds to the JSON property gl

Returns:

  • (String) 


521
522
523
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 521

def gl
  @gl
end

#google_host ⇒ String

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

Returns:

  • (String) 


527
528
529
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 527

def google_host
  @google_host
end

#high_range ⇒ 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. Corresponds to the JSON property highRange

Returns:

  • (String) 


534
535
536
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 534

def high_range
  @high_range
end

#hl ⇒ 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. Corresponds to the JSON property hl

Returns:

  • (String) 


547
548
549
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 547

def hl
  @hl
end

#hq ⇒ String

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

Returns:

  • (String) 


553
554
555
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 553

def hq
  @hq
end

#img_color_type ⇒ String

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

Returns:

  • (String) 


559
560
561
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 559

def img_color_type
  @img_color_type
end

#img_dominant_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 Corresponds to the JSON property imgDominantColor

Returns:

  • (String) 


566
567
568
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 566

def img_dominant_color
  @img_dominant_color
end

#img_size ⇒ String

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

Returns:

  • (String) 


573
574
575
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 573

def img_size
  @img_size
end

#img_type ⇒ 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) Corresponds to the JSON property imgType

Returns:

  • (String) 


580
581
582
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 580

def img_type
  @img_type
end

#input_encoding ⇒ String

The character encoding supported for search requests. Corresponds to the JSON property inputEncoding

Returns:

  • (String) 


585
586
587
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 585

def input_encoding
  @input_encoding
end

#language ⇒ String

The language of the search results. Corresponds to the JSON property language

Returns:

  • (String) 


590
591
592
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 590

def language
  @language
end

#link_site ⇒ String

Specifies that all results should contain a link to a specific URL. Corresponds to the JSON property linkSite

Returns:

  • (String) 


595
596
597
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 595

def link_site
  @link_site
end

#low_range ⇒ 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. Corresponds to the JSON property lowRange

Returns:

  • (String) 


602
603
604
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 602

def low_range
  @low_range
end

#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. You can also use the Boolean OR query term for this type of query. Corresponds to the JSON property orTerms

Returns:

  • (String) 


610
611
612
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 610

def or_terms
  @or_terms
end

#output_encoding ⇒ String

The character encoding supported for search results. Corresponds to the JSON property outputEncoding

Returns:

  • (String) 


615
616
617
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 615

def output_encoding
  @output_encoding
end

#related_site ⇒ String

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

Returns:

  • (String) 


621
622
623
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 621

def related_site
  @related_site
end

#rights ⇒ String

Filters based on licensing. Supported values include: * cc_publicdomain * cc_attribute * cc_sharealike * cc_noncommercial * cc_nonderived Corresponds to the JSON property rights

Returns:

  • (String) 


627
628
629
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 627

def rights
  @rights
end

#safe ⇒ 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 SafeSearch Corresponds to the JSON property safe

Returns:

  • (String) 


635
636
637
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 635

def safe
  @safe
end

#search_terms ⇒ String

The search terms entered by the user. Corresponds to the JSON property searchTerms

Returns:

  • (String) 


640
641
642
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 640

def search_terms
  @search_terms
end

#search_type ⇒ String

Allowed values are web or image. If unspecified, results are limited to webpages. Corresponds to the JSON property searchType

Returns:

  • (String) 


646
647
648
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 646

def search_type
  @search_type
end

#site_search ⇒ String

Restricts results to URLs from a specified site. Corresponds to the JSON property siteSearch

Returns:

  • (String) 


651
652
653
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 651

def site_search
  @site_search
end

#site_search_filter ⇒ 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 site Corresponds to the JSON property siteSearchFilter

Returns:

  • (String) 


658
659
660
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 658

def site_search_filter
  @site_search_filter
end

#sort ⇒ String

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

Returns:

  • (String) 


664
665
666
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 664

def sort
  @sort
end

#start_index ⇒ Fixnum

The index of the current set of search results into the total set of results, where the index of the first result is 1. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


670
671
672
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 670

def start_index
  @start_index
end

#start_page ⇒ Fixnum

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

Returns:

  • (Fixnum) 


676
677
678
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 676

def start_page
  @start_page
end

#title ⇒ String

A description of the query. Corresponds to the JSON property title

Returns:

  • (String) 


681
682
683
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 681

def title
  @title
end

#total_results ⇒ Fixnum

Estimated number of total search results. May not be accurate. Corresponds to the JSON property totalResults

Returns:

  • (Fixnum) 


686
687
688
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 686

def total_results
  @total_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'generated/google/apis/customsearch_v1/classes.rb', line 693

def update!(**args)
  @count = args[:count] if args.key?(:count)
  @cr = args[:cr] if args.key?(:cr)
  @cx = args[:cx] if args.key?(:cx)
  @date_restrict = args[:date_restrict] if args.key?(:date_restrict)
  @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation)
  @exact_terms = args[:exact_terms] if args.key?(:exact_terms)
  @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms)
  @file_type = args[:file_type] if args.key?(:file_type)
  @filter = args[:filter] if args.key?(:filter)
  @gl = args[:gl] if args.key?(:gl)
  @google_host = args[:google_host] if args.key?(:google_host)
  @high_range = args[:high_range] if args.key?(:high_range)
  @hl = args[:hl] if args.key?(:hl)
  @hq = args[:hq] if args.key?(:hq)
  @img_color_type = args[:img_color_type] if args.key?(:img_color_type)
  @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color)
  @img_size = args[:img_size] if args.key?(:img_size)
  @img_type = args[:img_type] if args.key?(:img_type)
  @input_encoding = args[:input_encoding] if args.key?(:input_encoding)
  @language = args[:language] if args.key?(:language)
  @link_site = args[:link_site] if args.key?(:link_site)
  @low_range = args[:low_range] if args.key?(:low_range)
  @or_terms = args[:or_terms] if args.key?(:or_terms)
  @output_encoding = args[:output_encoding] if args.key?(:output_encoding)
  @related_site = args[:related_site] if args.key?(:related_site)
  @rights = args[:rights] if args.key?(:rights)
  @safe = args[:safe] if args.key?(:safe)
  @search_terms = args[:search_terms] if args.key?(:search_terms)
  @search_type = args[:search_type] if args.key?(:search_type)
  @site_search = args[:site_search] if args.key?(:site_search)
  @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter)
  @sort = args[:sort] if args.key?(:sort)
  @start_index = args[:start_index] if args.key?(:start_index)
  @start_page = args[:start_page] if args.key?(:start_page)
  @title = args[:title] if args.key?(:title)
  @total_results = args[:total_results] if args.key?(:total_results)
end