audienceSegmentation


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"}]}}