type ThirdPartyAudienceSegment (v202308)

Service

AudienceSegmentService

Inheritance

AudienceSegment

▼

FirstPartyAudienceSegment SharedAudienceSegment ThirdPartyAudienceSegment

A ThirdPartyAudienceSegment is an AudienceSegment owned by a data provider and licensed to the Ad Manager publisher.

---

Namespace

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

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.
ThirdPartyAudienceSegment
approvalStatus	AudienceSegmentApprovalStatus Specifies if the publisher has approved or rejected the segment. Enumerations UNAPPROVED Specifies that this segment is waiting to be approved or rejected. It cannot be targeted. APPROVED Specifies that this segment is approved and can be targeted. REJECTED Specifies that this segment is rejected and cannot be targeted. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
cost	Money Specifies CPM cost for the given segment. This attribute is readonly and is assigned by the data provider. The CPM cost comes from the active pricing, if there is one; otherwise it comes from the latest pricing.
licenseType	LicenseType Specifies the license type of the external segment. This attribute is read-only. Enumerations DIRECT_LICENSE A direct license is the result of a direct contract between the data provider and the publisher. GLOBAL_LICENSE A global license is the result of an agreement between Google and the data provider, which agrees to license their audience segments to all the publishers and/or advertisers of the Google ecosystem. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
startDateTime	DateTime Specifies the date and time at which this segment becomes available for use. This attribute is readonly and is assigned by the data provider.
endDateTime	DateTime Specifies the date and time at which this segment ceases to be available for use. This attribute is readonly and is assigned by the data provider.