ad scaler circuit

Property Manager name: Ad Scaler Circuit Breaker
Behavior version: The v2024-02-12 rule format supports the ad_scaler_circuit_breaker behavior v1.2.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

This behavior works with manifest_rerouting to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. The adScalerCircuitBreaker behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object.

Option	Type	Description	Requires
`response_delay_based`	boolean	Triggers a fallback action based on the delayed response from the technology partner's server.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`response_delay_threshold`	enum	Specifies the maximum response delay that, if exceeded, triggers the fallback action.	`response_delay_based` is `true`	{"displayType":"enum","options":["500ms"],"tag":"select"} {"if":{"attribute":"responseDelayBased","op":"eq","value":true}}
		Supported values: 500ms
`response_code_based`	boolean	Triggers a fallback action based on the response code from the technology partner's server.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`response_codes`	string	Specifies the codes in the partner's response that trigger the fallback action, either `408`, `500`, `502`, `504`, `SAME_AS_RECEIEVED`, or `SPECIFY_YOUR_OWN` for a custom code.	`response_code_based` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"responseCodeBased","op":"eq","value":true}}
`fallback_action_response_code_based`	enum	Specifies the fallback action.	`response_delay_based` is `true` OR `response_code_based` is `true`	{"displayType":"enum","options":["RETURN_AKAMAI_COPY","RETURN_ERROR"],"tag":"select"} {"if":{"op":"or","params":[{"attribute":"responseDelayBased","op":"eq","value":true},{"attribute":"responseCodeBased","op":"eq","value":true}]}}
	`RETURN_AKAMAI_COPY`	Return an unmodified Akamai copy of the manifest file to the requesting client.
	`RETURN_ERROR`	Return an error as the server response.
`return_error_response_code_based`	enum	Specifies the error to include in the response to the client.	`fallback_action_response_code_based` is `RETURN_ERROR`	{"displayType":"enum","options":["SAME_AS_RECEIVED","408","500","502","504","SPECIFY_YOUR_OWN"],"tag":"select"} {"if":{"attribute":"fallbackActionResponseCodeBased","op":"eq","value":"RETURN_ERROR"}}
	`SAME_AS_RECEIVED`	Return the same error received from the partner platform.
	`408`	Return a 408 error.
	`500`	Return a 500 error.
	`502`	Return a 502 error.
	`504`	Return a 504 error.
	`SPECIFY_YOUR_OWN`	Customize the error.
`specify_your_own_response_code_based`	string	Defines a custom error response.	`return_error_response_code_based` is `SPECIFY_YOUR_OWN`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"returnErrorResponseCodeBased","op":"eq","value":"SPECIFY_YOUR_OWN"}}