View Source GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAudience (google_api_analytics_admin v0.21.0)

A resource message representing a GA4 Audience.

Attributes

  • adsPersonalizationEnabled (type: boolean(), default: nil) - Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
  • description (type: String.t, default: nil) - Required. The description of the Audience.
  • displayName (type: String.t, default: nil) - Required. The display name of the Audience.
  • eventTrigger (type: GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAudienceEventTrigger.t, default: nil) - 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.
  • exclusionDurationMode (type: String.t, default: nil) - 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.
  • filterClauses (type: list(GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAudienceFilterClause.t), default: nil) - Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
  • membershipDurationDays (type: integer(), default: nil) - Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
  • name (type: String.t, default: nil) - Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAudience{
    adsPersonalizationEnabled: boolean() | nil,
    description: String.t() | nil,
    displayName: String.t() | nil,
    eventTrigger:
      GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAudienceEventTrigger.t()
      | nil,
    exclusionDurationMode: String.t() | nil,
    filterClauses:
      [
        GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaAudienceFilterClause.t()
      ]
      | nil,
    membershipDurationDays: integer() | nil,
    name: String.t() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.