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

#include <goal.h>

Inheritance diagram for google_analytics_api::Goal:

Classes

class  GoalEventDetails
 
class  GoalParentLink
 
class  GoalUrlDestinationDetails
 
class  GoalVisitNumPagesDetails
 
class  GoalVisitTimeOnSiteDetails
 

Public Member Functions

 Goal (const Json::Value &storage)
 
 Goal (Json::Value *storage)
 
virtual ~Goal ()
 
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_active () const
 
void clear_active ()
 
bool get_active () const
 
void set_active (bool value)
 
bool has_created () const
 
void clear_created ()
 
client::DateTime get_created () const
 
void set_created (client::DateTime value)
 
bool has_event_details () const
 
void clear_event_details ()
 
const GoalEventDetails get_event_details () const
 
GoalEventDetails mutable_eventDetails ()
 
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 GoalParentLink get_parent_link () const
 
GoalParentLink mutable_parentLink ()
 
bool has_profile_id () const
 
void clear_profile_id ()
 
const StringPiece get_profile_id () const
 
void set_profile_id (const StringPiece &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_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_url_destination_details () const
 
void clear_url_destination_details ()
 
const GoalUrlDestinationDetails get_url_destination_details () const
 
GoalUrlDestinationDetails mutable_urlDestinationDetails ()
 
bool has_value () const
 
void clear_value ()
 
float get_value () const
 
void set_value (float value)
 
bool has_visit_num_pages_details () const
 
void clear_visit_num_pages_details ()
 
const GoalVisitNumPagesDetails get_visit_num_pages_details () const
 
GoalVisitNumPagesDetails mutable_visitNumPagesDetails ()
 
bool has_visit_time_on_site_details () const
 
void clear_visit_time_on_site_details ()
 
const GoalVisitTimeOnSiteDetails get_visit_time_on_site_details () const
 
GoalVisitTimeOnSiteDetails mutable_visitTimeOnSiteDetails ()
 
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)
 

Static Public Member Functions

static GoalNew ()
 

Detailed Description

JSON template for Analytics goal resource.

Constructor & Destructor Documentation

◆ Goal() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Goal() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Goal()

google_analytics_api::Goal::~Goal ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_account_id()

void google_analytics_api::Goal::clear_account_id ( )
inline

Clears the 'accountId' attribute.

◆ clear_active()

void google_analytics_api::Goal::clear_active ( )
inline

Clears the 'active' attribute.

◆ clear_created()

void google_analytics_api::Goal::clear_created ( )
inline

Clears the 'created' attribute.

◆ clear_event_details()

void google_analytics_api::Goal::clear_event_details ( )
inline

Clears the 'eventDetails' attribute.

◆ clear_id()

void google_analytics_api::Goal::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_internal_web_property_id()

void google_analytics_api::Goal::clear_internal_web_property_id ( )
inline

Clears the 'internalWebPropertyId' attribute.

◆ clear_kind()

void google_analytics_api::Goal::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_analytics_api::Goal::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_parent_link()

void google_analytics_api::Goal::clear_parent_link ( )
inline

Clears the 'parentLink' attribute.

◆ clear_profile_id()

void google_analytics_api::Goal::clear_profile_id ( )
inline

Clears the 'profileId' attribute.

◆ clear_self_link()

void google_analytics_api::Goal::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_type()

void google_analytics_api::Goal::clear_type ( )
inline

Clears the 'type' attribute.

◆ clear_updated()

void google_analytics_api::Goal::clear_updated ( )
inline

Clears the 'updated' attribute.

◆ clear_url_destination_details()

void google_analytics_api::Goal::clear_url_destination_details ( )
inline

Clears the 'urlDestinationDetails' attribute.

◆ clear_value()

void google_analytics_api::Goal::clear_value ( )
inline

Clears the 'value' attribute.

◆ clear_visit_num_pages_details()

void google_analytics_api::Goal::clear_visit_num_pages_details ( )
inline

Clears the 'visitNumPagesDetails' attribute.

◆ clear_visit_time_on_site_details()

void google_analytics_api::Goal::clear_visit_time_on_site_details ( )
inline

Clears the 'visitTimeOnSiteDetails' attribute.

◆ clear_web_property_id()

void google_analytics_api::Goal::clear_web_property_id ( )
inline

Clears the 'webPropertyId' attribute.

◆ get_account_id()

const StringPiece google_analytics_api::Goal::get_account_id ( ) const
inline

Get the value of the 'accountId' attribute.

◆ get_active()

bool google_analytics_api::Goal::get_active ( ) const
inline

Get the value of the 'active' attribute.

◆ get_created()

client::DateTime google_analytics_api::Goal::get_created ( ) const
inline

Get the value of the 'created' attribute.

◆ get_event_details()

const GoalEventDetails google_analytics_api::Goal::get_event_details ( ) const
inline

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

◆ get_id()

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

Get the value of the 'id' attribute.

◆ get_internal_web_property_id()

const StringPiece google_analytics_api::Goal::get_internal_web_property_id ( ) const
inline

Get the value of the 'internalWebPropertyId' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_analytics_api::Goal::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_parent_link()

const GoalParentLink google_analytics_api::Goal::get_parent_link ( ) const
inline

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

◆ get_profile_id()

const StringPiece google_analytics_api::Goal::get_profile_id ( ) const
inline

Get the value of the 'profileId' attribute.

◆ get_self_link()

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

Get the value of the 'selfLink' attribute.

◆ get_type()

const StringPiece google_analytics_api::Goal::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ get_updated()

client::DateTime google_analytics_api::Goal::get_updated ( ) const
inline

Get the value of the 'updated' attribute.

◆ get_url_destination_details()

const GoalUrlDestinationDetails google_analytics_api::Goal::get_url_destination_details ( ) const
inline

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

◆ get_value()

float google_analytics_api::Goal::get_value ( ) const
inline

Get the value of the 'value' attribute.

◆ get_visit_num_pages_details()

const GoalVisitNumPagesDetails google_analytics_api::Goal::get_visit_num_pages_details ( ) const
inline

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

◆ get_visit_time_on_site_details()

const GoalVisitTimeOnSiteDetails google_analytics_api::Goal::get_visit_time_on_site_details ( ) const
inline

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

◆ get_web_property_id()

const StringPiece google_analytics_api::Goal::get_web_property_id ( ) const
inline

Get the value of the 'webPropertyId' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_analytics_api::Goal

◆ has_account_id()

bool google_analytics_api::Goal::has_account_id ( ) const
inline

Determine if the 'accountId' attribute was set.

Returns
true if the 'accountId' attribute was set.

◆ has_active()

bool google_analytics_api::Goal::has_active ( ) const
inline

Determine if the 'active' attribute was set.

Returns
true if the 'active' attribute was set.

◆ has_created()

bool google_analytics_api::Goal::has_created ( ) const
inline

Determine if the 'created' attribute was set.

Returns
true if the 'created' attribute was set.

◆ has_event_details()

bool google_analytics_api::Goal::has_event_details ( ) const
inline

Determine if the 'eventDetails' attribute was set.

Returns
true if the 'eventDetails' attribute was set.

◆ has_id()

bool google_analytics_api::Goal::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::Goal::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::Goal::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::Goal::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::Goal::has_parent_link ( ) const
inline

Determine if the 'parentLink' attribute was set.

Returns
true if the 'parentLink' attribute was set.

◆ has_profile_id()

bool google_analytics_api::Goal::has_profile_id ( ) const
inline

Determine if the 'profileId' attribute was set.

Returns
true if the 'profileId' attribute was set.

◆ has_self_link()

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

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_type()

bool google_analytics_api::Goal::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::Goal::has_updated ( ) const
inline

Determine if the 'updated' attribute was set.

Returns
true if the 'updated' attribute was set.

◆ has_url_destination_details()

bool google_analytics_api::Goal::has_url_destination_details ( ) const
inline

Determine if the 'urlDestinationDetails' attribute was set.

Returns
true if the 'urlDestinationDetails' attribute was set.

◆ has_value()

bool google_analytics_api::Goal::has_value ( ) const
inline

Determine if the 'value' attribute was set.

Returns
true if the 'value' attribute was set.

◆ has_visit_num_pages_details()

bool google_analytics_api::Goal::has_visit_num_pages_details ( ) const
inline

Determine if the 'visitNumPagesDetails' attribute was set.

Returns
true if the 'visitNumPagesDetails' attribute was set.

◆ has_visit_time_on_site_details()

bool google_analytics_api::Goal::has_visit_time_on_site_details ( ) const
inline

Determine if the 'visitTimeOnSiteDetails' attribute was set.

Returns
true if the 'visitTimeOnSiteDetails' attribute was set.

◆ has_web_property_id()

bool google_analytics_api::Goal::has_web_property_id ( ) const
inline

Determine if the 'webPropertyId' attribute was set.

Returns
true if the 'webPropertyId' attribute was set.

◆ mutable_eventDetails()

GoalEventDetails google_analytics_api::Goal::mutable_eventDetails ( )
inline

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

Details for the goal of the type EVENT.

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

◆ mutable_parentLink()

GoalParentLink google_analytics_api::Goal::mutable_parentLink ( )
inline

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

Parent link for a goal. Points to the view (profile) to which this goal belongs.

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

◆ mutable_urlDestinationDetails()

GoalUrlDestinationDetails google_analytics_api::Goal::mutable_urlDestinationDetails ( )
inline

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

Details for the goal of the type URL_DESTINATION.

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

◆ mutable_visitNumPagesDetails()

GoalVisitNumPagesDetails google_analytics_api::Goal::mutable_visitNumPagesDetails ( )
inline

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

Details for the goal of the type VISIT_NUM_PAGES.

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

◆ mutable_visitTimeOnSiteDetails()

GoalVisitTimeOnSiteDetails google_analytics_api::Goal::mutable_visitTimeOnSiteDetails ( )
inline

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

Details for the goal of the type VISIT_TIME_ON_SITE.

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

◆ New()

Goal * google_analytics_api::Goal::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_account_id()

void google_analytics_api::Goal::set_account_id ( const StringPiece &  value)
inline

Change the 'accountId' attribute.

Account ID to which this goal belongs.

Parameters
[in]valueThe new value.

◆ set_active()

void google_analytics_api::Goal::set_active ( bool  value)
inline

Change the 'active' attribute.

Determines whether this goal is active.

Parameters
[in]valueThe new value.

◆ set_created()

void google_analytics_api::Goal::set_created ( client::DateTime  value)
inline

Change the 'created' attribute.

Time this goal was created.

Parameters
[in]valueThe new value.

◆ set_id()

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

Change the 'id' attribute.

Goal ID.

Parameters
[in]valueThe new value.

◆ set_internal_web_property_id()

void google_analytics_api::Goal::set_internal_web_property_id ( const StringPiece &  value)
inline

Change the 'internalWebPropertyId' attribute.

Internal ID for the web property to which this goal belongs.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

Resource type for an Analytics goal.

Parameters
[in]valueThe new value.

◆ set_name()

void google_analytics_api::Goal::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

Goal name.

Parameters
[in]valueThe new value.

◆ set_profile_id()

void google_analytics_api::Goal::set_profile_id ( const StringPiece &  value)
inline

Change the 'profileId' attribute.

View (Profile) ID to which this goal belongs.

Parameters
[in]valueThe new value.

◆ set_self_link()

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

Change the 'selfLink' attribute.

Link for this goal.

Parameters
[in]valueThe new value.

◆ set_type()

void google_analytics_api::Goal::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.

Parameters
[in]valueThe new value.

◆ set_updated()

void google_analytics_api::Goal::set_updated ( client::DateTime  value)
inline

Change the 'updated' attribute.

Time this goal was last modified.

Parameters
[in]valueThe new value.

◆ set_value()

void google_analytics_api::Goal::set_value ( float  value)
inline

Change the 'value' attribute.

Goal value.

Parameters
[in]valueThe new value.

◆ set_web_property_id()

void google_analytics_api::Goal::set_web_property_id ( const StringPiece &  value)
inline

Change the 'webPropertyId' attribute.

Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

Parameters
[in]valueThe new value.

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