- Property Manager name: Image and Video Manager (Images)
- Behavior version: The
v2024-08-13
rule format supports theimageManager
behavior v2.0. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: Yes
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 fileExtension
. Once you apply Image and Video Manager to traffic, you can add the advancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend.
Option | Type | Description | Requires | |
---|---|---|---|---|
enabled | boolean | Enable image management capabilities and generate a corresponding API token. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
resize | boolean | 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}} | |
applyBestFileType | boolean | 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}} | |
superCacheRegion | enum | Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers. | useExistingPolicySet 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. | |||
cpCodeOriginal | object | 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 | {"displayType":"object","tag":"input","todo":true} | |
cpCodeOriginal.cpCodeLimits | array | Read-only. Describes the current usage limit for the CP code. | ||
cpCodeOriginal.createdDate | integer | Read-only. UNIX epoch timestamp reflecting when the CP code was originally created. | ||
cpCodeOriginal.description | string | Read-only. Additional description for the CP code. | ||
cpCodeOriginal.id | integer | Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a | ||
cpCodeOriginal.name | string | Read-only. The name of the CP code you specify as the | ||
cpCodeOriginal.products | array | Read-only. The set of products the CP code is assigned to. This reflects | ||
cpCodeTransformed | object | Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial | {"displayType":"object","tag":"input","todo":true} | |
cpCodeTransformed.cpCodeLimits | array | Read-only. Describes the current usage limit for the CP code. | ||
cpCodeTransformed.createdDate | integer | Read-only. UNIX epoch timestamp reflecting when the CP code was originally created. | ||
cpCodeTransformed.description | string | Read-only. Additional description for the CP code. | ||
cpCodeTransformed.id | integer | Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a | ||
cpCodeTransformed.name | string | Read-only. The name of the CP code you specify as the | ||
cpCodeTransformed.products | array | Read-only. The set of products the CP code is assigned to. This reflects | ||
useExistingPolicySet | boolean | 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"} | |
policySet | object | Identifies the existing policy set configured with Image and Video Manager API. | useExistingPolicySet is true | {"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"useExistingPolicySet","op":"eq","value":true}} |
advanced | boolean | 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 | useExistingPolicySet is false | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"useExistingPolicySet","op":"eq","value":false}} |
policyToken | string | 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}]}} |
policyTokenDefault | string | Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The | advanced is false | {"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"advanced","op":"eq","value":false}]}} |