imageManager


Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the Image and Video Manager API. To apply this behavior, you need to match on a file‚ÄčExtension. Once you apply Image and Video Manager to traffic, you can add the advanced‚ÄčIm‚ÄčMatch to ensure the behavior applies to the requests from the Image and Video Manager backend.

OptionTypeDescriptionRequires
enabledboolean

Enable image management capabilities and generate a corresponding API token.

{"displayType":"boolean","tag":"input","type":"checkbox"}
resizeboolean

Specify whether to scale down images to the maximum screen resolution, as determined by the rendering device's user agent. Note that enabling this may affect screen layout in unexpected ways.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
apply‚ÄčBest‚ÄčFile‚ÄčTypeboolean

Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
super‚ÄčCache‚ÄčRegionenum

Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.

use‚ÄčExisting‚ÄčPolicy‚ÄčSet is not true
{"displayType":"enum","options":["US","ASIA","AUSTRALIA","EMEA","JAPAN","CHINA"],"tag":"select"}
{"if":{"attribute":"useExistingPolicySet","op":"neq","value":true}}
US

United States.

ASIA

Asia.

AUSTRALIA

Australia.

EMEA

Europe, Middle East, and Africa.

JAPAN

Japan.

CHINA

China.

cp‚ÄčCode‚ÄčOriginalobject

Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified.

{"displayType":"object","tag":"input","todo":true}
cp‚ÄčCode‚ÄčOriginal.descriptionstring

Additional description for the CP code.

cp‚ÄčCode‚ÄčOriginal.idinteger

Unique identifier for each CP code.

cp‚ÄčCode‚ÄčOriginal.namestring

The name of the CP code.

cp‚ÄčCode‚ÄčOriginal.productsarray

The set of products the CP code is assigned to.

cp‚ÄčCode‚ÄčTransformedobject

Assigns a separate CP code to track traffic and billing for derived images.

{"displayType":"object","tag":"input","todo":true}
cp‚ÄčCode‚ÄčTransformed.descriptionstring

Additional description for the CP code.

cp‚ÄčCode‚ÄčTransformed.idinteger

Unique identifier for each CP code.

cp‚ÄčCode‚ÄčTransformed.namestring

The name of the CP code.

cp‚ÄčCode‚ÄčTransformed.productsarray

The set of products the CP code is assigned to.

use‚ÄčExisting‚ÄčPolicy‚ÄčSetboolean

Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.

{"displayType":"boolean","tag":"input","type":"checkbox"}
policy‚ÄčSetobject

Identifies the existing policy set configured with Image and Video Manager API.

use‚ÄčExisting‚ÄčPolicy‚ÄčSet is true
{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"useExistingPolicySet","op":"eq","value":true}}
advancedboolean

Generates a custom Image and Video Manager API token to apply a corresponding policy to this set of images. The token consists of a descriptive label (the policy‚ÄčToken) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property.

use‚ÄčExisting‚ÄčPolicy‚ÄčSet is false
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"useExistingPolicySet","op":"eq","value":false}}
policy‚ÄčTokenstring

Assign a prefix label to help match the policy token to this set of images, limited to 32 alphanumeric or underscore characters. If you don't specify a label, default becomes the prefix.

advanced is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"advanced","op":"eq","value":true}]}}
policy‚ÄčToken‚ÄčDefaultstring

Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.

advanced is false
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"advanced","op":"eq","value":false}]}}