Class: Google::Analytics::Admin::V1alpha::Audience

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/admin/v1alpha/audience.rb

Overview

A resource message representing a GA4 Audience.

Defined Under Namespace

Modules: AudienceExclusionDurationMode

Instance Attribute Summary collapse

Instance Attribute Details

#ads_personalization_enabled ⇒ ::Boolean (readonly)

Returns Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.

Returns:

  • (::Boolean) —

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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the Audience was created.

Returns:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#description ⇒ ::String

Returns Required. The description of the Audience.

Returns:

  • (::String) —

    Required. The description of the Audience.



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#display_name ⇒ ::String

Returns Required. The display name of the Audience.

Returns:

  • (::String) —

    Required. The display name of the Audience.



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#event_trigger ⇒ ::Google::Analytics::Admin::V1alpha::AudienceEventTrigger

Returns Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

Returns:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#exclusion_duration_mode ⇒ ::Google::Analytics::Admin::V1alpha::Audience::AudienceExclusionDurationMode

Returns 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.

Returns:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#filter_clauses ⇒ ::Array<::Google::Analytics::Admin::V1alpha::AudienceFilterClause>

Returns Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.

Returns:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#membership_duration_days ⇒ ::Integer

Returns Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.

Returns:

  • (::Integer) —

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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}.

Returns:

  • (::String) —

    Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 382

class Audience
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how long an exclusion lasts for users that meet the exclusion
  # filter.
  module AudienceExclusionDurationMode
    # Not specified.
    AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0

    # Exclude users from the Audience during periods when they meet the
    # filter clause.
    EXCLUDE_TEMPORARILY = 1

    # Exclude users from the Audience if they've ever met the filter clause.
    EXCLUDE_PERMANENTLY = 2
  end
end