[docs] Add API documentation and analytics integration example to README

[FentPams]

Description

Added detailed API documentation and integration examples for analytics platforms to the README, making it easier for customers to integrate the experimentation plugin with their analytics solutions.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[ramboz]

❤️ Love it!

[ramboz]

nitpicking: I'd swap them since you list them in the other order below

[ramboz]

Not sure about that one. do we have official docs that has it like that?

[FentPams]

yes => powerful ai search got this https://experienceleague.adobe.com/en/docs/analytics/implementation/vars/functions/tl-method#:~:text=s.tl()%20method%20in,%2C%5BOverride%20variable%5D)%3B

[ramboz]

AppMeasurement.js is the legacy way of doing Analytics instrumentations. Now people rather rely on Launch + AEP WebSDK instead. The Analytics extension is also the "old" way to do that in Launch.

The modern way in WebSDK (alloy.js) would be https://experienceleague.adobe.com/en/docs/analytics/implementation/aep-edge/data-var-mapping, but that doesn't have experimentation support.

I think it would be rather something like:

// Function to track experiment exposure
function trackExperiment(experimentId, variantId, experimentName, variantName) {
  alloy("sendEvent", {
    xdm: {
      eventType: "decisioning.propositionDisplay",
      timestamp: new Date().toISOString(),
      // Tracks at AEP level
      _experience: {
        decisioning: {
          propositions: [{
            id: experimentId,
            scope: "page",
            items: [{
              id: variantId,
              schema: "https://ns.adobe.com/personalization/default-content-item"
            }]
          }],
          propositionEventType: {
            display: 1
          }
        }
      }
    },
    data: {
      // Tracks in custom Analytics mapping
      experiment: {
        id: experimentId,
        name: experimentName,
        variant: {
          id: variantId,
          name: variantName
        },
        timestamp: Date.now()
      }
    }
  });
}