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.



861
862
863
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 861

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) 


818
819
820
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 818

def ads_personalization_enabled
  @ads_personalization_enabled
end

#description ⇒ String

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

Returns:

  • (String) 


824
825
826
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 824

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


829
830
831
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 829

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:



834
835
836
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 834

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) 


841
842
843
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 841

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:



847
848
849
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 847

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) 


853
854
855
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 853

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) 


859
860
861
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 859

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



866
867
868
869
870
871
872
873
874
875
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 866

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