adScalerCircuitBreaker


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 ad‚ÄčScaler‚ÄčCircuit‚ÄčBreaker behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object.

OptionTypeDescriptionRequires
response‚ÄčDelay‚ÄčBasedboolean

Triggers a fallback action based on the delayed response from the technology partner's server.

{"displayType":"boolean","tag":"input","type":"checkbox"}
response‚ÄčDelay‚ÄčThresholdenum

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‚ÄčBasedboolean

Triggers a fallback action based on the response code from the technology partner's server.

{"displayType":"boolean","tag":"input","type":"checkbox"}
response‚ÄčCodesstring

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‚ÄčBasedenum

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‚ÄčBasedenum

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‚ÄčBasedstring

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