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

#include <remarketing_audience.h>

Inheritance diagram for google_analytics_api::RemarketingAudience:

Classes

class  RemarketingAudienceAudienceDefinition
 
class  RemarketingAudienceStateBasedAudienceDefinition
 

Public Member Functions

 RemarketingAudience (const Json::Value &storage)
 
 RemarketingAudience (Json::Value *storage)
 
virtual ~RemarketingAudience ()
 
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_audience_definition () const
 
void clear_audience_definition ()
 
const RemarketingAudienceAudienceDefinition get_audience_definition () const
 
RemarketingAudienceAudienceDefinition mutable_audienceDefinition ()
 
bool has_audience_type () const
 
void clear_audience_type ()
 
const StringPiece get_audience_type () const
 
void set_audience_type (const StringPiece &value)
 
bool has_created () const
 
void clear_created ()
 
client::DateTime get_created () const
 
void set_created (client::DateTime value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (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_linked_ad_accounts () const
 
void clear_linked_ad_accounts ()
 
const client::JsonCppArray< LinkedForeignAccountget_linked_ad_accounts () const
 
client::JsonCppArray< LinkedForeignAccountmutable_linkedAdAccounts ()
 
bool has_linked_views () const
 
void clear_linked_views ()
 
const client::JsonCppArray< string > get_linked_views () const
 
client::JsonCppArray< string > mutable_linkedViews ()
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_state_based_audience_definition () const
 
void clear_state_based_audience_definition ()
 
const RemarketingAudienceStateBasedAudienceDefinition get_state_based_audience_definition () const
 
RemarketingAudienceStateBasedAudienceDefinition mutable_stateBasedAudienceDefinition ()
 
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)
 

Static Public Member Functions

static RemarketingAudienceNew ()
 

Detailed Description

JSON template for an Analytics remarketing audience.

Constructor & Destructor Documentation

◆ RemarketingAudience() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ RemarketingAudience() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~RemarketingAudience()

google_analytics_api::RemarketingAudience::~RemarketingAudience ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_account_id()

void google_analytics_api::RemarketingAudience::clear_account_id ( )
inline

Clears the 'accountId' attribute.

◆ clear_audience_definition()

void google_analytics_api::RemarketingAudience::clear_audience_definition ( )
inline

Clears the 'audienceDefinition' attribute.

◆ clear_audience_type()

void google_analytics_api::RemarketingAudience::clear_audience_type ( )
inline

Clears the 'audienceType' attribute.

◆ clear_created()

void google_analytics_api::RemarketingAudience::clear_created ( )
inline

Clears the 'created' attribute.

◆ clear_description()

void google_analytics_api::RemarketingAudience::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_id()

void google_analytics_api::RemarketingAudience::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_internal_web_property_id()

void google_analytics_api::RemarketingAudience::clear_internal_web_property_id ( )
inline

Clears the 'internalWebPropertyId' attribute.

◆ clear_kind()

void google_analytics_api::RemarketingAudience::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_linked_ad_accounts()

void google_analytics_api::RemarketingAudience::clear_linked_ad_accounts ( )
inline

Clears the 'linkedAdAccounts' attribute.

◆ clear_linked_views()

void google_analytics_api::RemarketingAudience::clear_linked_views ( )
inline

Clears the 'linkedViews' attribute.

◆ clear_name()

void google_analytics_api::RemarketingAudience::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_state_based_audience_definition()

void google_analytics_api::RemarketingAudience::clear_state_based_audience_definition ( )
inline

Clears the 'stateBasedAudienceDefinition' attribute.

◆ clear_updated()

void google_analytics_api::RemarketingAudience::clear_updated ( )
inline

Clears the 'updated' attribute.

◆ clear_web_property_id()

void google_analytics_api::RemarketingAudience::clear_web_property_id ( )
inline

Clears the 'webPropertyId' attribute.

◆ get_account_id()

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

Get the value of the 'accountId' attribute.

◆ get_audience_definition()

const RemarketingAudienceAudienceDefinition google_analytics_api::RemarketingAudience::get_audience_definition ( ) const
inline

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

◆ get_audience_type()

const StringPiece google_analytics_api::RemarketingAudience::get_audience_type ( ) const
inline

Get the value of the 'audienceType' attribute.

◆ get_created()

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

Get the value of the 'created' attribute.

◆ get_description()

const StringPiece google_analytics_api::RemarketingAudience::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_id()

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

Get the value of the 'id' attribute.

◆ get_internal_web_property_id()

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

Get the value of the 'internalWebPropertyId' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_linked_ad_accounts()

const client::JsonCppArray<LinkedForeignAccount > google_analytics_api::RemarketingAudience::get_linked_ad_accounts ( ) const

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

◆ get_linked_views()

const client::JsonCppArray<string > google_analytics_api::RemarketingAudience::get_linked_views ( ) const
inline

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

◆ get_name()

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

Get the value of the 'name' attribute.

◆ get_state_based_audience_definition()

const RemarketingAudienceStateBasedAudienceDefinition google_analytics_api::RemarketingAudience::get_state_based_audience_definition ( ) const
inline

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

◆ get_updated()

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

Get the value of the 'updated' attribute.

◆ get_web_property_id()

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

Get the value of the 'webPropertyId' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_analytics_api::RemarketingAudience

◆ has_account_id()

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

Determine if the 'accountId' attribute was set.

Returns
true if the 'accountId' attribute was set.

◆ has_audience_definition()

bool google_analytics_api::RemarketingAudience::has_audience_definition ( ) const
inline

Determine if the 'audienceDefinition' attribute was set.

Returns
true if the 'audienceDefinition' attribute was set.

◆ has_audience_type()

bool google_analytics_api::RemarketingAudience::has_audience_type ( ) const
inline

Determine if the 'audienceType' attribute was set.

Returns
true if the 'audienceType' attribute was set.

◆ has_created()

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

Determine if the 'created' attribute was set.

Returns
true if the 'created' attribute was set.

◆ has_description()

bool google_analytics_api::RemarketingAudience::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_id()

bool google_analytics_api::RemarketingAudience::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::RemarketingAudience::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::RemarketingAudience::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_linked_ad_accounts()

bool google_analytics_api::RemarketingAudience::has_linked_ad_accounts ( ) const
inline

Determine if the 'linkedAdAccounts' attribute was set.

Returns
true if the 'linkedAdAccounts' attribute was set.

◆ has_linked_views()

bool google_analytics_api::RemarketingAudience::has_linked_views ( ) const
inline

Determine if the 'linkedViews' attribute was set.

Returns
true if the 'linkedViews' attribute was set.

◆ has_name()

bool google_analytics_api::RemarketingAudience::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_state_based_audience_definition()

bool google_analytics_api::RemarketingAudience::has_state_based_audience_definition ( ) const
inline

Determine if the 'stateBasedAudienceDefinition' attribute was set.

Returns
true if the 'stateBasedAudienceDefinition' attribute was set.

◆ has_updated()

bool google_analytics_api::RemarketingAudience::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::RemarketingAudience::has_web_property_id ( ) const
inline

Determine if the 'webPropertyId' attribute was set.

Returns
true if the 'webPropertyId' attribute was set.

◆ mutable_audienceDefinition()

RemarketingAudienceAudienceDefinition google_analytics_api::RemarketingAudience::mutable_audienceDefinition ( )
inline

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

The simple audience definition that will cause a user to be added to an audience.

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

◆ mutable_linkedAdAccounts()

client::JsonCppArray<LinkedForeignAccount > google_analytics_api::RemarketingAudience::mutable_linkedAdAccounts ( )

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

The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.

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

◆ mutable_linkedViews()

client::JsonCppArray<string > google_analytics_api::RemarketingAudience::mutable_linkedViews ( )
inline

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

The views (profiles) that this remarketing audience is linked to.

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

◆ mutable_stateBasedAudienceDefinition()

RemarketingAudienceStateBasedAudienceDefinition google_analytics_api::RemarketingAudience::mutable_stateBasedAudienceDefinition ( )
inline

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

A state based audience definition that will cause a user to be added or removed from an audience.

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

◆ New()

RemarketingAudience * google_analytics_api::RemarketingAudience::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_account_id()

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

Change the 'accountId' attribute.

Account ID to which this remarketing audience belongs.

Parameters
[in]valueThe new value.

◆ set_audience_type()

void google_analytics_api::RemarketingAudience::set_audience_type ( const StringPiece &  value)
inline

Change the 'audienceType' attribute.

The type of audience, either SIMPLE or STATE_BASED.

Parameters
[in]valueThe new value.

◆ set_created()

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

Change the 'created' attribute.

Time this remarketing audience was created.

Parameters
[in]valueThe new value.

◆ set_description()

void google_analytics_api::RemarketingAudience::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

The description of this remarketing audience.

Parameters
[in]valueThe new value.

◆ set_id()

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

Change the 'id' attribute.

Remarketing Audience ID.

Parameters
[in]valueThe new value.

◆ set_internal_web_property_id()

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

Change the 'internalWebPropertyId' attribute.

Internal ID for the web property to which this remarketing audience belongs.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

Collection type.

Parameters
[in]valueThe new value.

◆ set_name()

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

Change the 'name' attribute.

The name of this remarketing audience.

Parameters
[in]valueThe new value.

◆ set_updated()

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

Change the 'updated' attribute.

Time this remarketing audience was last modified.

Parameters
[in]valueThe new value.

◆ set_web_property_id()

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

Change the 'webPropertyId' attribute.

Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.

Parameters
[in]valueThe new value.

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