Google Ads Ad Manager V1 Client - Class RuleBasedFirstPartyAudienceSegment (0.14.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class RuleBasedFirstPartyAudienceSegment.

An AudienceSegment owned by the publisher network that contains a rule.

Generated from protobuf message google.ads.admanager.v1.AudienceSegment.RuleBasedFirstPartyAudienceSegment

Namespace

Google \ Ads \ AdManager \ V1 \ AudienceSegment

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ page_views int|string

Required. Number of times a user's cookie must match the rule before it's associated with the AudienceSegment. This is used with recency_days to determine eligibility of the association. This attribute is between 1 and 12.
↳ recency_days int|string

Optional. Number of days within which a user's cookie must match the rule before it's associated with the AudienceSegment. This is used with page_views to determine eligibility of the association. This attribute is required if page_views is greater than 1. When set, it can be between 1 and 30.
↳ membership_expiration_days int|string

Required. Number of days after which a user's cookie will be removed from the AudienceSegment due to inactivity. The field can be between 1 and 540.
↳ rule Rule

Required. The rule definition which determines the eligibility criteria for the AudienceSegment.

getPageViews

Required. Number of times a user's cookie must match the rule before it's associated with the AudienceSegment. This is used with recency_days to determine eligibility of the association. This attribute is between 1 and 12.

Returns
Type Description
int|string

hasPageViews

clearPageViews

setPageViews

Required. Number of times a user's cookie must match the rule before it's associated with the AudienceSegment. This is used with recency_days to determine eligibility of the association. This attribute is between 1 and 12.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getRecencyDays

Optional. Number of days within which a user's cookie must match the rule before it's associated with the AudienceSegment. This is used with page_views to determine eligibility of the association. This attribute is required if page_views is greater than 1. When set, it can be between 1 and 30.

Returns
Type Description
int|string

hasRecencyDays

clearRecencyDays

setRecencyDays

Optional. Number of days within which a user's cookie must match the rule before it's associated with the AudienceSegment. This is used with page_views to determine eligibility of the association. This attribute is required if page_views is greater than 1. When set, it can be between 1 and 30.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getMembershipExpirationDays

Required. Number of days after which a user's cookie will be removed from the AudienceSegment due to inactivity. The field can be between 1 and 540.

Returns
Type Description
int|string

hasMembershipExpirationDays

clearMembershipExpirationDays

setMembershipExpirationDays

Required. Number of days after which a user's cookie will be removed from the AudienceSegment due to inactivity. The field can be between 1 and 540.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getRule

Required. The rule definition which determines the eligibility criteria for the AudienceSegment.

Returns
Type Description
Rule|null

hasRule

clearRule

setRule

Required. The rule definition which determines the eligibility criteria for the AudienceSegment.

Parameter
Name Description
var Rule
Returns
Type Description
$this