analytics  v3
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_analytics_api::GaData Class Reference

#include <ga_data.h>

Inheritance diagram for google_analytics_api::GaData:

Classes

class  GaDataColumnHeaders
 
class  GaDataDataTable
 
class  GaDataProfileInfo
 
class  GaDataQuery
 

Public Member Functions

 GaData (const Json::Value &storage)
 
 GaData (Json::Value *storage)
 
virtual ~GaData ()
 
const StringPiece GetTypeName () const
 
bool has_column_headers () const
 
void clear_column_headers ()
 
const client::JsonCppArray< GaDataColumnHeadersget_column_headers () const
 
client::JsonCppArray< GaDataColumnHeadersmutable_columnHeaders ()
 
bool has_contains_sampled_data () const
 
void clear_contains_sampled_data ()
 
bool get_contains_sampled_data () const
 
void set_contains_sampled_data (bool value)
 
bool has_data_last_refreshed () const
 
void clear_data_last_refreshed ()
 
int64 get_data_last_refreshed () const
 
void set_data_last_refreshed (int64 value)
 
bool has_data_table () const
 
void clear_data_table ()
 
const GaDataDataTable get_data_table () const
 
GaDataDataTable mutable_dataTable ()
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
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_profile_info () const
 
void clear_profile_info ()
 
const GaDataProfileInfo get_profile_info () const
 
GaDataProfileInfo mutable_profileInfo ()
 
bool has_query () const
 
void clear_query ()
 
const GaDataQuery get_query () const
 
GaDataQuery mutable_query ()
 
bool has_rows () const
 
void clear_rows ()
 
const client::JsonCppArray< client::JsonCppArray< string > > get_rows () const
 
client::JsonCppArray< client::JsonCppArray< string > > mutable_rows ()
 
bool has_sample_size () const
 
void clear_sample_size ()
 
int64 get_sample_size () const
 
void set_sample_size (int64 value)
 
bool has_sample_space () const
 
void clear_sample_space ()
 
int64 get_sample_space () const
 
void set_sample_space (int64 value)
 
bool has_self_link () const
 
void clear_self_link ()
 
const StringPiece get_self_link () const
 
void set_self_link (const StringPiece &value)
 
bool has_total_results () const
 
void clear_total_results ()
 
int32 get_total_results () const
 
void set_total_results (int32 value)
 
bool has_totals_for_all_results () const
 
void clear_totals_for_all_results ()
 
const client::JsonCppAssociativeArray< string > get_totals_for_all_results () const
 
client::JsonCppAssociativeArray< string > mutable_totalsForAllResults ()
 

Static Public Member Functions

static GaDataNew ()
 

Detailed Description

Analytics data for a given view (profile).

Constructor & Destructor Documentation

◆ GaData() [1/2]

google_analytics_api::GaData::GaData ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ GaData() [2/2]

google_analytics_api::GaData::GaData ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~GaData()

google_analytics_api::GaData::~GaData ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_column_headers()

void google_analytics_api::GaData::clear_column_headers ( )
inline

Clears the 'columnHeaders' attribute.

◆ clear_contains_sampled_data()

void google_analytics_api::GaData::clear_contains_sampled_data ( )
inline

Clears the 'containsSampledData' attribute.

◆ clear_data_last_refreshed()

void google_analytics_api::GaData::clear_data_last_refreshed ( )
inline

Clears the 'dataLastRefreshed' attribute.

◆ clear_data_table()

void google_analytics_api::GaData::clear_data_table ( )
inline

Clears the 'dataTable' attribute.

◆ clear_id()

void google_analytics_api::GaData::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_items_per_page()

void google_analytics_api::GaData::clear_items_per_page ( )
inline

Clears the 'itemsPerPage' attribute.

◆ clear_kind()

void google_analytics_api::GaData::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_next_link()

void google_analytics_api::GaData::clear_next_link ( )
inline

Clears the 'nextLink' attribute.

◆ clear_previous_link()

void google_analytics_api::GaData::clear_previous_link ( )
inline

Clears the 'previousLink' attribute.

◆ clear_profile_info()

void google_analytics_api::GaData::clear_profile_info ( )
inline

Clears the 'profileInfo' attribute.

◆ clear_query()

void google_analytics_api::GaData::clear_query ( )
inline

Clears the 'query' attribute.

◆ clear_rows()

void google_analytics_api::GaData::clear_rows ( )
inline

Clears the 'rows' attribute.

◆ clear_sample_size()

void google_analytics_api::GaData::clear_sample_size ( )
inline

Clears the 'sampleSize' attribute.

◆ clear_sample_space()

void google_analytics_api::GaData::clear_sample_space ( )
inline

Clears the 'sampleSpace' attribute.

◆ clear_self_link()

void google_analytics_api::GaData::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_total_results()

void google_analytics_api::GaData::clear_total_results ( )
inline

Clears the 'totalResults' attribute.

◆ clear_totals_for_all_results()

void google_analytics_api::GaData::clear_totals_for_all_results ( )
inline

Clears the 'totalsForAllResults' attribute.

◆ get_column_headers()

const client::JsonCppArray<GaDataColumnHeaders > google_analytics_api::GaData::get_column_headers ( ) const
inline

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

◆ get_contains_sampled_data()

bool google_analytics_api::GaData::get_contains_sampled_data ( ) const
inline

Get the value of the 'containsSampledData' attribute.

◆ get_data_last_refreshed()

int64 google_analytics_api::GaData::get_data_last_refreshed ( ) const
inline

Get the value of the 'dataLastRefreshed' attribute.

◆ get_data_table()

const GaDataDataTable google_analytics_api::GaData::get_data_table ( ) const
inline

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

◆ get_id()

const StringPiece google_analytics_api::GaData::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_items_per_page()

int32 google_analytics_api::GaData::get_items_per_page ( ) const
inline

Get the value of the 'itemsPerPage' attribute.

◆ get_kind()

const StringPiece google_analytics_api::GaData::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_next_link()

const StringPiece google_analytics_api::GaData::get_next_link ( ) const
inline

Get the value of the 'nextLink' attribute.

◆ get_previous_link()

const StringPiece google_analytics_api::GaData::get_previous_link ( ) const
inline

Get the value of the 'previousLink' attribute.

◆ get_profile_info()

const GaDataProfileInfo google_analytics_api::GaData::get_profile_info ( ) const
inline

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

◆ get_query()

const GaDataQuery google_analytics_api::GaData::get_query ( ) const
inline

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

◆ get_rows()

const client::JsonCppArray<client::JsonCppArray<string > > google_analytics_api::GaData::get_rows ( ) const
inline

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

◆ get_sample_size()

int64 google_analytics_api::GaData::get_sample_size ( ) const
inline

Get the value of the 'sampleSize' attribute.

◆ get_sample_space()

int64 google_analytics_api::GaData::get_sample_space ( ) const
inline

Get the value of the 'sampleSpace' attribute.

◆ get_self_link()

const StringPiece google_analytics_api::GaData::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_total_results()

int32 google_analytics_api::GaData::get_total_results ( ) const
inline

Get the value of the 'totalResults' attribute.

◆ get_totals_for_all_results()

const client::JsonCppAssociativeArray<string > google_analytics_api::GaData::get_totals_for_all_results ( ) const
inline

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

◆ GetTypeName()

const StringPiece google_analytics_api::GaData::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_analytics_api::GaData

◆ has_column_headers()

bool google_analytics_api::GaData::has_column_headers ( ) const
inline

Determine if the 'columnHeaders' attribute was set.

Returns
true if the 'columnHeaders' attribute was set.

◆ has_contains_sampled_data()

bool google_analytics_api::GaData::has_contains_sampled_data ( ) const
inline

Determine if the 'containsSampledData' attribute was set.

Returns
true if the 'containsSampledData' attribute was set.

◆ has_data_last_refreshed()

bool google_analytics_api::GaData::has_data_last_refreshed ( ) const
inline

Determine if the 'dataLastRefreshed' attribute was set.

Returns
true if the 'dataLastRefreshed' attribute was set.

◆ has_data_table()

bool google_analytics_api::GaData::has_data_table ( ) const
inline

Determine if the 'dataTable' attribute was set.

Returns
true if the 'dataTable' attribute was set.

◆ has_id()

bool google_analytics_api::GaData::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_items_per_page()

bool google_analytics_api::GaData::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::GaData::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::GaData::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::GaData::has_previous_link ( ) const
inline

Determine if the 'previousLink' attribute was set.

Returns
true if the 'previousLink' attribute was set.

◆ has_profile_info()

bool google_analytics_api::GaData::has_profile_info ( ) const
inline

Determine if the 'profileInfo' attribute was set.

Returns
true if the 'profileInfo' attribute was set.

◆ has_query()

bool google_analytics_api::GaData::has_query ( ) const
inline

Determine if the 'query' attribute was set.

Returns
true if the 'query' attribute was set.

◆ has_rows()

bool google_analytics_api::GaData::has_rows ( ) const
inline

Determine if the 'rows' attribute was set.

Returns
true if the 'rows' attribute was set.

◆ has_sample_size()

bool google_analytics_api::GaData::has_sample_size ( ) const
inline

Determine if the 'sampleSize' attribute was set.

Returns
true if the 'sampleSize' attribute was set.

◆ has_sample_space()

bool google_analytics_api::GaData::has_sample_space ( ) const
inline

Determine if the 'sampleSpace' attribute was set.

Returns
true if the 'sampleSpace' attribute was set.

◆ has_self_link()

bool google_analytics_api::GaData::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_total_results()

bool google_analytics_api::GaData::has_total_results ( ) const
inline

Determine if the 'totalResults' attribute was set.

Returns
true if the 'totalResults' attribute was set.

◆ has_totals_for_all_results()

bool google_analytics_api::GaData::has_totals_for_all_results ( ) const
inline

Determine if the 'totalsForAllResults' attribute was set.

Returns
true if the 'totalsForAllResults' attribute was set.

◆ mutable_columnHeaders()

client::JsonCppArray<GaDataColumnHeaders > google_analytics_api::GaData::mutable_columnHeaders ( )
inline

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

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

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

◆ mutable_dataTable()

GaDataDataTable google_analytics_api::GaData::mutable_dataTable ( )
inline

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

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

◆ mutable_profileInfo()

GaDataProfileInfo google_analytics_api::GaData::mutable_profileInfo ( )
inline

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

Information for the view (profile), for which the Analytics data was requested.

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

◆ mutable_query()

GaDataQuery google_analytics_api::GaData::mutable_query ( )
inline

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

Analytics data request query parameters.

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

◆ mutable_rows()

client::JsonCppArray<client::JsonCppArray<string > > google_analytics_api::GaData::mutable_rows ( )
inline

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

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

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

◆ mutable_totalsForAllResults()

client::JsonCppAssociativeArray<string > google_analytics_api::GaData::mutable_totalsForAllResults ( )
inline

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

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

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

◆ New()

GaData * google_analytics_api::GaData::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_contains_sampled_data()

void google_analytics_api::GaData::set_contains_sampled_data ( bool  value)
inline

Change the 'containsSampledData' attribute.

Determines if Analytics data contains samples.

Parameters
[in]valueThe new value.

◆ set_data_last_refreshed()

void google_analytics_api::GaData::set_data_last_refreshed ( int64  value)
inline

Change the 'dataLastRefreshed' attribute.

The last refreshed time in seconds for Analytics data.

Parameters
[in]valueThe new value.

◆ set_id()

void google_analytics_api::GaData::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

Unique ID for this data response.

Parameters
[in]valueThe new value.

◆ set_items_per_page()

void google_analytics_api::GaData::set_items_per_page ( int32  value)
inline

Change the 'itemsPerPage' attribute.

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

Parameters
[in]valueThe new value.

◆ set_kind()

void google_analytics_api::GaData::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Resource type.

Parameters
[in]valueThe new value.

◆ set_next_link()

void google_analytics_api::GaData::set_next_link ( const StringPiece &  value)
inline

Change the 'nextLink' attribute.

Link to next page for this Analytics data query.

Parameters
[in]valueThe new value.

◆ set_previous_link()

void google_analytics_api::GaData::set_previous_link ( const StringPiece &  value)
inline

Change the 'previousLink' attribute.

Link to previous page for this Analytics data query.

Parameters
[in]valueThe new value.

◆ set_sample_size()

void google_analytics_api::GaData::set_sample_size ( int64  value)
inline

Change the 'sampleSize' attribute.

The number of samples used to calculate the result.

Parameters
[in]valueThe new value.

◆ set_sample_space()

void google_analytics_api::GaData::set_sample_space ( int64  value)
inline

Change the 'sampleSpace' attribute.

Total size of the sample space from which the samples were selected.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_analytics_api::GaData::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

Link to this page.

Parameters
[in]valueThe new value.

◆ set_total_results()

void google_analytics_api::GaData::set_total_results ( int32  value)
inline

Change the 'totalResults' attribute.

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

Parameters
[in]valueThe new value.

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