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.



933
934
935
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 933

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) 


890
891
892
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 890

def ads_personalization_enabled
  @ads_personalization_enabled
end

#description ⇒ String

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

Returns:

  • (String) 


896
897
898
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 896

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


901
902
903
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 901

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:



906
907
908
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 906

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) 


913
914
915
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 913

def exclusion_duration_mode
  @exclusion_duration_mode
end

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

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

Returns:



919
920
921
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 919

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) 


925
926
927
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 925

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) 


931
932
933
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 931

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



938
939
940
941
942
943
944
945
946
947
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 938

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