GuideReference
TrainingSupportCommunity

audience_​segmentation


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.

OptionTypeDescriptionRequires
enabledboolean

Enables the Audience Segmentation cloudlet feature.

{"displayType":"boolean","tag":"input","type":"checkbox"}
is_​shared_​policyboolean

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}}
cloudlet_​policyobject

Identifies the Cloudlet policy.

is_​shared_​policy is false
{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"isSharedPolicy","op":"eq","value":false}}
cloudlet_​policy.idnumber

Identifies the Cloudlet.

cloudlet_​policy.namestring

The Cloudlet's descriptive name.

cloudlet_​shared_​policystring

This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the Cloudlets API.

is_​shared_​policy is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"isSharedPolicy","op":"eq","value":true}}
labelstring

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}}
segment_​tracking_​methodenum

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
segment_​tracking_​query_​paramstring

This query parameter specifies the name of the segmentation rule.

segment_​tracking_​method 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"}]}}
segment_​tracking_​custom_​headerstring

This custom HTTP header specifies the name of the segmentation rule.

segment_​tracking_​method 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"}]}}
NEVER

Never expire.

ON_​BROWSER_​CLOSE

Expire at end of browser session.

DURATION

Specify a delay.

population_​durationstring (duration)

Specifies the lifetime of the segmentation cookie.

population_​cookie_​type is DURATION
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"DURATION"}]}}
population_​refreshboolean

If disabled, sets the expiration time only if the cookie is not yet present in the request.

population_​cookie_​type is DURATION
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"DURATION"}]}}