Reference documentation and code samples for the Google Analytics Admin V1alpha Client class Audience.
A resource message representing a GA4 Audience.
Generated from protobuf message google.analytics.admin.v1alpha.Audience
Methods
__construct
Constructor.
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
Google\Analytics\Admin\V1alpha\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< Google\Analytics\Admin\V1alpha\AudienceFilterClause
>
Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed together.
getName
Output only. The resource name for this Audience resource.
Format: properties/{propertyId}/audiences/{audienceId}
string
setName
Output only. The resource name for this Audience resource.
Format: properties/{propertyId}/audiences/{audienceId}
var
string
$this
getDisplayName
Required. The display name of the Audience.
string
setDisplayName
Required. The display name of the Audience.
var
string
$this
getDescription
Required. The description of the Audience.
string
setDescription
Required. The description of the Audience.
var
string
$this
getMembershipDurationDays
Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
int
setMembershipDurationDays
Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
var
int
$this
getAdsPersonalizationEnabled
Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
bool
setAdsPersonalizationEnabled
Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
var
bool
$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.
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.
$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.
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.
var
int
$this
getFilterClauses
Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed together.
setFilterClauses
Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed together.
$this
