image_manager_video

Property Manager name: Image and Video Manager (Videos)
Behavior version: The v2024-05-31 rule format supports the image_manager_video behavior v2.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the Image and Video Manager API. To apply this behavior, you need to match on a file_extension.

Option	Type	Description	Requires
`enabled`	boolean	Applies Image and Video Manager's video optimization to the current content.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`resize`	boolean	When enabled, scales down video for smaller mobile screens, based on the device's `User-Agent` header.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`apply_best_file_type`	boolean	When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`super_cache_region`	enum	To optimize caching, assign a region close to your site's heaviest traffic.	`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	Specifies the CP code for which to track Image and Video Manager video traffic. Use this along with `cp_code_transformed` to track traffic to derivative video content. 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	Specifies the CP code to identify derivative transformed video content. 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	When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific `policy_token` for videos with different match criteria.	`use_existing_policy_set` is `false`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"useExistingPolicySet","op":"eq","value":false}}
`policy_token`	string	Specifies a custom policy defined in the Image and Video Manager Policy Manager or the Image and Video Manager API. The policy name can include up to 64 alphanumeric, dash, or underscore characters.	`advanced` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"advanced","op":"eq","value":true}}
`policy_tokenDefault`	string	Specifies the default policy identifier, which is registered with the Image and Video Manager API once you activate this property.	`advanced` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"advanced","op":"eq","value":false}}

Updated 17 days ago