google_api_custom_search v0.9.0 GoogleApi.CustomSearch.V1.Api.Siterestrict View Source
API calls for all endpoints tagged Siterestrict
.
Link to this section Summary
Functions
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.
Link to this section Functions
Link to this function
search_cse_siterestrict_list(connection, optional_params \\ [], opts \\ [])
View Sourcesearch_cse_siterestrict_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CustomSearch.V1.Model.Search.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
connection
(type:GoogleApi.CustomSearch.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:c2coff
(type:String.t
) - Turns off the translation between zh-CN and zh-TW.:cr
(type:String.t
) - Country restrict(s).:cx
(type:String.t
) - The custom search engine ID to scope this search query:dateRestrict
(type:String.t
) - Specifies all search results are from a time period:exactTerms
(type:String.t
) - Identifies a phrase that all documents in the search results must contain:excludeTerms
(type:String.t
) - Identifies a word or phrase that should not appear in any documents in the search results:fileType
(type:String.t
) - Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...:filter
(type:String.t
) - Controls turning on (1) or off (0) the duplicate content filter.:gl
(type:String.t
) - Geolocation of end user.:googlehost
(type:String.t
) - The local Google domain to use to perform the search.:highRange
(type:String.t
) - Creates a range in form as_nlo value..as_nhi value and attempts to append it to query:hl
(type:String.t
) - Sets the user interface language.:hq
(type:String.t
) - Appends the extra hidden query terms to the query.:imgColorType
(type:String.t
) - Returns black and white, grayscale, transparent-background or color images: mono, gray, trans, and color.:imgDominantColor
(type:String.t
) - Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.:imgSize
(type:String.t
) - Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.:imgType
(type:String.t
) - Returns images of a type, which can be one of: clipart, face, lineart, stock, photo, and animated.:linkSite
(type:String.t
) - Specifies that all search results should contain a link to a particular URL:lowRange
(type:String.t
) - Creates a range in form as_nlo value..as_nhi value and attempts to append it to query:lr
(type:String.t
) - The language restriction for the search results:num
(type:integer()
) - Number of search results to return:orTerms
(type:String.t
) - 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
(type:String.t
) - Query:relatedSite
(type:String.t
) - Specifies that all search results should be pages that are related to the specified URL:rights
(type:String.t
) - Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See https://wiki.creativecommons.org/wiki/CC_Search_integration for typical combinations.:safe
(type:String.t
) - Search safety level (active, off) (high, medium are same as active):searchType
(type:String.t
) - Specifies the search type: image.:siteSearch
(type:String.t
) - Specifies all search results should be pages from a given site:siteSearchFilter
(type:String.t
) - Controls whether to include (i) or exclude (e) results from the site named in the siteSearch parameter:sort
(type:String.t
) - The sort expression to apply to the results:start
(type:integer()
) - The index of the first result to return
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CustomSearch.V1.Model.Search{}}
on success{:error, info}
on failure