Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsadmin_v1alpha/classes.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb

Overview

A resource message representing a GA4 Audience.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaAudience

Returns a new instance of GoogleAnalyticsAdminV1alphaAudience.



321
322
323
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 321

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ads_personalization_enabled ⇒ Boolean Also known as: ads_personalization_enabled?

Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. Corresponds to the JSON property adsPersonalizationEnabled

Returns:

  • (Boolean) 


278
279
280
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 278

def ads_personalization_enabled
  @ads_personalization_enabled
end

#description ⇒ String

Required. The description of the Audience. Corresponds to the JSON property description

Returns:

  • (String) 


284
285
286
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 284

def description
  @description
end

#display_name ⇒ String

Required. The display name of the Audience. Corresponds to the JSON property displayName

Returns:

  • (String) 


289
290
291
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 289

def display_name
  @display_name
end

#event_trigger ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger

Specifies an event to log when a user joins the Audience. Corresponds to the JSON property eventTrigger

Returns:



294
295
296
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 294

def event_trigger
  @event_trigger
end

#exclusion_duration_mode ⇒ String

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. Corresponds to the JSON property exclusionDurationMode

Returns:

  • (String) 


301
302
303
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 301

def exclusion_duration_mode
  @exclusion_duration_mode
end

#filter_clauses ⇒ Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause>

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed together. Corresponds to the JSON property filterClauses

Returns:



307
308
309
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 307

def filter_clauses
  @filter_clauses
end

#membership_duration_days ⇒ Fixnum

Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. Corresponds to the JSON property membershipDurationDays

Returns:

  • (Fixnum) 


313
314
315
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 313

def membership_duration_days
  @membership_duration_days
end

#name ⇒ String

Output only. The resource name for this Audience resource. Format: properties/ propertyId/audiences/audienceId Corresponds to the JSON property name

Returns:

  • (String) 


319
320
321
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 319

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 326

def update!(**args)
  @ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @event_trigger = args[:event_trigger] if args.key?(:event_trigger)
  @exclusion_duration_mode = args[:exclusion_duration_mode] if args.key?(:exclusion_duration_mode)
  @filter_clauses = args[:filter_clauses] if args.key?(:filter_clauses)
  @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
  @name = args[:name] if args.key?(:name)
end