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

#include <accounts.h>

Inheritance diagram for google_analytics_api::Accounts:

Public Member Functions

 Accounts (const Json::Value &storage)
 
 Accounts (Json::Value *storage)
 
virtual ~Accounts ()
 
const StringPiece GetTypeName () const
 
bool has_items () const
 
void clear_items ()
 
const client::JsonCppArray< Accountget_items () const
 
client::JsonCppArray< Accountmutable_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 AccountsNew ()
 

Detailed Description

An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.

Constructor & Destructor Documentation

◆ Accounts() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Accounts() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Accounts()

google_analytics_api::Accounts::~Accounts ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_items()

void google_analytics_api::Accounts::clear_items ( )
inline

Clears the 'items' attribute.

◆ clear_items_per_page()

void google_analytics_api::Accounts::clear_items_per_page ( )
inline

Clears the 'itemsPerPage' attribute.

◆ clear_kind()

void google_analytics_api::Accounts::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_next_link()

void google_analytics_api::Accounts::clear_next_link ( )
inline

Clears the 'nextLink' attribute.

◆ clear_previous_link()

void google_analytics_api::Accounts::clear_previous_link ( )
inline

Clears the 'previousLink' attribute.

◆ clear_start_index()

void google_analytics_api::Accounts::clear_start_index ( )
inline

Clears the 'startIndex' attribute.

◆ clear_total_results()

void google_analytics_api::Accounts::clear_total_results ( )
inline

Clears the 'totalResults' attribute.

◆ clear_username()

void google_analytics_api::Accounts::clear_username ( )
inline

Clears the 'username' attribute.

◆ get_items()

const client::JsonCppArray<Account > google_analytics_api::Accounts::get_items ( ) const

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

◆ get_items_per_page()

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

Get the value of the 'itemsPerPage' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_next_link()

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

Get the value of the 'nextLink' attribute.

◆ get_previous_link()

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

Get the value of the 'previousLink' attribute.

◆ get_start_index()

int32 google_analytics_api::Accounts::get_start_index ( ) const
inline

Get the value of the 'startIndex' attribute.

◆ get_total_results()

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

Get the value of the 'totalResults' attribute.

◆ get_username()

const StringPiece google_analytics_api::Accounts::get_username ( ) const
inline

Get the value of the 'username' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_analytics_api::Accounts

◆ has_items()

bool google_analytics_api::Accounts::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::Accounts::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::Accounts::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::Accounts::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::Accounts::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::Accounts::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::Accounts::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::Accounts::has_username ( ) const
inline

Determine if the 'username' attribute was set.

Returns
true if the 'username' attribute was set.

◆ mutable_items()

client::JsonCppArray<Account > google_analytics_api::Accounts::mutable_items ( )

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

A list of accounts.

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

◆ New()

Accounts * google_analytics_api::Accounts::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_items_per_page()

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

Change the 'itemsPerPage' attribute.

The maximum number of entries the response can contain, regardless of the actual number of entries 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]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

Collection type.

Parameters
[in]valueThe new value.

◆ set_next_link()

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

Change the 'nextLink' attribute.

Next link for this account collection.

Parameters
[in]valueThe new value.

◆ set_previous_link()

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

Change the 'previousLink' attribute.

Previous link for this account collection.

Parameters
[in]valueThe new value.

◆ set_start_index()

void google_analytics_api::Accounts::set_start_index ( int32  value)
inline

Change the 'startIndex' attribute.

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

Parameters
[in]valueThe new value.

◆ set_total_results()

void google_analytics_api::Accounts::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]valueThe new value.

◆ set_username()

void google_analytics_api::Accounts::set_username ( const StringPiece &  value)
inline

Change the 'username' attribute.

Email ID of the authenticated user.

Parameters
[in]valueThe new value.

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