Looking for a REST API? The Ad Manager API (Beta) is now available.

type FirstPartyAudienceSegmentRule (v202411)

AI-generated Key Takeaways

RuleBasedFirstPartyAudienceSegment rules define user eligibility criteria for a segment.
The inventoryRule field specifies the required inventory (ad units and placements) for a rule.
The customCriteriaRule field specifies the collection of custom criteria for a rule, which has a structured hierarchy of logical operators and criteria objects.

Service

AudienceSegmentService

Dependencies

RuleBasedFirstPartyAudience...

▼

FirstPartyAudienceSegmentRule

Rule of a FirstPartyAudienceSegment that defines user's eligibility criteria to be part of a segment.

Namespace: https://www.google.com/apis/ads/publisher/v202411

Field
`inventoryRule`	`InventoryTargeting` Specifies the inventory (i.e. ad units and placements) that are part of the rule of a FirstPartyAudienceSegment. This attribute is required.
`customCriteriaRule`	`CustomCriteriaSet` Specifies the collection of custom criteria that are part of the rule of a FirstPartyAudienceSegment. Once the FirstPartyAudienceSegment is updated or modified with custom criteria, the server may return a normalized, but equivalent representation of the custom criteria rule. `customCriteriaRule`will have up to three levels including itself. The top level CustomCriteriaSet i.e. the `customTargeting` object can only contain a CustomCriteriaSet.LogicalOperator.OR of all its children. The second level of CustomCriteriaSet objects can only contain CustomCriteriaSet.LogicalOperator.AND of all their children. If a CustomCriteria is placed on this level, the server will wrap it in a CustomCriteriaSet. The third level can only comprise of CustomCriteria objects. The resulting custom criteria rule would be of the form:

Field

`inventoryRule`

InventoryTargeting

Specifies the inventory (i.e. ad units and placements) that are part of the rule of a FirstPartyAudienceSegment. This attribute is required.

`customCriteriaRule`

CustomCriteriaSet

Specifies the collection of custom criteria that are part of the rule of a FirstPartyAudienceSegment.

Once the FirstPartyAudienceSegment is updated or modified with custom criteria, the server may return a normalized, but equivalent representation of the custom criteria rule.

customCriteriaRule

The top level CustomCriteriaSet i.e. the customTargeting object can only contain a CustomCriteriaSet.LogicalOperator.OR of all its children.
The second level of CustomCriteriaSet objects can only contain CustomCriteriaSet.LogicalOperator.AND of all their children. If a CustomCriteria is placed on this level, the server will wrap it in a CustomCriteriaSet.
The third level can only comprise of CustomCriteria objects.

The resulting custom criteria rule would be of the form:

type FirstPartyAudienceSegmentRule (v202411) Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Field

inventoryRule

customCriteriaRule

type FirstPartyAudienceSegmentRule (v202411)

`inventoryRule`

`customCriteriaRule`