Configure BreadCrumbs

To add support for BreadCrumbs, you need to apply various settings in a new or existing property configuration.

This is done via Advanced Metadata in your property configuration. You'll need to work with your account representative ("rep") to accomplish this. You can apply two settings during this process:

  • Enable BreadCrumbs. Your account rep will apply the appropriate settings to enable it. All responses to requests will include BreadCrumbs data.
  • You can conditionally "opt-IN" or "opt-OUT" on a per request basis. You can also have your account rep set up the feature to review the request to determine if BreadCrumbs data should be included in the response.
    • opt-OUT. BreadCrumbs data is included in the response. It can be skipped for a specific request if the appropriate "opt-OUT" flag is applied as a query string to the request.
    • opt-IN. BreadCrumbs data is not included in the response. It will only be included if the request includes the appropriate "opt-IN" flag as a query string.

The "opt-IN" and "opt-OUT" query string parameters

If you're incorporating opt-IN or opt-OUT methods, each HTTP(S) request from your player can include a query string parameter to toggle BreadCrumbs data in a response.

Query string parameter opt-IN vs. opt-OUT Is BreadCrumbs data included in response? Description
ak-bc=on opt-IN Yes With this parameter included in the request, set to "on," the response contains BreadCrumbs data provided the following apply:
  • BreadCrumbs has been enabled in the associated property configuration.
  • The associated rule's match criteria has been met for the request.
opt-OUT Yes The "ak-bc=on" parameter and "opt-OUT" set in your property configuration are redundant values.
ak-bc=off opt-IN No With this parameter included in the request, set to "off," the response will not contain BreadCrumbs data.
opt-OUT No The "ak-bc=off" parameter and "opt-OUT" set in your property configuration are redundant values.
None opt-IN No If no parameter is included, the "opt-IN" method responses will not include BreadCrumbs data in all responses. (You need to include the query parameter in a request to "opt-IN" and receive the data.)
opt-OUT Yes If no parameter is included, the "opt-OUT" method includes BreadCrumbs data in all responses. (You need to include the query parameter in a request to "opt-OUT" of receiving the data.)

Why would I "opt-IN" or "opt-OUT?"

You can simply have BreadCrumbs enabled in your property configuration and have it applied for all requests that match your rule criteria. BreadCrumbs includes a specific response header in the response to a requesting player. So, this increases the number of bytes delivered. Plus, a player just may not want (or support) the BreadCrumbs response header. So, you can still have BreadCrumbs enabled and include opt-IN or opt-OUT to let the individual players determine how to handle the responses on a per-request basis.

Are you using an XHR-based player?

If so, ensure that the "Access-Control-Expose-Headers" contains the name of the BreadCrumbs response header.

  1. Click the Default CORS Policy rule.
  2. Locate the Modify Outgoing Response Header entry with its Select Header field set to Acces-Control-Expose-Headers.
  3. Add a comma (,) then input "Akamai-Request-BC" to include this header.


Cache Key Query Parameters considerations

With BreadCrumbs, the player can send query parameters to control the opt-IN or opt-OUT aspects of receiving associated data in the response header. This parameter is not supported for use in the cache key. So, if you’re including the Cache Key Query Parameters behavior, ensure that opt-IN and opt-OUT are left out.