GuideReference
TrainingSupportCommunity

im_​override


This specifies common query parameters that affect how image​_manager transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property's rule tree variables to one of Image and Video Manager's own policy variables.

OptionTypeDescriptionRequires
overrideenum

Selects the type of query parameter you want to set.

{"displayType":"enum","options":["POLICY","POLICY_VARIABLE","WIDTH","FORMAT","DPR","EXCLUDE_QUERY"],"tag":"select"}
POLICY

For the name of the Image and Video Manager policy you want to apply.

POLICY_​VARIABLE

Specify that you want to set an Image and Video Manager policy variable from a rule tree variable defined in the property.

WIDTH

A predefined width to constrain the image to.

FORMAT

For browser types.

DPR

For pixel density.

EXCLUDE_​QUERY

Excludes the specified query parameters from the cache key.

typeselenum

Specifies how to set a query parameter.

override is not POLICY_​VARIABLE
AND override is not EXCLUDE_​QUERY
{"displayType":"enum","options":["VALUE","VARIABLE"],"tag":"select"}
{"if":{"op":"and","params":[{"attribute":"override","op":"neq","value":"POLICY_VARIABLE"},{"attribute":"override","op":"neq","value":"EXCLUDE_QUERY"}]}}
VALUE

Assign a specific value.

VARIABLE

Assign a Property Manager rule tree VARIABLE.

formatvarstring (variable name)

This selects the variable with the name of the browser you want to optimize images for. The variable specifies the same type of data as the format option below.

override is FORMAT
AND typesel is VARIABLE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"FORMAT"},{"attribute":"typesel","op":"eq","value":"VARIABLE"}]}}
formatenum

Specifies the type of the browser, or the encodings passed in the Accept header, that you want to optimize images for.

override is FORMAT
AND typesel is VALUE
{"displayType":"enum","options":["CHROME","IE","SAFARI","GENERIC","AVIF_WEBP_JPEG_PNG_GIF","JP2_WEBP_JPEG_PNG_GIF","WEBP_JPEG_PNG_GIF","JPEG_PNG_GIF"],"tag":"select"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"FORMAT"},{"attribute":"typesel","op":"eq","value":"VALUE"}]}}
CHROME

Google Chrome.

IE

Internet Explorer.

SAFARI

Apple Safari.

GENERIC

Generic.

AVIF_​WEBP_​JPEG_​PNG_​GIF

Best of AVIF, Web​P, JPEG, PNG, and GIF.

JP2_WEBP_​JPEG_​PNG_​GIF

Best of JP2, Web​P, JPEG, PNG, and GIF.

WEBP_​JPEG_​PNG_​GIF

Best of Web​P, JPEG, PNG, and GIF.

JPEG_​PNG_​GIF

Best of JPEG, PNG, GIF.

dprvarstring (variable name)

This selects the variable with the desired pixel density. The variable specifies the same type of data as the dpr option below.

override is DPR
AND typesel is VARIABLE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"DPR"},{"attribute":"typesel","op":"eq","value":"VARIABLE"}]}}
dprnumber

Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.

override is DPR
AND typesel is VALUE
{"displayType":"number","tag":"input","type":"number"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"DPR"},{"attribute":"typesel","op":"eq","value":"VALUE"}]}}
widthvarstring (variable name)

Selects the variable with the desired width. If the Image and Video Manager policy doesn't define that width, it serves the next largest width.

override is WIDTH
AND typesel is VARIABLE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"WIDTH"},{"attribute":"typesel","op":"eq","value":"VARIABLE"}]}}
widthnumber

Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.

override is WIDTH
AND typesel is VALUE
{"displayType":"number","tag":"input","type":"number"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"WIDTH"},{"attribute":"typesel","op":"eq","value":"VALUE"}]}}
policyvarstring (variable name)

This selects the variable with the desired Image and Video Manager policy name to apply to image requests. If there is no policy by that name, Image and Video Manager serves the image unmodified.

override is POLICY
AND typesel is VARIABLE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"POLICY"},{"attribute":"typesel","op":"eq","value":"VARIABLE"}]}}
policystring

This selects the desired Image and Video Manager policy name directly. If there is no policy by that name, Image and Video Manager serves the image unmodified.

override is POLICY
AND typesel is VALUE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"POLICY"},{"attribute":"typesel","op":"eq","value":"VALUE"}]}}
policyvar_​namestring

This selects the name of one of the variables defined in an Image and Video Manager policy that you want to replace with the property's rule tree variable.

override is POLICY_​VARIABLE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"override","op":"eq","value":"POLICY_VARIABLE"}}
policyvar_​i_​mvarstring (variable name)

This selects one of the property's rule tree variables to assign to the policyvar_​name variable within Image and Video Manager.

override is POLICY_​VARIABLE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"override","op":"eq","value":"POLICY_VARIABLE"}}
exclude_​all_​query_​parametersboolean

Whether to exclude all query parameters from the Image and Video Manager cache key.

override is EXCLUDE_​QUERY
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"override","op":"eq","value":"EXCLUDE_QUERY"}}
excluded_​query_​parametersstring array

Specifies individual query parameters to exclude from the Image and Video Manager cache key.

override is EXCLUDE_​QUERY
AND exclude_​all_​query_​parameters is false
{"displayType":"string array","tag":"input","todo":true}
{"if":{"op":"and","params":[{"attribute":"override","op":"eq","value":"EXCLUDE_QUERY"},{"attribute":"excludeAllQueryParameters","op":"eq","value":false}]}}