Campaign Design API > Oracle Maxymiser cookies explained

Oracle Maxymiser's Campaign Design API (CD API) sets the following browser cookies:

1st-party cookies

CD API tag (mmapi.js) uses one of the following cookie formats depending on the tag's settings:

  • "cookie" (deprecated) – centralised cookie storage, maintains visitor-specific data in a single JSON tree.

    Note: This storage type can lead to a rare phenomenon when browser cleans up the storage, because two tabs with the tag are opened simultaneously.

    This format provides the following benefits:

    • retains consistency of visitor tracking, i.e. avoid partial data loss leading to discrepancies in reports or user experience
    • decreases the amount of cookies set by Maxymiser on a domain

  • "cookie-key-value" – individual key-value pair produced for every CD API data item. This storage type has been introduced as an alternative for "cookie" storage to resolve:

    • some server-side filters blocking requests with JSON data in headers
    • oversized "cookie" storage size as a result of JSON structure encoding and expiration dates storing
    • potential risk for browser to clean the "cookie" storage due to simultaneous conflicting access to the storage from different tabs
For more information on setting a storage type please review "Configuring the tag" section of Setting up the tag.

"cookie" storage

Examples of decoded cookies:

mmapi.store.p.{partNumber}

Persistent cookie set for a duration of one year from the visitor’s last visit on the site. It contains the generated experience, recorded actions, Maxymiser server node name. Campaign developers may also extend visitor’s profile with custom data captured during the visits to the website.

The list of the items in the cookie:

  • Customer profile information: anonymous visitor id, historical visitor profile (generated experiences and tracked actions).
  • Maxymiser Content Generator service node name.
  • Personalization criteria (custom attributes) - persistent values captured from the site pages with the help of CD API custom scripts (using visitor.storeAttr(); e.g., VisitorType=Customer).
  • Campaign data captured from the site pages using CD API scripting (with the help of campaign.setData(); e.g., MostViewedCategory=Bikes).
  • External visitor ids captured by CD API scripts (using visitor.storeId()).

{partNumber} in the name indicates that the cookie may be split into multiple partitions. Each part contains up to 3000 characters. As soon as mmapi.store.p.0 reaches 3000 characters, a new mmapi.store.p.1 cookie is created to store the next 3000. The expiry period for each cookie is defined individually.

mmapi.store.s.{partNumber}

Session storage set for the duration of the browser session. It stores the same custom data as you may find in mmapi.store.p, but targeted only for the specific visitor's session. Here's the full list:

  • Postponed actions to be passed to the Maxymiser CG service with the following request (usually used to capture successful journey after a link click).
  • Personalization criteria (custom attributes) - session values captured from the site pages with the help of CD API custom scripts (using visitor.storeAttr() with expiry period 0; e.g., loggedIn=yes).
  • Campaign data captured from the site pages using CD API scripting (with the help of campaign.setData() with 0 expiration; e.g., PagesViewed=5)
  • Oracle Maxymiser Utilities to be activated by an authenticated Oracle Maxymiser user (i.e., QA tool, debug tool, etc.)

{partNumber} in the name means that the cookie may have multiple chunks. If a cookie value is longer than 3000 bytes, it is split into parts and saved within the syntax mmapi.store.s.0, then mmapi.store.s.1, etc. – each file containing a maximum of 3000 bytes.

mmcore.tst

Helper cookie to test whether cookies are enabled in visitor's browser.

"cookie-key-value" storage

Example of a decoded value:

mmapi.p.{name}

A set of cookies that stores persistent data with one year lifetime. It may be one of the following names:

  • pd: Customer profile information: anonymous visitor id, historical visitor profile (generated experiences and tracked actions).
  • srv: Maxymiser Content Generator service node name.
  • uat: personalization criteria (custom attributes) - persistent values captured from the site pages with the help of CD API custom scripts (using visitor.storeAttr(); e.g., VisitorType=Customer).
  • ids: external visitor ids captured by CD API scripts (using visitor.storeId()).
  • un: Oracle Maxymiser Utilities to be activated by an authenticated Oracle Maxymiser user (i.e., QA tool, debug tool, etc.)
  • cfgID: testing environment, activated only for an authenticated Oracle Maxymiser user (i.e., Sandbox or Production)

mmapi.d.{name}

Dynamically placed data that supports CD API methods functioning:

  • uv: postponed actions to be passed to the Maxymiser CG service with the following request (usually used to capture successful journey after a link click).

mmapi.e.{name} and mmapi.{name}

Campaign data captured from the site pages using CD API scripts (with the help of campaign.setData(), visitor.setData(), etc.; e.g., MostViewedCategory=Bikes).

3rd-party cookies

These cookies are not set by default. They may be enabled by either Oracle Maxymiser for cross-domain testing ("pd" and "tpv", legal restrictions may apply to this functionality) or by a visitor ("optout", set on the Opt Out Status page) for turning off Maxymiser testing:

maxymiser.optout

Determines whether a visitor should be excluded from Maxymiser testing.

maxymiser.pd

Customer profile information: anonymous visitor id, historical visitor profile (generated experiences, tracked actions).

maxymiser.tpv

Advertisement id passed from an external Ad provider, to be used for content personalization. The value is set by Maxymiser tracking pixel that on ad view.

Obsolete cookies

These cookies existed for campaigns built with CD API's predecessor library - mmcore.

mmid

Anonymous visitor id

mmcore.{name}

Visitor identification info, Content Generator service node name, postponed actions, personalization criteria, CRM visitor id, etc. (depends on the custom implementation)

mmpa.{name}

Product recommendations: ratings, views and history.

mm_{name}

Custom cookies created in Maxymiser Campaigns as part of testing (e.g., StayLength=8)