#include <analytics_service.h>

Inheritance diagram for google_analytics_api::DataResource_McfResource_GetMethod:

Public Member Functions
	DataResource_McfResource_GetMethod (const AnalyticsService _service_, client::AuthorizationCredential _credential_, const absl::string_view &ids, const absl::string_view &start_date, const absl::string_view &end_date, const absl::string_view &metrics)

virtual	~DataResource_McfResource_GetMethod ()

void	clear_dimensions ()

const string &	get_dimensions () const

string *	mutable_dimensions ()

void	set_dimensions (const string &value)

void	clear_filters ()

const string &	get_filters () const

string *	mutable_filters ()

void	set_filters (const string &value)

void	clear_max_results ()

int32	get_max_results () const

void	set_max_results (int32 value)

void	clear_sampling_level ()

const string &	get_sampling_level () const

string *	mutable_samplingLevel ()

void	set_sampling_level (const string &value)

void	clear_sort ()

const string &	get_sort () const

string *	mutable_sort ()

void	set_sort (const string &value)

void	clear_start_index ()

int32	get_start_index () const

void	set_start_index (int32 value)

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

virtual util::Status	AppendOptionalQueryParameters (string *target)

util::Status	ExecuteAndParseResponse (McfData *data)

Public Member Functions inherited from google_analytics_api::AnalyticsServiceBaseRequest
	AnalyticsServiceBaseRequest (const client::ClientService service, client::AuthorizationCredential credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)

virtual	~AnalyticsServiceBaseRequest ()

void	clear_alt ()

const string &	get_alt () const

string *	mutable_alt ()

void	set_alt (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_user_ip ()

const string &	get_user_ip () const

string *	mutable_userIp ()

void	set_user_ip (const string &value)

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

Detailed Description

Implements the get 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.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/analytics https://www.googleapis.com/auth/analytics.readonly

Constructor & Destructor Documentation

◆ DataResource_McfResource_GetMethod()

google_analytics_api::DataResource_McfResource_GetMethod::DataResource_McfResource_GetMethod	(	const AnalyticsService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	ids,
		const absl::string_view &	start_date,
		const absl::string_view &	end_date,
		const absl::string_view &	metrics
	)

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.
[in]	ids	Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
[in]	start_date	Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
[in]	end_date	End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
[in]	metrics	A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.

◆ ~DataResource_McfResource_GetMethod()

google_analytics_api::DataResource_McfResource_GetMethod::~DataResource_McfResource_GetMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_analytics_api::DataResource_McfResource_GetMethod::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_analytics_api::AnalyticsServiceBaseRequest.

◆ AppendVariable()

util::Status google_analytics_api::DataResource_McfResource_GetMethod::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_analytics_api::AnalyticsServiceBaseRequest.

◆ clear_dimensions()

void google_analytics_api::DataResource_McfResource_GetMethod::clear_dimensions ( )

inline

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

◆ clear_filters()

void google_analytics_api::DataResource_McfResource_GetMethod::clear_filters ( )

inline

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

◆ clear_max_results()

void google_analytics_api::DataResource_McfResource_GetMethod::clear_max_results ( )

inline

Clears the 'max-results' attribute so it is no longer set.

◆ clear_sampling_level()

void google_analytics_api::DataResource_McfResource_GetMethod::clear_sampling_level ( )

inline

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

◆ clear_sort()

void google_analytics_api::DataResource_McfResource_GetMethod::clear_sort ( )

inline

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

◆ clear_start_index()

void google_analytics_api::DataResource_McfResource_GetMethod::clear_start_index ( )

inline

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

◆ ExecuteAndParseResponse()

util::Status google_analytics_api::DataResource_McfResource_GetMethod::ExecuteAndParseResponse ( McfData * 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.