audienceSegmentation

Property Manager name: Audience Segmentation Cloudlet
Behavior version: The v2024-10-21 rule format supports the audienceSegmentation behavior v3.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the Cloudlets API.

Option	Type	Description	Requires
`enabled`	boolean	Enables the Audience Segmentation cloudlet feature.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`isSharedPolicy`	boolean	Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in Cloudlets Policy Manager.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`cloudletPolicy`	object	Identifies the Cloudlet policy.	`isSharedPolicy` is `false`	{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"isSharedPolicy","op":"eq","value":false}}
`cloudletPolicy.id`	number	Identifies the Cloudlet.
`cloudletPolicy.name`	string	The Cloudlet's descriptive name.
`cloudletSharedPolicy`	string	This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.	`isSharedPolicy` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"isSharedPolicy","op":"eq","value":true}}
`label`	string	Specifies a suffix to append to the cookie name. This helps distinguish this audience segmentation policy from any others within the same property.		{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`segmentTrackingMethod`	enum	Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.		{"displayType":"enum","options":["IN_QUERY_PARAM","IN_COOKIE_HEADER","IN_CUSTOM_HEADER","NONE"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
		Supported values: IN_COOKIE_HEADER IN_CUSTOM_HEADER IN_QUERY_PARAM NONE
`segmentTrackingQueryParam`	string	This query parameter specifies the name of the segmentation rule.	`segmentTrackingMethod` is `IN_QUERY_PARAM`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"segmentTrackingMethod","op":"eq","value":"IN_QUERY_PARAM"}]}}
`segmentTrackingCookieName`	string	This cookie name specifies the name of the segmentation rule.	`segmentTrackingMethod` is `IN_COOKIE_HEADER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"segmentTrackingMethod","op":"eq","value":"IN_COOKIE_HEADER"}]}}
`segmentTrackingCustomHeader`	string	This custom HTTP header specifies the name of the segmentation rule.	`segmentTrackingMethod` is `IN_CUSTOM_HEADER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"segmentTrackingMethod","op":"eq","value":"IN_CUSTOM_HEADER"}]}}
`populationCookieType`	enum	Specifies when the segmentation cookie expires.		{"displayType":"enum","options":["NEVER","ON_BROWSER_CLOSE","DURATION"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`NEVER`	Never expire.
	`ON_BROWSER_CLOSE`	Expire at end of browser session.
	`DURATION`	Specify a delay.
`populationDuration`	string (duration)	Specifies the lifetime of the segmentation cookie.	`populationCookieType` is `DURATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"DURATION"}]}}
`populationRefresh`	boolean	If disabled, sets the expiration time only if the cookie is not yet present in the request.	`populationCookieType` is `DURATION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"DURATION"}]}}
`specifyPopulationCookieDomain`	boolean	Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`populationCookieDomain`	string	Specifies the domain to track the population cookie.	`specifyPopulationCookieDomain` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"specifyPopulationCookieDomain","op":"eq","value":true}]}}
`populationCookieAutomaticSalt`	boolean	Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`populationCookieSalt`	string	Specifies the cookie's salt value. Use this option to share the cookie across many properties.	`populationCookieAutomaticSalt` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieAutomaticSalt","op":"eq","value":false}]}}
`populationCookieIncludeRuleName`	boolean	When enabled, includes in the session cookie the name of the rule in which this behavior appears.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}