Console
    Contact Us Start free

    Google Analytics Admin V1alpha Client - Class Audience (0.29.1)

    Reference documentation and code samples for the Google Analytics Admin V1alpha Client class Audience.

    A resource message representing an Audience.

    Generated from protobuf message google.analytics.admin.v1alpha.Audience

    Namespace

    Google \ Analytics \ Admin \ V1alpha

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ display_name
    string

    Required. The display name of the Audience.

    ↳ description
    string

    Required. The description of the Audience.

    ↳ membership_duration_days
    int

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

    ↳ ads_personalization_enabled
    bool

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

    ↳ event_trigger
    AudienceEventTrigger

    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.

    ↳ exclusion_duration_mode
    int

    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.

    ↳ filter_clauses
    array< AudienceFilterClause >

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

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Time when the Audience was created.

    getName

    Output only. The resource name for this Audience resource.

    Format: properties/{propertyId}/audiences/{audienceId}

    Returns
    Type
    Description
    string

    setName

    Output only. The resource name for this Audience resource.

    Format: properties/{propertyId}/audiences/{audienceId}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. The display name of the Audience.

    Returns
    Type
    Description
    string

    setDisplayName

    Required. The display name of the Audience.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Required. The description of the Audience.

    Returns
    Type
    Description
    string

    setDescription

    Required. The description of the Audience.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMembershipDurationDays

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

    Returns
    Type
    Description
    int

    setMembershipDurationDays

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

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getAdsPersonalizationEnabled

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

    Returns
    Type
    Description
    bool

    setAdsPersonalizationEnabled

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getEventTrigger

    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
    Type
    Description
    AudienceEventTrigger |null

    hasEventTrigger

    clearEventTrigger

    setEventTrigger

    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.

    Parameter
    Name
    Description
    var
    AudienceEventTrigger
    Returns
    Type
    Description
    $this

    getExclusionDurationMode

    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
    Type
    Description
    int

    setExclusionDurationMode

    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.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getFilterClauses

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setFilterClauses

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

    Parameter
    Name
    Description
    var
    array< AudienceFilterClause >
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Time when the Audience was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Time when the Audience was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: