Google_Service_Customsearch_Cse_Resource

The "cse" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/Customsearch.php  
  1. class Google_Service_Customsearch_Cse_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Returns metadata about the search performed, metadata about the custom search 
  5. * engine used for the search, and the search results. (cse.listCse) 
  6. * @param string $q Query 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string sort The sort expression to apply to the results 
  9. * @opt_param string orTerms Provides additional search terms to check for in a 
  10. * document, where each document in the search results must contain at least one 
  11. * of the additional search terms 
  12. * @opt_param string highRange Creates a range in form as_nlo value..as_nhi 
  13. * value and attempts to append it to query 
  14. * @opt_param string num Number of search results to return 
  15. * @opt_param string cr Country restrict(s). 
  16. * @opt_param string imgType Returns images of a type, which can be one of: 
  17. * clipart, face, lineart, news, and photo. 
  18. * @opt_param string gl Geolocation of end user. 
  19. * @opt_param string relatedSite Specifies that all search results should be 
  20. * pages that are related to the specified URL 
  21. * @opt_param string searchType Specifies the search type: image. 
  22. * @opt_param string fileType Returns images of a specified type. Some of the 
  23. * allowed values are: bmp, gif, png, jpg, svg, pdf, ... 
  24. * @opt_param string start The index of the first result to return 
  25. * @opt_param string imgDominantColor Returns images of a specific dominant 
  26. * color: yellow, green, teal, blue, purple, pink, white, gray, black and brown. 
  27. * @opt_param string lr The language restriction for the search results 
  28. * @opt_param string siteSearch Specifies all search results should be pages 
  29. * from a given site 
  30. * @opt_param string cref The URL of a linked custom search engine 
  31. * @opt_param string dateRestrict Specifies all search results are from a time 
  32. * period 
  33. * @opt_param string safe Search safety level 
  34. * @opt_param string c2coff Turns off the translation between zh-CN and zh-TW. 
  35. * @opt_param string googlehost The local Google domain to use to perform the 
  36. * search. 
  37. * @opt_param string hq Appends the extra query terms to the query. 
  38. * @opt_param string exactTerms Identifies a phrase that all documents in the 
  39. * search results must contain 
  40. * @opt_param string hl Sets the user interface language. 
  41. * @opt_param string lowRange Creates a range in form as_nlo value..as_nhi value 
  42. * and attempts to append it to query 
  43. * @opt_param string imgSize Returns images of a specified size, where size can 
  44. * be one of: icon, small, medium, large, xlarge, xxlarge, and huge. 
  45. * @opt_param string imgColorType Returns black and white, grayscale, or color 
  46. * images: mono, gray, and color. 
  47. * @opt_param string rights Filters based on licensing. Supported values 
  48. * include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial,  
  49. * cc_nonderived and combinations of these. 
  50. * @opt_param string excludeTerms Identifies a word or phrase that should not 
  51. * appear in any documents in the search results 
  52. * @opt_param string filter Controls turning on or off the duplicate content 
  53. * filter. 
  54. * @opt_param string linkSite Specifies that all search results should contain a 
  55. * link to a particular URL 
  56. * @opt_param string cx The custom search engine ID to scope this search query 
  57. * @opt_param string siteSearchFilter Controls whether to include or exclude 
  58. * results from the site named in the as_sitesearch parameter 
  59. * @return Google_Service_Customsearch_Search 
  60. */ 
  61. public function listCse($q, $optParams = array()) 
  62. $params = array('q' => $q); 
  63. $params = array_merge($params, $optParams); 
  64. return $this->call('list', array($params), "Google_Service_Customsearch_Search");