query_string_parameter

Property Manager name: Query String Parameter
Criteria version: The v2024-05-31 rule format supports the query_string_parameter criteria v1.1.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Matches query string field names or values.

Option	Type	Description	Requires
`parameter_name`	string	The name of the query field, for example, `q` in `?q=string`.		{"displayType":"string","tag":"input","type":"text"}
`match_operator`	enum	Narrows the match criteria.		{"displayType":"enum","options":["IS_ONE_OF","IS_NOT_ONE_OF","EXISTS","DOES_NOT_EXIST","IS_LESS_THAN","IS_MORE_THAN","IS_BETWEEN"],"tag":"select"}
	`IS_ONE_OF`	Tests whether the field's `value` string matches.
	`IS_NOT_ONE_OF`	Tests whether the field's `value` string does not match.
	`EXISTS`	Whether the query field's `parameter_name` is present in the requesting URL.
	`DOES_NOT_EXIST`	Whether the query field's `parameter_name` is absent from the requesting URL.
	`IS_LESS_THAN`	Matches a range when the `value` is numeric.
	`IS_MORE_THAN`	Matches a range when the `value` is numeric.
	`IS_BETWEEN`	Is between the numeric `lower_bound` and `upper_bound` values.
`values`	string array	The value of the query field, for example, `string` in `?q=string`.	`match_operator` is either: `IS_ONE_OF`, `IS_NOT_ONE_OF`	{"displayType":"string array","tag":"input","todo":true} {"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
`lower_bound`	number	Specifies the match's minimum value.	`match_operator` is either: `IS_MORE_THAN`, `IS_BETWEEN`	{"displayType":"number","tag":"input","type":"number"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_MORE_THAN","IS_BETWEEN"]}}
`upper_bound`	number	When the `value` is numeric, this field specifies the match's maximum value.	`match_operator` is either: `IS_LESS_THAN`, `IS_BETWEEN`	{"displayType":"number","tag":"input","type":"number"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_LESS_THAN","IS_BETWEEN"]}}
`match_wildcard_name`	boolean	Allows wildcards in the `parameter_name` field, where `?` matches a single character and `*` matches zero or more characters.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`match_case_sensitive_name`	boolean	Sets a case-sensitive match for the `parameter_name` field.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`match_wildcard_value`	boolean	Allows wildcards in the `value` field, where `?` matches a single character and `*` matches zero or more characters.	`match_operator` is either: `IS_ONE_OF`, `IS_NOT_ONE_OF`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
`match_case_sensitive_value`	boolean	Sets a case-sensitive match for the `value` field.	`match_operator` is either: `IS_ONE_OF`, `IS_NOT_ONE_OF`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
`escape_value`	boolean	Matches when the `value` is URL-escaped.	`match_operator` is either: `IS_ONE_OF`, `IS_NOT_ONE_OF`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}

Updated 17 days ago