image_manager

Property Manager name: Image and Video Manager (Images)
Behavior version: The v2024-10-21 rule format supports the image_manager 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 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.

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}}
`apply_best_file_type`	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}}
`super_cache_region`	enum	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_original`	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 `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.cpCodeLimits`	array	Read-only. Describes the current usage limit for the CP code.
`cp_code_original.createdDate`	integer	Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.
`cp_code_original.description`	string	Read-only. Additional description for the CP code.
`cp_code_original.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 `cpcodeId` value from the List CP codes operation.
`cp_code_original.name`	string	Read-only. The name of the CP code you specify as the `cpcodeName` 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.products`	array	Read-only. The set of products the CP code is assigned to. This reflects `productId` values you specify when creating a new CP code in PAPI.
`cp_code_transformed`	object	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.cpCodeLimits`	array	Read-only. Describes the current usage limit for the CP code.
`cp_code_transformed.createdDate`	integer	Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.
`cp_code_transformed.description`	string	Read-only. Additional description for the CP code.
`cp_code_transformed.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 `cpcodeId` value from the List CP codes operation.
`cp_code_transformed.name`	string	Read-only. The name of the CP code you specify as the `cpcodeName` 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.products`	array	Read-only. The set of products the CP code is assigned to. This reflects `productId` values you specify when creating a new CP code in PAPI.
`use_existing_policy_set`	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"}
`policy_set`	object	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}}
`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 `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_token`	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}]}}
`policy_tokenDefault`	string	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}]}}

Updated 17 days ago