#include <analytics_service.h>

Inheritance diagram for google_analytics_api::DataResource_RealtimeResource_GetMethod:

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

virtual	~DataResource_RealtimeResource_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_sort ()

const string &	get_sort () const

string *	mutable_sort ()

void	set_sort (const string &value)

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

virtual util::Status	AppendOptionalQueryParameters (string *target)

util::Status	ExecuteAndParseResponse (RealtimeData *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_RealtimeResource_GetMethod()

google_analytics_api::DataResource_RealtimeResource_GetMethod::DataResource_RealtimeResource_GetMethod	(	const AnalyticsService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	ids,
		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 real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
[in]	metrics	A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.

◆ ~DataResource_RealtimeResource_GetMethod()

google_analytics_api::DataResource_RealtimeResource_GetMethod::~DataResource_RealtimeResource_GetMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_analytics_api::DataResource_RealtimeResource_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_RealtimeResource_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_RealtimeResource_GetMethod::clear_dimensions ( )

inline

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

◆ clear_filters()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::clear_filters ( )

inline

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

◆ clear_max_results()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::clear_max_results ( )

inline

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

◆ clear_sort()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::clear_sort ( )

inline

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

◆ ExecuteAndParseResponse()

util::Status google_analytics_api::DataResource_RealtimeResource_GetMethod::ExecuteAndParseResponse ( RealtimeData * 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_dimensions()

const string& google_analytics_api::DataResource_RealtimeResource_GetMethod::get_dimensions ( ) const

inline

Gets the optional 'dimensions' attribute.

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

◆ get_filters()

const string& google_analytics_api::DataResource_RealtimeResource_GetMethod::get_filters ( ) const

inline

Gets the optional 'filters' attribute.

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

◆ get_max_results()

int32 google_analytics_api::DataResource_RealtimeResource_GetMethod::get_max_results ( ) const

inline

Gets the optional 'max-results' attribute.

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

◆ get_sort()

const string& google_analytics_api::DataResource_RealtimeResource_GetMethod::get_sort ( ) const

inline

Gets the optional 'sort' attribute.

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

◆ mutable_dimensions()

string* google_analytics_api::DataResource_RealtimeResource_GetMethod::mutable_dimensions ( )

inline

Gets a modifiable pointer to the optional dimensions' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_filters()

string* google_analytics_api::DataResource_RealtimeResource_GetMethod::mutable_filters ( )

inline

Gets a modifiable pointer to the optional filters' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_sort()

string* google_analytics_api::DataResource_RealtimeResource_GetMethod::mutable_sort ( )

inline

Gets a modifiable pointer to the optional sort' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ set_dimensions()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::set_dimensions ( const string & value )

inline

Sets the 'dimensions' attribute.

Parameters

[in] value A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.

◆ set_filters()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::set_filters ( const string & value )

inline

Sets the 'filters' attribute.

Parameters

[in] value A comma-separated list of dimension or metric filters to be applied to real time data.

◆ set_max_results()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::set_max_results ( int32 value )

inline

Sets the 'max-results' attribute.

Parameters

[in] value The maximum number of entries to include in this feed.

◆ set_sort()

void google_analytics_api::DataResource_RealtimeResource_GetMethod::set_sort ( const string & value )

inline

Sets the 'sort' attribute.

Parameters

[in] value A comma-separated list of dimensions or metrics that determine the sort order for real time data.

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

google/analytics_api/analytics_service.h
google/analytics_api/analytics_service.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataResource_RealtimeResource_GetMethod()

◆ ~DataResource_RealtimeResource_GetMethod()

Member Function Documentation

◆ AppendOptionalQueryParameters()

◆ AppendVariable()

◆ clear_dimensions()

◆ clear_filters()

◆ clear_max_results()

◆ clear_sort()

◆ ExecuteAndParseResponse()

◆ get_dimensions()

◆ get_filters()

◆ get_max_results()

◆ get_sort()

◆ mutable_dimensions()

◆ mutable_filters()

◆ mutable_sort()

◆ set_dimensions()

◆ set_filters()

◆ set_max_results()

◆ set_sort()