google_analytics_api::Profile Class Reference

#include <profile.h>

Inheritance diagram for google_analytics_api::Profile:

Classes
class	ProfileChildLink
class	ProfileParentLink
class	ProfilePermissions

Public Member Functions
	Profile (const Json::Value &storage)
	Profile (Json::Value *storage)
virtual	~Profile ()
const StringPiece	GetTypeName () const
bool	has_account_id () const
void	clear_account_id ()
const StringPiece	get_account_id () const
void	set_account_id (const StringPiece &value)
bool	has_bot_filtering_enabled () const
void	clear_bot_filtering_enabled ()
bool	get_bot_filtering_enabled () const
void	set_bot_filtering_enabled (bool value)
bool	has_child_link () const
void	clear_child_link ()
const ProfileChildLink	get_child_link () const
ProfileChildLink	mutable_childLink ()
bool	has_created () const
void	clear_created ()
client::DateTime	get_created () const
void	set_created (client::DateTime value)
bool	has_currency () const
void	clear_currency ()
const StringPiece	get_currency () const
void	set_currency (const StringPiece &value)
bool	has_default_page () const
void	clear_default_page ()
const StringPiece	get_default_page () const
void	set_default_page (const StringPiece &value)
bool	has_e_commerce_tracking () const
void	clear_e_commerce_tracking ()
bool	get_e_commerce_tracking () const
void	set_e_commerce_tracking (bool value)
bool	has_enhanced_ec_ommerce_tracking () const
void	clear_enhanced_ec_ommerce_tracking ()
bool	get_enhanced_ec_ommerce_tracking () const
void	set_enhanced_ec_ommerce_tracking (bool value)
bool	has_exclude_query_parameters () const
void	clear_exclude_query_parameters ()
const StringPiece	get_exclude_query_parameters () const
void	set_exclude_query_parameters (const StringPiece &value)
bool	has_id () const
void	clear_id ()
const StringPiece	get_id () const
void	set_id (const StringPiece &value)
bool	has_internal_web_property_id () const
void	clear_internal_web_property_id ()
const StringPiece	get_internal_web_property_id () const
void	set_internal_web_property_id (const StringPiece &value)
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_parent_link () const
void	clear_parent_link ()
const ProfileParentLink	get_parent_link () const
ProfileParentLink	mutable_parentLink ()
bool	has_permissions () const
void	clear_permissions ()
const ProfilePermissions	get_permissions () const
ProfilePermissions	mutable_permissions ()
bool	has_self_link () const
void	clear_self_link ()
const StringPiece	get_self_link () const
void	set_self_link (const StringPiece &value)
bool	has_site_search_category_parameters () const
void	clear_site_search_category_parameters ()
const StringPiece	get_site_search_category_parameters () const
void	set_site_search_category_parameters (const StringPiece &value)
bool	has_site_search_query_parameters () const
void	clear_site_search_query_parameters ()
const StringPiece	get_site_search_query_parameters () const
void	set_site_search_query_parameters (const StringPiece &value)
bool	has_starred () const
void	clear_starred ()
bool	get_starred () const
void	set_starred (bool value)
bool	has_strip_site_search_category_parameters () const
void	clear_strip_site_search_category_parameters ()
bool	get_strip_site_search_category_parameters () const
void	set_strip_site_search_category_parameters (bool value)
bool	has_strip_site_search_query_parameters () const
void	clear_strip_site_search_query_parameters ()
bool	get_strip_site_search_query_parameters () const
void	set_strip_site_search_query_parameters (bool value)
bool	has_timezone () const
void	clear_timezone ()
const StringPiece	get_timezone () const
void	set_timezone (const StringPiece &value)
bool	has_type () const
void	clear_type ()
const StringPiece	get_type () const
void	set_type (const StringPiece &value)
bool	has_updated () const
void	clear_updated ()
client::DateTime	get_updated () const
void	set_updated (client::DateTime value)
bool	has_web_property_id () const
void	clear_web_property_id ()
const StringPiece	get_web_property_id () const
void	set_web_property_id (const StringPiece &value)
bool	has_website_url () const
void	clear_website_url ()
const StringPiece	get_website_url () const
void	set_website_url (const StringPiece &value)

Static Public Member Functions
static Profile *	New ()

Detailed Description

JSON template for an Analytics view (profile).

Constructor & Destructor Documentation

Profile() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Profile() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Profile()

google_analytics_api::Profile::~Profile ( )

virtual

Standard destructor.

Member Function Documentation

clear_account_id()

void google_analytics_api::Profile::clear_account_id ( )

inline

Clears the 'accountId' attribute.

clear_bot_filtering_enabled()

void google_analytics_api::Profile::clear_bot_filtering_enabled ( )

inline

Clears the 'botFilteringEnabled' attribute.

clear_child_link()

void google_analytics_api::Profile::clear_child_link ( )

inline

Clears the 'childLink' attribute.

clear_created()

void google_analytics_api::Profile::clear_created ( )

inline

Clears the 'created' attribute.

clear_currency()

void google_analytics_api::Profile::clear_currency ( )

inline

Clears the 'currency' attribute.

clear_default_page()

void google_analytics_api::Profile::clear_default_page ( )

inline

Clears the 'defaultPage' attribute.

clear_e_commerce_tracking()

void google_analytics_api::Profile::clear_e_commerce_tracking ( )

inline

Clears the 'eCommerceTracking' attribute.

clear_enhanced_ec_ommerce_tracking()

void google_analytics_api::Profile::clear_enhanced_ec_ommerce_tracking ( )

inline

Clears the 'enhancedECommerceTracking' attribute.

clear_exclude_query_parameters()

void google_analytics_api::Profile::clear_exclude_query_parameters ( )

inline

Clears the 'excludeQueryParameters' attribute.

clear_id()

void google_analytics_api::Profile::clear_id ( )

inline

Clears the 'id' attribute.

clear_internal_web_property_id()

void google_analytics_api::Profile::clear_internal_web_property_id ( )

inline

Clears the 'internalWebPropertyId' attribute.

clear_kind()

void google_analytics_api::Profile::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_name()

void google_analytics_api::Profile::clear_name ( )

inline

Clears the 'name' attribute.

clear_parent_link()

void google_analytics_api::Profile::clear_parent_link ( )

inline

Clears the 'parentLink' attribute.

clear_permissions()

void google_analytics_api::Profile::clear_permissions ( )

inline

Clears the 'permissions' attribute.

clear_self_link()

void google_analytics_api::Profile::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

clear_site_search_category_parameters()

void google_analytics_api::Profile::clear_site_search_category_parameters ( )

inline

Clears the 'siteSearchCategoryParameters' attribute.

clear_site_search_query_parameters()

void google_analytics_api::Profile::clear_site_search_query_parameters ( )

inline

Clears the 'siteSearchQueryParameters' attribute.

clear_starred()

void google_analytics_api::Profile::clear_starred ( )

inline

Clears the 'starred' attribute.

clear_strip_site_search_category_parameters()

void google_analytics_api::Profile::clear_strip_site_search_category_parameters ( )

inline

Clears the 'stripSiteSearchCategoryParameters' attribute.

clear_strip_site_search_query_parameters()

void google_analytics_api::Profile::clear_strip_site_search_query_parameters ( )

inline

Clears the 'stripSiteSearchQueryParameters' attribute.

clear_timezone()

void google_analytics_api::Profile::clear_timezone ( )

inline

Clears the 'timezone' attribute.

clear_type()

void google_analytics_api::Profile::clear_type ( )

inline

Clears the 'type' attribute.

clear_updated()

void google_analytics_api::Profile::clear_updated ( )

inline

Clears the 'updated' attribute.

clear_web_property_id()

void google_analytics_api::Profile::clear_web_property_id ( )

inline

Clears the 'webPropertyId' attribute.

clear_website_url()

void google_analytics_api::Profile::clear_website_url ( )

inline

Clears the 'websiteUrl' attribute.

get_account_id()

const StringPiece google_analytics_api::Profile::get_account_id ( ) const

inline

Get the value of the 'accountId' attribute.

get_bot_filtering_enabled()

bool google_analytics_api::Profile::get_bot_filtering_enabled ( ) const

inline

Get the value of the 'botFilteringEnabled' attribute.

get_child_link()

const ProfileChildLink google_analytics_api::Profile::get_child_link ( ) const

inline

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

get_created()

client::DateTime google_analytics_api::Profile::get_created ( ) const

inline

Get the value of the 'created' attribute.

get_currency()

const StringPiece google_analytics_api::Profile::get_currency ( ) const

inline

Get the value of the 'currency' attribute.

get_default_page()

const StringPiece google_analytics_api::Profile::get_default_page ( ) const

inline

Get the value of the 'defaultPage' attribute.

get_e_commerce_tracking()

bool google_analytics_api::Profile::get_e_commerce_tracking ( ) const

inline

Get the value of the 'eCommerceTracking' attribute.

get_enhanced_ec_ommerce_tracking()

bool google_analytics_api::Profile::get_enhanced_ec_ommerce_tracking ( ) const

inline

Get the value of the 'enhancedECommerceTracking' attribute.

get_exclude_query_parameters()

const StringPiece google_analytics_api::Profile::get_exclude_query_parameters ( ) const

inline

Get the value of the 'excludeQueryParameters' attribute.

get_id()

const StringPiece google_analytics_api::Profile::get_id ( ) const

inline

Get the value of the 'id' attribute.

get_internal_web_property_id()

const StringPiece google_analytics_api::Profile::get_internal_web_property_id ( ) const

inline

Get the value of the 'internalWebPropertyId' attribute.

get_kind()

const StringPiece google_analytics_api::Profile::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_name()

const StringPiece google_analytics_api::Profile::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_parent_link()

const ProfileParentLink google_analytics_api::Profile::get_parent_link ( ) const

inline

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

get_permissions()

const ProfilePermissions google_analytics_api::Profile::get_permissions ( ) const

inline

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

get_self_link()

const StringPiece google_analytics_api::Profile::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

get_site_search_category_parameters()

const StringPiece google_analytics_api::Profile::get_site_search_category_parameters ( ) const

inline

Get the value of the 'siteSearchCategoryParameters' attribute.

get_site_search_query_parameters()

const StringPiece google_analytics_api::Profile::get_site_search_query_parameters ( ) const

inline

Get the value of the 'siteSearchQueryParameters' attribute.

get_starred()

bool google_analytics_api::Profile::get_starred ( ) const

inline

Get the value of the 'starred' attribute.

get_strip_site_search_category_parameters()

bool google_analytics_api::Profile::get_strip_site_search_category_parameters ( ) const

inline

Get the value of the 'stripSiteSearchCategoryParameters' attribute.

get_strip_site_search_query_parameters()

bool google_analytics_api::Profile::get_strip_site_search_query_parameters ( ) const

inline

Get the value of the 'stripSiteSearchQueryParameters' attribute.

get_timezone()

const StringPiece google_analytics_api::Profile::get_timezone ( ) const

inline

Get the value of the 'timezone' attribute.

get_type()

const StringPiece google_analytics_api::Profile::get_type ( ) const

inline

Get the value of the 'type' attribute.

get_updated()

client::DateTime google_analytics_api::Profile::get_updated ( ) const

inline

Get the value of the 'updated' attribute.

get_web_property_id()

const StringPiece google_analytics_api::Profile::get_web_property_id ( ) const

inline

Get the value of the 'webPropertyId' attribute.

get_website_url()

const StringPiece google_analytics_api::Profile::get_website_url ( ) const

inline

Get the value of the 'websiteUrl' attribute.

GetTypeName()

const StringPiece google_analytics_api::Profile::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_analytics_api::Profile

has_account_id()

bool google_analytics_api::Profile::has_account_id ( ) const

inline

Determine if the 'accountId' attribute was set.

Returns

true if the 'accountId' attribute was set.

has_bot_filtering_enabled()

bool google_analytics_api::Profile::has_bot_filtering_enabled ( ) const

inline

Determine if the 'botFilteringEnabled' attribute was set.

Returns

true if the 'botFilteringEnabled' attribute was set.

has_child_link()

bool google_analytics_api::Profile::has_child_link ( ) const

inline

Determine if the 'childLink' attribute was set.

Returns

true if the 'childLink' attribute was set.

has_created()

bool google_analytics_api::Profile::has_created ( ) const

inline

Determine if the 'created' attribute was set.

Returns

true if the 'created' attribute was set.

has_currency()

bool google_analytics_api::Profile::has_currency ( ) const

inline

Determine if the 'currency' attribute was set.

Returns

true if the 'currency' attribute was set.

has_default_page()

bool google_analytics_api::Profile::has_default_page ( ) const

inline

Determine if the 'defaultPage' attribute was set.

Returns

true if the 'defaultPage' attribute was set.

has_e_commerce_tracking()

bool google_analytics_api::Profile::has_e_commerce_tracking ( ) const

inline

Determine if the 'eCommerceTracking' attribute was set.

Returns

true if the 'eCommerceTracking' attribute was set.

has_enhanced_ec_ommerce_tracking()

bool google_analytics_api::Profile::has_enhanced_ec_ommerce_tracking ( ) const

inline

Determine if the 'enhancedECommerceTracking' attribute was set.

Returns

true if the 'enhancedECommerceTracking' attribute was set.

has_exclude_query_parameters()

bool google_analytics_api::Profile::has_exclude_query_parameters ( ) const

inline

Determine if the 'excludeQueryParameters' attribute was set.

Returns

true if the 'excludeQueryParameters' attribute was set.

has_id()

bool google_analytics_api::Profile::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns

true if the 'id' attribute was set.

has_internal_web_property_id()

bool google_analytics_api::Profile::has_internal_web_property_id ( ) const

inline

Determine if the 'internalWebPropertyId' attribute was set.

Returns

true if the 'internalWebPropertyId' attribute was set.

has_kind()

bool google_analytics_api::Profile::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_name()

bool google_analytics_api::Profile::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_parent_link()

bool google_analytics_api::Profile::has_parent_link ( ) const

inline

Determine if the 'parentLink' attribute was set.

Returns

true if the 'parentLink' attribute was set.

has_permissions()

bool google_analytics_api::Profile::has_permissions ( ) const

inline

Determine if the 'permissions' attribute was set.

Returns

true if the 'permissions' attribute was set.

has_self_link()

bool google_analytics_api::Profile::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns

true if the 'selfLink' attribute was set.

has_site_search_category_parameters()

bool google_analytics_api::Profile::has_site_search_category_parameters ( ) const

inline

Determine if the 'siteSearchCategoryParameters' attribute was set.

Returns

true if the 'siteSearchCategoryParameters' attribute was set.

has_site_search_query_parameters()

bool google_analytics_api::Profile::has_site_search_query_parameters ( ) const

inline

Determine if the 'siteSearchQueryParameters' attribute was set.

Returns

true if the 'siteSearchQueryParameters' attribute was set.

has_starred()

bool google_analytics_api::Profile::has_starred ( ) const

inline

Determine if the 'starred' attribute was set.

Returns

true if the 'starred' attribute was set.

has_strip_site_search_category_parameters()

bool google_analytics_api::Profile::has_strip_site_search_category_parameters ( ) const

inline

Determine if the 'stripSiteSearchCategoryParameters' attribute was set.

Returns

true if the 'stripSiteSearchCategoryParameters' attribute was set.

has_strip_site_search_query_parameters()

bool google_analytics_api::Profile::has_strip_site_search_query_parameters ( ) const

inline

Determine if the 'stripSiteSearchQueryParameters' attribute was set.

Returns

true if the 'stripSiteSearchQueryParameters' attribute was set.

has_timezone()

bool google_analytics_api::Profile::has_timezone ( ) const

inline

Determine if the 'timezone' attribute was set.

Returns

true if the 'timezone' attribute was set.

has_type()

bool google_analytics_api::Profile::has_type ( ) const

inline

Determine if the 'type' attribute was set.

Returns

true if the 'type' attribute was set.

has_updated()

bool google_analytics_api::Profile::has_updated ( ) const

inline

Determine if the 'updated' attribute was set.

Returns

true if the 'updated' attribute was set.

has_web_property_id()

bool google_analytics_api::Profile::has_web_property_id ( ) const

inline

Determine if the 'webPropertyId' attribute was set.

Returns

true if the 'webPropertyId' attribute was set.

has_website_url()

bool google_analytics_api::Profile::has_website_url ( ) const

inline

Determine if the 'websiteUrl' attribute was set.

Returns

true if the 'websiteUrl' attribute was set.

mutable_childLink()

ProfileChildLink google_analytics_api::Profile::mutable_childLink ( )

inline

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

Child link for this view (profile). Points to the list of goals for this view (profile).

Returns

The result can be modified to change the attribute value.

mutable_parentLink()

ProfileParentLink google_analytics_api::Profile::mutable_parentLink ( )

inline

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

Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

Returns

The result can be modified to change the attribute value.

mutable_permissions()

ProfilePermissions google_analytics_api::Profile::mutable_permissions ( )

inline

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

Permissions the user has for this view (profile).

Returns

The result can be modified to change the attribute value.

New()

Profile * google_analytics_api::Profile::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_account_id()

void google_analytics_api::Profile::set_account_id ( const StringPiece &  value )

inline

Change the 'accountId' attribute.

Account ID to which this view (profile) belongs.

Parameters

[in]

value

The new value.

set_bot_filtering_enabled()

void google_analytics_api::Profile::set_bot_filtering_enabled ( bool  value )

inline

Change the 'botFilteringEnabled' attribute.

Indicates whether bot filtering is enabled for this view (profile).

Parameters

[in]

value

The new value.

set_created()

void google_analytics_api::Profile::set_created ( client::DateTime  value )

inline

Change the 'created' attribute.

Time this view (profile) was created.

Parameters

[in]

value

The new value.

set_currency()

void google_analytics_api::Profile::set_currency ( const StringPiece &  value )

inline

Change the 'currency' attribute.

The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL.

Parameters

[in]

value

The new value.

set_default_page()

void google_analytics_api::Profile::set_default_page ( const StringPiece &  value )

inline

Change the 'defaultPage' attribute.

Default page for this view (profile).

Parameters

[in]

value

The new value.

set_e_commerce_tracking()

void google_analytics_api::Profile::set_e_commerce_tracking ( bool  value )

inline

Change the 'eCommerceTracking' attribute.

Indicates whether ecommerce tracking is enabled for this view (profile).

Parameters

[in]

value

The new value.

set_enhanced_ec_ommerce_tracking()

void google_analytics_api::Profile::set_enhanced_ec_ommerce_tracking ( bool  value )

inline

Change the 'enhancedECommerceTracking' attribute.

Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.

Parameters

[in]

value

The new value.

set_exclude_query_parameters()

void google_analytics_api::Profile::set_exclude_query_parameters ( const StringPiece &  value )

inline

Change the 'excludeQueryParameters' attribute.

The query parameters that are excluded from this view (profile).

Parameters

[in]

value

The new value.

set_id()

void google_analytics_api::Profile::set_id ( const StringPiece &  value )

inline

Change the 'id' attribute.

View (Profile) ID.

Parameters

[in]

value

The new value.

set_internal_web_property_id()

void google_analytics_api::Profile::set_internal_web_property_id ( const StringPiece &  value )

inline

Change the 'internalWebPropertyId' attribute.

Internal ID for the web property to which this view (profile) belongs.

Parameters

[in]

value

The new value.

set_kind()

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

inline

Change the 'kind' attribute.

Resource type for Analytics view (profile).

Parameters

[in]

value

The new value.

set_name()

void google_analytics_api::Profile::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

Name of this view (profile).

Parameters

[in]

value

The new value.

set_self_link()

void google_analytics_api::Profile::set_self_link ( const StringPiece &  value )

inline

Change the 'selfLink' attribute.

Link for this view (profile).

Parameters

[in]

value

The new value.

set_site_search_category_parameters()

void google_analytics_api::Profile::set_site_search_category_parameters ( const StringPiece &  value )

inline

Change the 'siteSearchCategoryParameters' attribute.

Site search category parameters for this view (profile).

Parameters

[in]

value

The new value.

set_site_search_query_parameters()

void google_analytics_api::Profile::set_site_search_query_parameters ( const StringPiece &  value )

inline

Change the 'siteSearchQueryParameters' attribute.

The site search query parameters for this view (profile).

Parameters

[in]

value

The new value.

set_starred()

void google_analytics_api::Profile::set_starred ( bool  value )

inline

Change the 'starred' attribute.

Indicates whether this view (profile) is starred or not.

Parameters

[in]

value

The new value.

set_strip_site_search_category_parameters()

void google_analytics_api::Profile::set_strip_site_search_category_parameters ( bool  value )

inline

Change the 'stripSiteSearchCategoryParameters' attribute.

Whether or not Analytics will strip search category parameters from the URLs in your reports.

Parameters

[in]

value

The new value.

set_strip_site_search_query_parameters()

void google_analytics_api::Profile::set_strip_site_search_query_parameters ( bool  value )

inline

Change the 'stripSiteSearchQueryParameters' attribute.

Whether or not Analytics will strip search query parameters from the URLs in your reports.

Parameters

[in]

value

The new value.

set_timezone()

void google_analytics_api::Profile::set_timezone ( const StringPiece &  value )

inline

Change the 'timezone' attribute.

Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.

Parameters

[in]

value

The new value.

set_type()

void google_analytics_api::Profile::set_type ( const StringPiece &  value )

inline

Change the 'type' attribute.

View (Profile) type. Supported types: WEB or APP.

Parameters

[in]

value

The new value.

set_updated()

void google_analytics_api::Profile::set_updated ( client::DateTime  value )

inline

Change the 'updated' attribute.

Time this view (profile) was last modified.

Parameters

[in]

value

The new value.

set_web_property_id()

void google_analytics_api::Profile::set_web_property_id ( const StringPiece &  value )

inline

Change the 'webPropertyId' attribute.

Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

Parameters

[in]

value

The new value.

set_website_url()

void google_analytics_api::Profile::set_website_url ( const StringPiece &  value )

inline

Change the 'websiteUrl' attribute.

Website URL for this view (profile).

Parameters

[in]

value

The new value.

---

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

• google/analytics_api/profile.h
• google/analytics_api/profile.cc