type RuleBasedFirstPartyAudienceSegment (v202405)

Service

AudienceSegmentService

Inheritance

AudienceSegment

▼

FirstPartyAudienceSegment

▼

RuleBasedFirstPartyAudience...

▼

RuleBasedFirstPartyAudience...

A RuleBasedFirstPartyAudienceSegment is a FirstPartyAudienceSegment owned by the publisher network. It contains a rule.

---

Namespace

https://www.google.com/apis/ads/publisher/v202405

Field
AudienceSegment (inherited)
id	xsd:long Id of the AudienceSegment. This attribute is readonly and is populated by Google.
name	xsd:string Name of the AudienceSegment. This attribute is required and has a maximum length of 255 characters.
categoryIds	xsd:long[] The ids of the categories this segment belongs to. This field is optional, it may be empty.
description	xsd:string Description of the AudienceSegment. This attribute is optional and has a maximum length of 8192 characters.
status	AudienceSegment.Status Status of the AudienceSegment. This controls whether the given segment is available for targeting or not. During creation this attribute is optional and defaults to ACTIVE. This attribute is readonly for updates. Enumerations UNKNOWN The value returned if the actual value is not exposed by the requested API version. ACTIVE Active status means this audience segment is available for targeting. INACTIVE Inactive status means this audience segment is not available for targeting. UNUSED Unused status means this audience segment was deactivated by Google because it is unused.
size	xsd:long Number of unique identifiers in the AudienceSegment. This attribute is readonly and is populated by Google.
mobileWebSize	xsd:long Number of unique identifiers in the AudienceSegment for mobile web. This attribute is read-only.
idfaSize	xsd:long Number of unique IDFA identifiers in the AudienceSegment. This attribute is read-only.
adIdSize	xsd:long Number of unique AdID identifiers in the AudienceSegment. This attribute is read-only.
ppidSize	xsd:long Number of unique PPID (publisher provided identifiers) in the AudienceSegment. This attribute is read-only.
dataProvider	AudienceSegmentDataProvider Owner data provider of this segment. This attribute is readonly and is assigned by Google.
type	AudienceSegment.Type Type of the segment. This attribute is readonly and is assigned by Google. Enumerations FIRST_PARTY First party segments created and owned by the publisher. SHARED First party segments shared by other clients. THIRD_PARTY Third party segments licensed by the publisher from data providers. This doesn't include Google-provided licensed segments. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
FirstPartyAudienceSegment (inherited)
RuleBasedFirstPartyAudienceSegmentSummary (inherited)
pageViews	xsd:int Specifies the number of times a user's cookie must match the segment rule before it's associated with the audience segment. This is used in combination with FirstPartyAudienceSegment.recencyDays to determine eligibility of the association. This attribute is required and can be between 1 and 12.
recencyDays	xsd:int Specifies the number of days within which a user's cookie must match the segment rule before it's associated with the audience segment. This is used in combination with FirstPartyAudienceSegment.pageViews to determine eligibility of the association. This attribute is required only if FirstPartyAudienceSegment.pageViews is greater than 1. When required, it can be between 1 and 90.
membershipExpirationDays	xsd:int Specifies the number of days after which a user's cookie will be removed from the audience segment due to inactivity. This attribute is required and can be between 1 and 540.
RuleBasedFirstPartyAudienceSegment
rule	FirstPartyAudienceSegmentRule Specifies the rule of the segment which determines user's eligibility criteria to be part of the segment. This attribute is required.