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.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringOutput only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} |
↳ display_name | stringRequired. The display name of the Audience. |
↳ description | stringRequired. The description of the Audience. |
↳ membership_duration_days | intRequired. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. |
↳ ads_personalization_enabled | boolOutput 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\AudienceEventTriggerOptional. 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 | intImmutable. 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}
| 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 |
Google\Analytics\Admin\V1alpha\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 | Google\Analytics\Admin\V1alpha\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. null Filter clauses that define the Audience. All clauses will be AND’ed together.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFilterClauses
Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed together.
| Parameter | |
|---|---|
| Name | Description |
var | array<Google\Analytics\Admin\V1alpha\AudienceFilterClause> |
| Returns | |
|---|---|
| Type | Description |
$this | |