#include <custom_metrics.h>

Inheritance diagram for google_analytics_api::CustomMetrics:

Public Member Functions
	CustomMetrics (const Json::Value &storage)

	CustomMetrics (Json::Value *storage)

virtual	~CustomMetrics ()

const StringPiece	GetTypeName () const

bool	has_items () const

void	clear_items ()

const client::JsonCppArray< CustomMetric >	get_items () const

client::JsonCppArray< CustomMetric >	mutable_items ()

bool	has_items_per_page () const

void	clear_items_per_page ()

int32	get_items_per_page () const

void	set_items_per_page (int32 value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_next_link () const

void	clear_next_link ()

const StringPiece	get_next_link () const

void	set_next_link (const StringPiece &value)

bool	has_previous_link () const

void	clear_previous_link ()

const StringPiece	get_previous_link () const

void	set_previous_link (const StringPiece &value)

bool	has_start_index () const

void	clear_start_index ()

int32	get_start_index () const

void	set_start_index (int32 value)

bool	has_total_results () const

void	clear_total_results ()

int32	get_total_results () const

void	set_total_results (int32 value)

bool	has_username () const

void	clear_username ()

const StringPiece	get_username () const

void	set_username (const StringPiece &value)

Static Public Member Functions
static CustomMetrics *	New ()

Detailed Description

A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.

Constructor & Destructor Documentation

◆ CustomMetrics() [1/2]

google_analytics_api::CustomMetrics::CustomMetrics ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ CustomMetrics() [2/2]

google_analytics_api::CustomMetrics::CustomMetrics ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~CustomMetrics()

google_analytics_api::CustomMetrics::~CustomMetrics ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_items()

void google_analytics_api::CustomMetrics::clear_items ( )

inline

Clears the 'items' attribute.

◆ clear_items_per_page()

void google_analytics_api::CustomMetrics::clear_items_per_page ( )

inline

Clears the 'itemsPerPage' attribute.

◆ clear_kind()

void google_analytics_api::CustomMetrics::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_next_link()

void google_analytics_api::CustomMetrics::clear_next_link ( )

inline

Clears the 'nextLink' attribute.

◆ clear_previous_link()

void google_analytics_api::CustomMetrics::clear_previous_link ( )

inline

Clears the 'previousLink' attribute.

◆ clear_start_index()

void google_analytics_api::CustomMetrics::clear_start_index ( )

inline

Clears the 'startIndex' attribute.

◆ clear_total_results()

void google_analytics_api::CustomMetrics::clear_total_results ( )

inline

Clears the 'totalResults' attribute.

◆ clear_username()

void google_analytics_api::CustomMetrics::clear_username ( )

inline

Clears the 'username' attribute.

◆ get_items()

const client::JsonCppArray<CustomMetric > google_analytics_api::CustomMetrics::get_items ( ) const

Get a reference to the value of the 'items' attribute.

◆ get_items_per_page()

int32 google_analytics_api::CustomMetrics::get_items_per_page ( ) const

inline

Get the value of the 'itemsPerPage' attribute.

◆ get_kind()

const StringPiece google_analytics_api::CustomMetrics::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_next_link()

const StringPiece google_analytics_api::CustomMetrics::get_next_link ( ) const

inline

Get the value of the 'nextLink' attribute.

◆ get_previous_link()

const StringPiece google_analytics_api::CustomMetrics::get_previous_link ( ) const

inline

Get the value of the 'previousLink' attribute.

◆ get_start_index()

int32 google_analytics_api::CustomMetrics::get_start_index ( ) const

inline

Get the value of the 'startIndex' attribute.

◆ get_total_results()

int32 google_analytics_api::CustomMetrics::get_total_results ( ) const

inline

Get the value of the 'totalResults' attribute.

◆ get_username()

const StringPiece google_analytics_api::CustomMetrics::get_username ( ) const

inline

Get the value of the 'username' attribute.

◆ GetTypeName()

const StringPiece google_analytics_api::CustomMetrics::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_analytics_api::CustomMetrics

◆ has_items()

bool google_analytics_api::CustomMetrics::has_items ( ) const

inline

Determine if the 'items' attribute was set.

Returns: true if the 'items' attribute was set.

◆ has_items_per_page()

bool google_analytics_api::CustomMetrics::has_items_per_page ( ) const

inline

Determine if the 'itemsPerPage' attribute was set.

Returns: true if the 'itemsPerPage' attribute was set.

◆ has_kind()

bool google_analytics_api::CustomMetrics::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_next_link()

bool google_analytics_api::CustomMetrics::has_next_link ( ) const

inline

Determine if the 'nextLink' attribute was set.

Returns: true if the 'nextLink' attribute was set.

◆ has_previous_link()

bool google_analytics_api::CustomMetrics::has_previous_link ( ) const

inline

Determine if the 'previousLink' attribute was set.

Returns: true if the 'previousLink' attribute was set.

◆ has_start_index()

bool google_analytics_api::CustomMetrics::has_start_index ( ) const

inline

Determine if the 'startIndex' attribute was set.

Returns: true if the 'startIndex' attribute was set.

◆ has_total_results()

bool google_analytics_api::CustomMetrics::has_total_results ( ) const

inline

Determine if the 'totalResults' attribute was set.

Returns: true if the 'totalResults' attribute was set.

◆ has_username()

bool google_analytics_api::CustomMetrics::has_username ( ) const

inline

Determine if the 'username' attribute was set.

Returns: true if the 'username' attribute was set.

◆ mutable_items()

client::JsonCppArray<CustomMetric > google_analytics_api::CustomMetrics::mutable_items ( )

Gets a reference to a mutable value of the 'items' property.

Collection of custom metrics.

Returns: The result can be modified to change the attribute value.

◆ New()

CustomMetrics * google_analytics_api::CustomMetrics::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_items_per_page()

void google_analytics_api::CustomMetrics::set_items_per_page ( int32 value )

inline

Change the 'itemsPerPage' attribute.

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Parameters

[in] value The new value.

◆ set_kind()

void google_analytics_api::CustomMetrics::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Collection type.

Parameters

[in] value The new value.

◆ set_next_link()

void google_analytics_api::CustomMetrics::set_next_link ( const StringPiece & value )

inline

Change the 'nextLink' attribute.

Link to next page for this custom metric collection.

Parameters

[in] value The new value.

◆ set_previous_link()

void google_analytics_api::CustomMetrics::set_previous_link ( const StringPiece & value )

inline

Change the 'previousLink' attribute.

Link to previous page for this custom metric collection.

Parameters

[in] value The new value.

◆ set_start_index()

void google_analytics_api::CustomMetrics::set_start_index ( int32 value )

inline

Change the 'startIndex' attribute.

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

Parameters

[in] value The new value.

◆ set_total_results()

void google_analytics_api::CustomMetrics::set_total_results ( int32 value )

inline

Change the 'totalResults' attribute.

The total number of results for the query, regardless of the number of results in the response.

Parameters

[in] value The new value.

◆ set_username()

void google_analytics_api::CustomMetrics::set_username ( const StringPiece & value )

inline

Change the 'username' attribute.

Email ID of the authenticated user.

Parameters

[in] value The new value.

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

google/analytics_api/custom_metrics.h
google/analytics_api/custom_metrics.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CustomMetrics() [1/2]

◆ CustomMetrics() [2/2]

◆ ~CustomMetrics()

Member Function Documentation

◆ clear_items()

◆ clear_items_per_page()

◆ clear_kind()

◆ clear_next_link()

◆ clear_previous_link()

◆ clear_start_index()

◆ clear_total_results()

◆ clear_username()

◆ get_items()

◆ get_items_per_page()

◆ get_kind()

◆ get_next_link()

◆ get_previous_link()

◆ get_start_index()

◆ get_total_results()

◆ get_username()

◆ GetTypeName()

◆ has_items()

◆ has_items_per_page()

◆ has_kind()

◆ has_next_link()

◆ has_previous_link()

◆ has_start_index()

◆ has_total_results()

◆ has_username()

◆ mutable_items()

◆ New()

◆ set_items_per_page()

◆ set_kind()

◆ set_next_link()

◆ set_previous_link()

◆ set_start_index()

◆ set_total_results()

◆ set_username()