GuideReference
TrainingSupportCommunity

image_​manager


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. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

{"displayType":"object","tag":"input","todo":true}
cp_​code_​original.cp​Code​Limitsarray

Read-only. Describes the current usage limit for the CP code.

cp_​code_​original.created​Dateinteger

Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.

cp_​code_​original.descriptionstring

Read-only. Additional description for the CP code.

cp_​code_​original.idinteger

Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a cpcode​Id value from the List CP codes operation.

cp_​code_​original.namestring

Read-only. The name of the CP code you specify as the cpcode​Name when creating a new CP code in PAPI. You can modify this value with the PUT operation in the CP codes and Reporting Groups API.

cp_​code_​original.productsarray

Read-only. The set of products the CP code is assigned to. This reflects product​Id values you specify when creating a new CP code in PAPI.

cp_​code_​transformedobject

Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.

{"displayType":"object","tag":"input","todo":true}
cp_​code_​transformed.cp​Code​Limitsarray

Read-only. Describes the current usage limit for the CP code.

cp_​code_​transformed.created​Dateinteger

Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.

cp_​code_​transformed.descriptionstring

Read-only. Additional description for the CP code.

cp_​code_​transformed.idinteger

Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a cpcode​Id value from the List CP codes operation.

cp_​code_​transformed.namestring

Read-only. The name of the CP code you specify as the cpcode​Name when creating a new CP code in PAPI. You can modify this value with the PUT operation in the CP codes and Reporting Groups API.

cp_​code_​transformed.productsarray

Read-only. The set of products the CP code is assigned to. This reflects product​Id values you specify when creating a new CP code in PAPI.

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