analytics  v3
Public Member Functions | Static Public Member Functions | List of all members
google_analytics_api::McfData::McfDataQuery Class Reference

#include <mcf_data.h>

Inheritance diagram for google_analytics_api::McfData::McfDataQuery:

Public Member Functions

 McfDataQuery (const Json::Value &storage)
 
 McfDataQuery (Json::Value *storage)
 
virtual ~McfDataQuery ()
 
const StringPiece GetTypeName () const
 
bool has_dimensions () const
 
void clear_dimensions ()
 
const StringPiece get_dimensions () const
 
void set_dimensions (const StringPiece &value)
 
bool has_end_date () const
 
void clear_end_date ()
 
const StringPiece get_end_date () const
 
void set_end_date (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_sampling_level () const
 
void clear_sampling_level ()
 
const StringPiece get_sampling_level () const
 
void set_sampling_level (const StringPiece &value)
 
bool has_segment () const
 
void clear_segment ()
 
const StringPiece get_segment () const
 
void set_segment (const StringPiece &value)
 
bool has_sort () const
 
void clear_sort ()
 
const client::JsonCppArray< string > get_sort () const
 
client::JsonCppArray< string > mutable_sort ()
 
bool has_start_date () const
 
void clear_start_date ()
 
const StringPiece get_start_date () const
 
void set_start_date (const StringPiece &value)
 
bool has_start_index () const
 
void clear_start_index ()
 
int32 get_start_index () const
 
void set_start_index (int32 value)
 

Static Public Member Functions

static McfDataQueryNew ()
 

Detailed Description

Analytics data request query parameters.

Constructor & Destructor Documentation

◆ McfDataQuery() [1/2]

google_analytics_api::McfData::McfDataQuery::McfDataQuery ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ McfDataQuery() [2/2]

google_analytics_api::McfData::McfDataQuery::McfDataQuery ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~McfDataQuery()

google_analytics_api::McfData::McfDataQuery::~McfDataQuery ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_dimensions()

void google_analytics_api::McfData::McfDataQuery::clear_dimensions ( )
inline

Clears the 'dimensions' attribute.

◆ clear_end_date()

void google_analytics_api::McfData::McfDataQuery::clear_end_date ( )
inline

Clears the 'end-date' attribute.

◆ clear_filters()

void google_analytics_api::McfData::McfDataQuery::clear_filters ( )
inline

Clears the 'filters' attribute.

◆ clear_ids()

void google_analytics_api::McfData::McfDataQuery::clear_ids ( )
inline

Clears the 'ids' attribute.

◆ clear_max_results()

void google_analytics_api::McfData::McfDataQuery::clear_max_results ( )
inline

Clears the 'max-results' attribute.

◆ clear_metrics()

void google_analytics_api::McfData::McfDataQuery::clear_metrics ( )
inline

Clears the 'metrics' attribute.

◆ clear_sampling_level()

void google_analytics_api::McfData::McfDataQuery::clear_sampling_level ( )
inline

Clears the 'samplingLevel' attribute.

◆ clear_segment()

void google_analytics_api::McfData::McfDataQuery::clear_segment ( )
inline

Clears the 'segment' attribute.

◆ clear_sort()

void google_analytics_api::McfData::McfDataQuery::clear_sort ( )
inline

Clears the 'sort' attribute.

◆ clear_start_date()

void google_analytics_api::McfData::McfDataQuery::clear_start_date ( )
inline

Clears the 'start-date' attribute.

◆ clear_start_index()

void google_analytics_api::McfData::McfDataQuery::clear_start_index ( )
inline

Clears the 'start-index' attribute.

◆ get_dimensions()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_dimensions ( ) const
inline

Get the value of the 'dimensions' attribute.

◆ get_end_date()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_end_date ( ) const
inline

Get the value of the 'end-date' attribute.

◆ get_filters()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_filters ( ) const
inline

Get the value of the 'filters' attribute.

◆ get_ids()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_ids ( ) const
inline

Get the value of the 'ids' attribute.

◆ get_max_results()

int32 google_analytics_api::McfData::McfDataQuery::get_max_results ( ) const
inline

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

◆ get_metrics()

const client::JsonCppArray<string > google_analytics_api::McfData::McfDataQuery::get_metrics ( ) const
inline

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

◆ get_sampling_level()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_sampling_level ( ) const
inline

Get the value of the 'samplingLevel' attribute.

◆ get_segment()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_segment ( ) const
inline

Get the value of the 'segment' attribute.

◆ get_sort()

const client::JsonCppArray<string > google_analytics_api::McfData::McfDataQuery::get_sort ( ) const
inline

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

◆ get_start_date()

const StringPiece google_analytics_api::McfData::McfDataQuery::get_start_date ( ) const
inline

Get the value of the 'start-date' attribute.

◆ get_start_index()

int32 google_analytics_api::McfData::McfDataQuery::get_start_index ( ) const
inline

Get the value of the 'start-index' attribute.

◆ GetTypeName()

const StringPiece google_analytics_api::McfData::McfDataQuery::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_analytics_api::McfDataQuery

◆ has_dimensions()

bool google_analytics_api::McfData::McfDataQuery::has_dimensions ( ) const
inline

Determine if the 'dimensions' attribute was set.

Returns
true if the 'dimensions' attribute was set.

◆ has_end_date()

bool google_analytics_api::McfData::McfDataQuery::has_end_date ( ) const
inline

Determine if the 'end-date' attribute was set.

Returns
true if the 'end-date' attribute was set.

◆ has_filters()

bool google_analytics_api::McfData::McfDataQuery::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::McfData::McfDataQuery::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::McfData::McfDataQuery::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::McfData::McfDataQuery::has_metrics ( ) const
inline

Determine if the 'metrics' attribute was set.

Returns
true if the 'metrics' attribute was set.

◆ has_sampling_level()

bool google_analytics_api::McfData::McfDataQuery::has_sampling_level ( ) const
inline

Determine if the 'samplingLevel' attribute was set.

Returns
true if the 'samplingLevel' attribute was set.

◆ has_segment()

bool google_analytics_api::McfData::McfDataQuery::has_segment ( ) const
inline

Determine if the 'segment' attribute was set.

Returns
true if the 'segment' attribute was set.

◆ has_sort()

bool google_analytics_api::McfData::McfDataQuery::has_sort ( ) const
inline

Determine if the 'sort' attribute was set.

Returns
true if the 'sort' attribute was set.

◆ has_start_date()

bool google_analytics_api::McfData::McfDataQuery::has_start_date ( ) const
inline

Determine if the 'start-date' attribute was set.

Returns
true if the 'start-date' attribute was set.

◆ has_start_index()

bool google_analytics_api::McfData::McfDataQuery::has_start_index ( ) const
inline

Determine if the 'start-index' attribute was set.

Returns
true if the 'start-index' attribute was set.

◆ mutable_metrics()

client::JsonCppArray<string > google_analytics_api::McfData::McfDataQuery::mutable_metrics ( )
inline

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

List of analytics metrics.

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

◆ mutable_sort()

client::JsonCppArray<string > google_analytics_api::McfData::McfDataQuery::mutable_sort ( )
inline

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

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

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

◆ New()

McfData::McfDataQuery * google_analytics_api::McfData::McfDataQuery::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_dimensions()

void google_analytics_api::McfData::McfDataQuery::set_dimensions ( const StringPiece &  value)
inline

Change the 'dimensions' attribute.

List of analytics dimensions.

Parameters
[in]valueThe new value.

◆ set_end_date()

void google_analytics_api::McfData::McfDataQuery::set_end_date ( const StringPiece &  value)
inline

Change the 'end-date' attribute.

End date.

Parameters
[in]valueThe new value.

◆ set_filters()

void google_analytics_api::McfData::McfDataQuery::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::McfData::McfDataQuery::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::McfData::McfDataQuery::set_max_results ( int32  value)
inline

Change the 'max-results' attribute.

Maximum results per page.

Parameters
[in]valueThe new value.

◆ set_sampling_level()

void google_analytics_api::McfData::McfDataQuery::set_sampling_level ( const StringPiece &  value)
inline

Change the 'samplingLevel' attribute.

Desired sampling level.

Parameters
[in]valueThe new value.

◆ set_segment()

void google_analytics_api::McfData::McfDataQuery::set_segment ( const StringPiece &  value)
inline

Change the 'segment' attribute.

Analytics advanced segment.

Parameters
[in]valueThe new value.

◆ set_start_date()

void google_analytics_api::McfData::McfDataQuery::set_start_date ( const StringPiece &  value)
inline

Change the 'start-date' attribute.

Start date.

Parameters
[in]valueThe new value.

◆ set_start_index()

void google_analytics_api::McfData::McfDataQuery::set_start_index ( int32  value)
inline

Change the 'start-index' attribute.

Start index.

Parameters
[in]valueThe new value.

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