analytics  v3
Public Member Functions | Static Public Member Functions | List of all members
google_analytics_api::RealtimeData::RealtimeDataQuery Class Reference

#include <realtime_data.h>

Inheritance diagram for google_analytics_api::RealtimeData::RealtimeDataQuery:

Public Member Functions

 RealtimeDataQuery (const Json::Value &storage)
 
 RealtimeDataQuery (Json::Value *storage)
 
virtual ~RealtimeDataQuery ()
 
const StringPiece GetTypeName () const
 
bool has_dimensions () const
 
void clear_dimensions ()
 
const StringPiece get_dimensions () const
 
void set_dimensions (const StringPiece &value)
 
bool has_filters () const
 
void clear_filters ()
 
const StringPiece get_filters () const
 
void set_filters (const StringPiece &value)
 
bool has_ids () const
 
void clear_ids ()
 
const StringPiece get_ids () const
 
void set_ids (const StringPiece &value)
 
bool has_max_results () const
 
void clear_max_results ()
 
int32 get_max_results () const
 
void set_max_results (int32 value)
 
bool has_metrics () const
 
void clear_metrics ()
 
const client::JsonCppArray< string > get_metrics () const
 
client::JsonCppArray< string > mutable_metrics ()
 
bool has_sort () const
 
void clear_sort ()
 
const client::JsonCppArray< string > get_sort () const
 
client::JsonCppArray< string > mutable_sort ()
 

Static Public Member Functions

static RealtimeDataQueryNew ()
 

Detailed Description

Real time data request query parameters.

Constructor & Destructor Documentation

◆ RealtimeDataQuery() [1/2]

google_analytics_api::RealtimeData::RealtimeDataQuery::RealtimeDataQuery ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ RealtimeDataQuery() [2/2]

google_analytics_api::RealtimeData::RealtimeDataQuery::RealtimeDataQuery ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~RealtimeDataQuery()

google_analytics_api::RealtimeData::RealtimeDataQuery::~RealtimeDataQuery ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_dimensions()

void google_analytics_api::RealtimeData::RealtimeDataQuery::clear_dimensions ( )
inline

Clears the 'dimensions' attribute.

◆ clear_filters()

void google_analytics_api::RealtimeData::RealtimeDataQuery::clear_filters ( )
inline

Clears the 'filters' attribute.

◆ clear_ids()

void google_analytics_api::RealtimeData::RealtimeDataQuery::clear_ids ( )
inline

Clears the 'ids' attribute.

◆ clear_max_results()

void google_analytics_api::RealtimeData::RealtimeDataQuery::clear_max_results ( )
inline

Clears the 'max-results' attribute.

◆ clear_metrics()

void google_analytics_api::RealtimeData::RealtimeDataQuery::clear_metrics ( )
inline

Clears the 'metrics' attribute.

◆ clear_sort()

void google_analytics_api::RealtimeData::RealtimeDataQuery::clear_sort ( )
inline

Clears the 'sort' attribute.

◆ get_dimensions()

const StringPiece google_analytics_api::RealtimeData::RealtimeDataQuery::get_dimensions ( ) const
inline

Get the value of the 'dimensions' attribute.

◆ get_filters()

const StringPiece google_analytics_api::RealtimeData::RealtimeDataQuery::get_filters ( ) const
inline

Get the value of the 'filters' attribute.

◆ get_ids()

const StringPiece google_analytics_api::RealtimeData::RealtimeDataQuery::get_ids ( ) const
inline

Get the value of the 'ids' attribute.

◆ get_max_results()

int32 google_analytics_api::RealtimeData::RealtimeDataQuery::get_max_results ( ) const
inline

Get the value of the 'max-results' attribute.

◆ get_metrics()

const client::JsonCppArray<string > google_analytics_api::RealtimeData::RealtimeDataQuery::get_metrics ( ) const
inline

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

◆ get_sort()

const client::JsonCppArray<string > google_analytics_api::RealtimeData::RealtimeDataQuery::get_sort ( ) const
inline

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

◆ GetTypeName()

const StringPiece google_analytics_api::RealtimeData::RealtimeDataQuery::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_analytics_api::RealtimeDataQuery

◆ has_dimensions()

bool google_analytics_api::RealtimeData::RealtimeDataQuery::has_dimensions ( ) const
inline

Determine if the 'dimensions' attribute was set.

Returns
true if the 'dimensions' attribute was set.

◆ has_filters()

bool google_analytics_api::RealtimeData::RealtimeDataQuery::has_filters ( ) const
inline

Determine if the 'filters' attribute was set.

Returns
true if the 'filters' attribute was set.

◆ has_ids()

bool google_analytics_api::RealtimeData::RealtimeDataQuery::has_ids ( ) const
inline

Determine if the 'ids' attribute was set.

Returns
true if the 'ids' attribute was set.

◆ has_max_results()

bool google_analytics_api::RealtimeData::RealtimeDataQuery::has_max_results ( ) const
inline

Determine if the 'max-results' attribute was set.

Returns
true if the 'max-results' attribute was set.

◆ has_metrics()

bool google_analytics_api::RealtimeData::RealtimeDataQuery::has_metrics ( ) const
inline

Determine if the 'metrics' attribute was set.

Returns
true if the 'metrics' attribute was set.

◆ has_sort()

bool google_analytics_api::RealtimeData::RealtimeDataQuery::has_sort ( ) const
inline

Determine if the 'sort' attribute was set.

Returns
true if the 'sort' attribute was set.

◆ mutable_metrics()

client::JsonCppArray<string > google_analytics_api::RealtimeData::RealtimeDataQuery::mutable_metrics ( )
inline

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

List of real time metrics.

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

◆ mutable_sort()

client::JsonCppArray<string > google_analytics_api::RealtimeData::RealtimeDataQuery::mutable_sort ( )
inline

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

List of dimensions or metrics based on which real time data is sorted.

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

◆ New()

RealtimeData::RealtimeDataQuery * google_analytics_api::RealtimeData::RealtimeDataQuery::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_dimensions()

void google_analytics_api::RealtimeData::RealtimeDataQuery::set_dimensions ( const StringPiece &  value)
inline

Change the 'dimensions' attribute.

List of real time dimensions.

Parameters
[in]valueThe new value.

◆ set_filters()

void google_analytics_api::RealtimeData::RealtimeDataQuery::set_filters ( const StringPiece &  value)
inline

Change the 'filters' attribute.

Comma-separated list of dimension or metric filters.

Parameters
[in]valueThe new value.

◆ set_ids()

void google_analytics_api::RealtimeData::RealtimeDataQuery::set_ids ( const StringPiece &  value)
inline

Change the 'ids' attribute.

Unique table ID.

Parameters
[in]valueThe new value.

◆ set_max_results()

void google_analytics_api::RealtimeData::RealtimeDataQuery::set_max_results ( int32  value)
inline

Change the 'max-results' attribute.

Maximum results per page.

Parameters
[in]valueThe new value.

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