google_customsearch_api::CseResource_ListMethod Class Reference

#include <customsearch_service.h>

Inheritance diagram for google_customsearch_api::CseResource_ListMethod:

Public Member Functions
	CseResource_ListMethod (const CustomsearchService *_service_, client::AuthorizationCredential *_credential_)
virtual	~CseResource_ListMethod ()
void	clear_sort ()
const string &	get_sort () const
string *	mutable_sort ()
void	set_sort (const string &value)
void	clear_link_site ()
const string &	get_link_site () const
string *	mutable_linkSite ()
void	set_link_site (const string &value)
void	clear_hq ()
const string &	get_hq () const
string *	mutable_hq ()
void	set_hq (const string &value)
void	clear_search_type ()
const string &	get_search_type () const
string *	mutable_searchType ()
void	set_search_type (const string &value)
void	clear_file_type ()
const string &	get_file_type () const
string *	mutable_fileType ()
void	set_file_type (const string &value)
void	clear_related_site ()
const string &	get_related_site () const
string *	mutable_relatedSite ()
void	set_related_site (const string &value)
void	clear_site_search ()
const string &	get_site_search () const
string *	mutable_siteSearch ()
void	set_site_search (const string &value)
void	clear_exclude_terms ()
const string &	get_exclude_terms () const
string *	mutable_excludeTerms ()
void	set_exclude_terms (const string &value)
void	clear_exact_terms ()
const string &	get_exact_terms () const
string *	mutable_exactTerms ()
void	set_exact_terms (const string &value)
void	clear_num ()
int32	get_num () const
void	set_num (int32 value)
void	clear_img_type ()
const string &	get_img_type () const
string *	mutable_imgType ()
void	set_img_type (const string &value)
void	clear_c2coff ()
const string &	get_c2coff () const
string *	mutable_c2coff ()
void	set_c2coff (const string &value)
void	clear_filter ()
const string &	get_filter () const
string *	mutable_filter ()
void	set_filter (const string &value)
void	clear_high_range ()
const string &	get_high_range () const
string *	mutable_highRange ()
void	set_high_range (const string &value)
void	clear_hl ()
const string &	get_hl () const
string *	mutable_hl ()
void	set_hl (const string &value)
void	clear_gl ()
const string &	get_gl () const
string *	mutable_gl ()
void	set_gl (const string &value)
void	clear_googlehost ()
const string &	get_googlehost () const
string *	mutable_googlehost ()
void	set_googlehost (const string &value)
void	clear_img_size ()
const string &	get_img_size () const
string *	mutable_imgSize ()
void	set_img_size (const string &value)
void	clear_cr ()
const string &	get_cr () const
string *	mutable_cr ()
void	set_cr (const string &value)
void	clear_or_terms ()
const string &	get_or_terms () const
string *	mutable_orTerms ()
void	set_or_terms (const string &value)
void	clear_date_restrict ()
const string &	get_date_restrict () const
string *	mutable_dateRestrict ()
void	set_date_restrict (const string &value)
void	clear_rights ()
const string &	get_rights () const
string *	mutable_rights ()
void	set_rights (const string &value)
void	clear_q ()
const string &	get_q () const
string *	mutable_q ()
void	set_q (const string &value)
void	clear_cx ()
const string &	get_cx () const
string *	mutable_cx ()
void	set_cx (const string &value)
void	clear_low_range ()
const string &	get_low_range () const
string *	mutable_lowRange ()
void	set_low_range (const string &value)
void	clear_lr ()
const string &	get_lr () const
string *	mutable_lr ()
void	set_lr (const string &value)
void	clear_img_dominant_color ()
const string &	get_img_dominant_color () const
string *	mutable_imgDominantColor ()
void	set_img_dominant_color (const string &value)
void	clear_img_color_type ()
const string &	get_img_color_type () const
string *	mutable_imgColorType ()
void	set_img_color_type (const string &value)
void	clear_safe ()
const string &	get_safe () const
string *	mutable_safe ()
void	set_safe (const string &value)
void	clear_site_search_filter ()
const string &	get_site_search_filter () const
string *	mutable_siteSearchFilter ()
void	set_site_search_filter (const string &value)
void	clear_start ()
uint32	get_start () const
void	set_start (uint32 value)
virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
virtual util::Status	AppendOptionalQueryParameters (string *target)
util::Status	ExecuteAndParseResponse (Search *data)
Public Member Functions inherited from google_customsearch_api::CustomsearchServiceBaseRequest
	CustomsearchServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
virtual	~CustomsearchServiceBaseRequest ()
void	clear_xgafv ()
const string &	get_xgafv () const
string *mutable_	$Xgafv ()
void	set_xgafv (const string &value)
void	clear_access_token ()
const string &	get_access_token () const
string *	mutable_accessToken ()
void	set_access_token (const string &value)
void	clear_alt ()
const string &	get_alt () const
string *	mutable_alt ()
void	set_alt (const string &value)
void	clear_callback ()
const string &	get_callback () const
string *	mutable_callback ()
void	set_callback (const string &value)
void	clear_fields ()
const string &	get_fields () const
string *	mutable_fields ()
void	set_fields (const string &value)
void	clear_key ()
const string &	get_key () const
string *	mutable_key ()
void	set_key (const string &value)
void	clear_oauth_token ()
const string &	get_oauth_token () const
string *	mutable_oauthToken ()
void	set_oauth_token (const string &value)
void	clear_pretty_print ()
bool	get_pretty_print () const
void	set_pretty_print (bool value)
void	clear_quota_user ()
const string &	get_quota_user () const
string *	mutable_quotaUser ()
void	set_quota_user (const string &value)
void	clear_upload_type ()
const string &	get_upload_type () const
string *	mutable_uploadType ()
void	set_upload_type (const string &value)
void	clear_upload_protocol ()
const string &	get_upload_protocol () const
string *	mutable_uploadProtocol ()
void	set_upload_protocol (const string &value)

Additional Inherited Members
Protected Member Functions inherited from google_customsearch_api::CustomsearchServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the list method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

No authorization scopes are required for this method.

Constructor & Destructor Documentation

CseResource_ListMethod()

google_customsearch_api::CseResource_ListMethod::CseResource_ListMethod	(	const CustomsearchService *	_service_,
		client::AuthorizationCredential *	_credential_
	)

The standard constructor takes all the required method parameters.

Parameters

[in]	<em>service</em>	The service instance to send to when executed.
[in]	<em>credential</em>	If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.

~CseResource_ListMethod()

google_customsearch_api::CseResource_ListMethod::~CseResource_ListMethod ( )

virtual

Standard destructor.

Member Function Documentation

AppendOptionalQueryParameters()

util::Status google_customsearch_api::CseResource_ListMethod::AppendOptionalQueryParameters ( string *  target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out]

target

The URL string to append to.

Reimplemented from google_customsearch_api::CustomsearchServiceBaseRequest.

AppendVariable()

util::Status google_customsearch_api::CseResource_ListMethod::AppendVariable ( const StringPiece &  variable_name, const client::UriTemplateConfig &  config, string *  target  )

virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters

[in]	variable_name	The name of the templated variable.
[in]	config	A pass-through parameter used for lists and maps.
[in,out]	target	The string to append the value to.

Reimplemented from google_customsearch_api::CustomsearchServiceBaseRequest.

clear_c2coff()

void google_customsearch_api::CseResource_ListMethod::clear_c2coff ( )

inline

Clears the 'c2coff' attribute so it is no longer set.

clear_cr()

void google_customsearch_api::CseResource_ListMethod::clear_cr ( )

inline

Clears the 'cr' attribute so it is no longer set.

clear_cx()

void google_customsearch_api::CseResource_ListMethod::clear_cx ( )

inline

Clears the 'cx' attribute so it is no longer set.

clear_date_restrict()

void google_customsearch_api::CseResource_ListMethod::clear_date_restrict ( )

inline

Clears the 'dateRestrict' attribute so it is no longer set.

clear_exact_terms()

void google_customsearch_api::CseResource_ListMethod::clear_exact_terms ( )

inline

Clears the 'exactTerms' attribute so it is no longer set.

clear_exclude_terms()

void google_customsearch_api::CseResource_ListMethod::clear_exclude_terms ( )

inline

Clears the 'excludeTerms' attribute so it is no longer set.

clear_file_type()

void google_customsearch_api::CseResource_ListMethod::clear_file_type ( )

inline

Clears the 'fileType' attribute so it is no longer set.

clear_filter()

void google_customsearch_api::CseResource_ListMethod::clear_filter ( )

inline

Clears the 'filter' attribute so it is no longer set.

clear_gl()

void google_customsearch_api::CseResource_ListMethod::clear_gl ( )

inline

Clears the 'gl' attribute so it is no longer set.

clear_googlehost()

void google_customsearch_api::CseResource_ListMethod::clear_googlehost ( )

inline

Clears the 'googlehost' attribute so it is no longer set.

clear_high_range()

void google_customsearch_api::CseResource_ListMethod::clear_high_range ( )

inline

Clears the 'highRange' attribute so it is no longer set.

clear_hl()

void google_customsearch_api::CseResource_ListMethod::clear_hl ( )

inline

Clears the 'hl' attribute so it is no longer set.

clear_hq()

void google_customsearch_api::CseResource_ListMethod::clear_hq ( )

inline

Clears the 'hq' attribute so it is no longer set.

clear_img_color_type()

void google_customsearch_api::CseResource_ListMethod::clear_img_color_type ( )

inline

Clears the 'imgColorType' attribute so it is no longer set.

clear_img_dominant_color()

void google_customsearch_api::CseResource_ListMethod::clear_img_dominant_color ( )

inline

Clears the 'imgDominantColor' attribute so it is no longer set.

clear_img_size()

void google_customsearch_api::CseResource_ListMethod::clear_img_size ( )

inline

Clears the 'imgSize' attribute so it is no longer set.

clear_img_type()

void google_customsearch_api::CseResource_ListMethod::clear_img_type ( )

inline

Clears the 'imgType' attribute so it is no longer set.

clear_link_site()

void google_customsearch_api::CseResource_ListMethod::clear_link_site ( )

inline

Clears the 'linkSite' attribute so it is no longer set.

clear_low_range()

void google_customsearch_api::CseResource_ListMethod::clear_low_range ( )

inline

Clears the 'lowRange' attribute so it is no longer set.

clear_lr()

void google_customsearch_api::CseResource_ListMethod::clear_lr ( )

inline

Clears the 'lr' attribute so it is no longer set.

clear_num()

void google_customsearch_api::CseResource_ListMethod::clear_num ( )

inline

Clears the 'num' attribute so it is no longer set.

clear_or_terms()

void google_customsearch_api::CseResource_ListMethod::clear_or_terms ( )

inline

Clears the 'orTerms' attribute so it is no longer set.

clear_q()

void google_customsearch_api::CseResource_ListMethod::clear_q ( )

inline

Clears the 'q' attribute so it is no longer set.

clear_related_site()

void google_customsearch_api::CseResource_ListMethod::clear_related_site ( )

inline

Clears the 'relatedSite' attribute so it is no longer set.

clear_rights()

void google_customsearch_api::CseResource_ListMethod::clear_rights ( )

inline

Clears the 'rights' attribute so it is no longer set.

clear_safe()

void google_customsearch_api::CseResource_ListMethod::clear_safe ( )

inline

Clears the 'safe' attribute so it is no longer set.

clear_search_type()

void google_customsearch_api::CseResource_ListMethod::clear_search_type ( )

inline

Clears the 'searchType' attribute so it is no longer set.

clear_site_search()

void google_customsearch_api::CseResource_ListMethod::clear_site_search ( )

inline

Clears the 'siteSearch' attribute so it is no longer set.

clear_site_search_filter()

void google_customsearch_api::CseResource_ListMethod::clear_site_search_filter ( )

inline

Clears the 'siteSearchFilter' attribute so it is no longer set.

clear_sort()

void google_customsearch_api::CseResource_ListMethod::clear_sort ( )

inline

Clears the 'sort' attribute so it is no longer set.

clear_start()

void google_customsearch_api::CseResource_ListMethod::clear_start ( )

inline

Clears the 'start' attribute so it is no longer set.

ExecuteAndParseResponse()

util::Status google_customsearch_api::CseResource_ListMethod::ExecuteAndParseResponse ( Search *  data )

inline

Executes the method and parses the response into a data object on success.

Parameters

[out]

data

Loads from the response payload JSON data on success.

Returns

Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

get_c2coff()

const string& google_customsearch_api::CseResource_ListMethod::get_c2coff ( ) const

inline

Gets the optional 'c2coff' attribute.

If the value is not set then the default value will be returned.

get_cr()

const string& google_customsearch_api::CseResource_ListMethod::get_cr ( ) const

inline

Gets the optional 'cr' attribute.

If the value is not set then the default value will be returned.

get_cx()

const string& google_customsearch_api::CseResource_ListMethod::get_cx ( ) const

inline

Gets the optional 'cx' attribute.

If the value is not set then the default value will be returned.

get_date_restrict()

const string& google_customsearch_api::CseResource_ListMethod::get_date_restrict ( ) const

inline

Gets the optional 'dateRestrict' attribute.

If the value is not set then the default value will be returned.

get_exact_terms()

const string& google_customsearch_api::CseResource_ListMethod::get_exact_terms ( ) const

inline

Gets the optional 'exactTerms' attribute.

If the value is not set then the default value will be returned.

get_exclude_terms()

const string& google_customsearch_api::CseResource_ListMethod::get_exclude_terms ( ) const

inline

Gets the optional 'excludeTerms' attribute.

If the value is not set then the default value will be returned.

get_file_type()

const string& google_customsearch_api::CseResource_ListMethod::get_file_type ( ) const

inline

Gets the optional 'fileType' attribute.

If the value is not set then the default value will be returned.

get_filter()

const string& google_customsearch_api::CseResource_ListMethod::get_filter ( ) const

inline

Gets the optional 'filter' attribute.

If the value is not set then the default value will be returned.

get_gl()

const string& google_customsearch_api::CseResource_ListMethod::get_gl ( ) const

inline

Gets the optional 'gl' attribute.

If the value is not set then the default value will be returned.

get_googlehost()

const string& google_customsearch_api::CseResource_ListMethod::get_googlehost ( ) const

inline

Gets the optional 'googlehost' attribute.

If the value is not set then the default value will be returned.

get_high_range()

const string& google_customsearch_api::CseResource_ListMethod::get_high_range ( ) const

inline

Gets the optional 'highRange' attribute.

If the value is not set then the default value will be returned.

get_hl()

const string& google_customsearch_api::CseResource_ListMethod::get_hl ( ) const

inline

Gets the optional 'hl' attribute.

If the value is not set then the default value will be returned.

get_hq()

const string& google_customsearch_api::CseResource_ListMethod::get_hq ( ) const

inline

Gets the optional 'hq' attribute.

If the value is not set then the default value will be returned.

get_img_color_type()

const string& google_customsearch_api::CseResource_ListMethod::get_img_color_type ( ) const

inline

Gets the optional 'imgColorType' attribute.

If the value is not set then the default value will be returned.

get_img_dominant_color()

const string& google_customsearch_api::CseResource_ListMethod::get_img_dominant_color ( ) const

inline

Gets the optional 'imgDominantColor' attribute.

If the value is not set then the default value will be returned.

get_img_size()

const string& google_customsearch_api::CseResource_ListMethod::get_img_size ( ) const

inline

Gets the optional 'imgSize' attribute.

If the value is not set then the default value will be returned.

get_img_type()

const string& google_customsearch_api::CseResource_ListMethod::get_img_type ( ) const

inline

Gets the optional 'imgType' attribute.

If the value is not set then the default value will be returned.

get_link_site()

const string& google_customsearch_api::CseResource_ListMethod::get_link_site ( ) const

inline

Gets the optional 'linkSite' attribute.

If the value is not set then the default value will be returned.

get_low_range()

const string& google_customsearch_api::CseResource_ListMethod::get_low_range ( ) const

inline

Gets the optional 'lowRange' attribute.

If the value is not set then the default value will be returned.

get_lr()

const string& google_customsearch_api::CseResource_ListMethod::get_lr ( ) const

inline

Gets the optional 'lr' attribute.

If the value is not set then the default value will be returned.

get_num()

int32 google_customsearch_api::CseResource_ListMethod::get_num ( ) const

inline

Gets the optional 'num' attribute.

If the value is not set then the default value will be returned.

get_or_terms()

const string& google_customsearch_api::CseResource_ListMethod::get_or_terms ( ) const

inline

Gets the optional 'orTerms' attribute.

If the value is not set then the default value will be returned.

get_q()

const string& google_customsearch_api::CseResource_ListMethod::get_q ( ) const

inline

Gets the optional 'q' attribute.

If the value is not set then the default value will be returned.

get_related_site()

const string& google_customsearch_api::CseResource_ListMethod::get_related_site ( ) const

inline

Gets the optional 'relatedSite' attribute.

If the value is not set then the default value will be returned.

get_rights()

const string& google_customsearch_api::CseResource_ListMethod::get_rights ( ) const

inline

Gets the optional 'rights' attribute.

If the value is not set then the default value will be returned.

get_safe()

const string& google_customsearch_api::CseResource_ListMethod::get_safe ( ) const

inline

Gets the optional 'safe' attribute.

If the value is not set then the default value will be returned.

get_search_type()

const string& google_customsearch_api::CseResource_ListMethod::get_search_type ( ) const

inline

Gets the optional 'searchType' attribute.

If the value is not set then the default value will be returned.

get_site_search()

const string& google_customsearch_api::CseResource_ListMethod::get_site_search ( ) const

inline

Gets the optional 'siteSearch' attribute.

If the value is not set then the default value will be returned.

get_site_search_filter()

const string& google_customsearch_api::CseResource_ListMethod::get_site_search_filter ( ) const

inline

Gets the optional 'siteSearchFilter' attribute.

If the value is not set then the default value will be returned.

get_sort()

const string& google_customsearch_api::CseResource_ListMethod::get_sort ( ) const

inline

Gets the optional 'sort' attribute.

If the value is not set then the default value will be returned.

get_start()

uint32 google_customsearch_api::CseResource_ListMethod::get_start ( ) const

inline

Gets the optional 'start' attribute.

If the value is not set then the default value will be returned.

mutable_c2coff()

string* google_customsearch_api::CseResource_ListMethod::mutable_c2coff ( )

inline

Gets a modifiable pointer to the optional c2coff' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_cr()

string* google_customsearch_api::CseResource_ListMethod::mutable_cr ( )

inline

Gets a modifiable pointer to the optional cr' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_cx()

string* google_customsearch_api::CseResource_ListMethod::mutable_cx ( )

inline

Gets a modifiable pointer to the optional cx' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_dateRestrict()

string* google_customsearch_api::CseResource_ListMethod::mutable_dateRestrict ( )

inline

Gets a modifiable pointer to the optional dateRestrict' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_exactTerms()

string* google_customsearch_api::CseResource_ListMethod::mutable_exactTerms ( )

inline

Gets a modifiable pointer to the optional exactTerms' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_excludeTerms()

string* google_customsearch_api::CseResource_ListMethod::mutable_excludeTerms ( )

inline

Gets a modifiable pointer to the optional excludeTerms' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_fileType()

string* google_customsearch_api::CseResource_ListMethod::mutable_fileType ( )

inline

Gets a modifiable pointer to the optional fileType' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_filter()

string* google_customsearch_api::CseResource_ListMethod::mutable_filter ( )

inline

Gets a modifiable pointer to the optional filter' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_gl()

string* google_customsearch_api::CseResource_ListMethod::mutable_gl ( )

inline

Gets a modifiable pointer to the optional gl' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_googlehost()

string* google_customsearch_api::CseResource_ListMethod::mutable_googlehost ( )

inline

Gets a modifiable pointer to the optional googlehost' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_highRange()

string* google_customsearch_api::CseResource_ListMethod::mutable_highRange ( )

inline

Gets a modifiable pointer to the optional highRange' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_hl()

string* google_customsearch_api::CseResource_ListMethod::mutable_hl ( )

inline

Gets a modifiable pointer to the optional hl' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_hq()

string* google_customsearch_api::CseResource_ListMethod::mutable_hq ( )

inline

Gets a modifiable pointer to the optional hq' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_imgColorType()

string* google_customsearch_api::CseResource_ListMethod::mutable_imgColorType ( )

inline

Gets a modifiable pointer to the optional imgColorType' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_imgDominantColor()

string* google_customsearch_api::CseResource_ListMethod::mutable_imgDominantColor ( )

inline

Gets a modifiable pointer to the optional imgDominantColor' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_imgSize()

string* google_customsearch_api::CseResource_ListMethod::mutable_imgSize ( )

inline

Gets a modifiable pointer to the optional imgSize' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_imgType()

string* google_customsearch_api::CseResource_ListMethod::mutable_imgType ( )

inline

Gets a modifiable pointer to the optional imgType' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_linkSite()

string* google_customsearch_api::CseResource_ListMethod::mutable_linkSite ( )

inline

Gets a modifiable pointer to the optional linkSite' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_lowRange()

string* google_customsearch_api::CseResource_ListMethod::mutable_lowRange ( )

inline

Gets a modifiable pointer to the optional lowRange' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_lr()

string* google_customsearch_api::CseResource_ListMethod::mutable_lr ( )

inline

Gets a modifiable pointer to the optional lr' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_orTerms()

string* google_customsearch_api::CseResource_ListMethod::mutable_orTerms ( )

inline

Gets a modifiable pointer to the optional orTerms' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_q()

string* google_customsearch_api::CseResource_ListMethod::mutable_q ( )

inline

Gets a modifiable pointer to the optional q' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_relatedSite()

string* google_customsearch_api::CseResource_ListMethod::mutable_relatedSite ( )

inline

Gets a modifiable pointer to the optional relatedSite' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_rights()

string* google_customsearch_api::CseResource_ListMethod::mutable_rights ( )

inline

Gets a modifiable pointer to the optional rights' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_safe()

string* google_customsearch_api::CseResource_ListMethod::mutable_safe ( )

inline

Gets a modifiable pointer to the optional safe' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_searchType()

string* google_customsearch_api::CseResource_ListMethod::mutable_searchType ( )

inline

Gets a modifiable pointer to the optional searchType' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_siteSearch()

string* google_customsearch_api::CseResource_ListMethod::mutable_siteSearch ( )

inline

Gets a modifiable pointer to the optional siteSearch' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_siteSearchFilter()

string* google_customsearch_api::CseResource_ListMethod::mutable_siteSearchFilter ( )

inline

Gets a modifiable pointer to the optional siteSearchFilter' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_sort()

string* google_customsearch_api::CseResource_ListMethod::mutable_sort ( )

inline

Gets a modifiable pointer to the optional sort' attribute.

Returns

The value can be set by dereferencing the pointer.

set_c2coff()

void google_customsearch_api::CseResource_ListMethod::set_c2coff ( const string &  value )

inline

Sets the 'c2coff' attribute.

Parameters

[in]

value

Enables or disables Simplified and Traditional Chinese Search.

are

* 1: Disabled.

0

Enabled (default).

set_cr()

void google_customsearch_api::CseResource_ListMethod::set_cr ( const string &  value )

inline

Sets the 'cr' attribute.

Parameters

[in]

value

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.

set_cx()

void google_customsearch_api::CseResource_ListMethod::set_cx ( const string &  value )

inline

Sets the 'cx' attribute.

Parameters

[in]

value

The custom search engine ID to use for this request.

set_date_restrict()

void google_customsearch_api::CseResource_ListMethod::set_date_restrict ( const string &  value )

inline

Sets the 'dateRestrict' attribute.

Parameters

[in]

value

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.

set_exact_terms()

void google_customsearch_api::CseResource_ListMethod::set_exact_terms ( const string &  value )

inline

Sets the 'exactTerms' attribute.

Parameters

[in]

value

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

set_exclude_terms()

void google_customsearch_api::CseResource_ListMethod::set_exclude_terms ( const string &  value )

inline

Sets the 'excludeTerms' attribute.

Parameters

[in]

value

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

set_file_type()

void google_customsearch_api::CseResource_ListMethod::set_file_type ( const string &  value )

inline

Sets the 'fileType' attribute.

Parameters

[in]

value

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

set_filter()

void google_customsearch_api::CseResource_ListMethod::set_filter ( const string &  value )

inline

Sets the 'filter' attribute.

Parameters

[in]

value

Controls turning on or off the duplicate content filter.

• See Automatic Filtering

multi

site searches.

are

* 0: Turns off duplicate content filter.

1

Turns on duplicate content filter.

set_gl()

void google_customsearch_api::CseResource_ListMethod::set_gl ( const string &  value )

inline

Sets the 'gl' attribute.

Parameters

[in]

value

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.

set_googlehost()

void google_customsearch_api::CseResource_ListMethod::set_googlehost ( const string &  value )

inline

Sets the 'googlehost' attribute.

Parameters

[in]

value

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.

set_high_range()

void google_customsearch_api::CseResource_ListMethod::set_high_range ( const string &  value )

inline

Sets the 'highRange' attribute.

Parameters

[in]

value

Specifies the ending value for a search range.

• Use lowRange and highRange to append an inclusive search range of lowRange...highRange to the query.

set_hl()

void google_customsearch_api::CseResource_ListMethod::set_hl ( const string &  value )

inline

Sets the 'hl' attribute.

Parameters

[in]

value

Sets the user interface language.

• 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)[https://developers.google.com/custom- search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages.

set_hq()

void google_customsearch_api::CseResource_ListMethod::set_hq ( const string &  value )

inline

Sets the 'hq' attribute.

Parameters

[in]

value

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

set_img_color_type()

void google_customsearch_api::CseResource_ListMethod::set_img_color_type ( const string &  value )

inline

Sets the 'imgColorType' attribute.

Parameters

[in]

value

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

• "color"
• "gray"
• "mono": black and white
• "trans": transparent background.

set_img_dominant_color()

void google_customsearch_api::CseResource_ListMethod::set_img_dominant_color ( const string &  value )

inline

Sets the 'imgDominantColor' attribute.

Parameters

[in]

value

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

• "black"
• "blue"
• "brown"
• "gray"
• "green"
• "orange"
• "pink"
• "purple"
• "red"
• "teal"
• "white"
• "yellow".

set_img_size()

void google_customsearch_api::CseResource_ListMethod::set_img_size ( const string &  value )

inline

Sets the 'imgSize' attribute.

Parameters

[in]

value

Returns images of a specified size. Acceptable values are:

• "huge"
• "icon"
• "large"
• "medium"
• "small"
• "xlarge"
• "xxlarge".

set_img_type()

void google_customsearch_api::CseResource_ListMethod::set_img_type ( const string &  value )

inline

Sets the 'imgType' attribute.

Parameters

[in]

value

Returns images of a type. Acceptable values are:

• "clipart"
• "face"
• "lineart"
• "stock"
• "photo"
• "animated".

set_link_site()

void google_customsearch_api::CseResource_ListMethod::set_link_site ( const string &  value )

inline

Sets the 'linkSite' attribute.

Parameters

[in]

value

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

set_low_range()

void google_customsearch_api::CseResource_ListMethod::set_low_range ( const string &  value )

inline

Sets the 'lowRange' attribute.

Parameters

[in]

value

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

set_lr()

void google_customsearch_api::CseResource_ListMethod::set_lr ( const string &  value )

inline

Sets the 'lr' attribute.

Parameters

[in]

value

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

set_num()

void google_customsearch_api::CseResource_ListMethod::set_num ( int32  value )

inline

Sets the 'num' attribute.

Parameters

[in]

value

Number of search results to return.

• Valid values are integers between 1 and 10, inclusive.

set_or_terms()

void google_customsearch_api::CseResource_ListMethod::set_or_terms ( const string &  value )

inline

Sets the 'orTerms' attribute.

Parameters

[in]

value

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.

set_q()

void google_customsearch_api::CseResource_ListMethod::set_q ( const string &  value )

inline

Sets the 'q' attribute.

Parameters

[in]

value

Query.

set_related_site()

void google_customsearch_api::CseResource_ListMethod::set_related_site ( const string &  value )

inline

Sets the 'relatedSite' attribute.

Parameters

[in]

value

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

set_rights()

void google_customsearch_api::CseResource_ListMethod::set_rights ( const string &  value )

inline

Sets the 'rights' attribute.

Parameters

[in]

value

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

set_safe()

void google_customsearch_api::CseResource_ListMethod::set_safe ( const string &  value )

inline

Sets the 'safe' attribute.

Parameters

[in]

value

Search safety level. Acceptable values are:

• "active": Enables SafeSearch filtering.
• "off": Disables SafeSearch filtering. (default).

set_search_type()

void google_customsearch_api::CseResource_ListMethod::set_search_type ( const string &  value )

inline

Sets the 'searchType' attribute.

Parameters

[in]

value

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

Acceptable values are:

• "image": custom image search.

set_site_search()

void google_customsearch_api::CseResource_ListMethod::set_site_search ( const string &  value )

inline

Sets the 'siteSearch' attribute.

Parameters

[in]

value

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

set_site_search_filter()

void google_customsearch_api::CseResource_ListMethod::set_site_search_filter ( const string &  value )

inline

Sets the 'siteSearchFilter' attribute.

Parameters

[in]

value

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

Acceptable values are:

• "e": exclude
• "i": include.

set_sort()

void google_customsearch_api::CseResource_ListMethod::set_sort ( const string &  value )

inline

Sets the 'sort' attribute.

Parameters

[in]

value

The sort expression to apply to the results.

set_start()

void google_customsearch_api::CseResource_ListMethod::set_start ( uint32  value )

inline

Sets the 'start' attribute.

Parameters

[in]

value

The index of the first result to return. The default number of results per page is 10, so =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.

---

The documentation for this class was generated from the following files:

• google/customsearch_api/customsearch_service.h
• google/customsearch_api/customsearch_service.cc