Skip to content

✨ [Story analytics] Add caption state analytics events #40505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
michaeldegori wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

✨ [Story analytics] Add caption state analytics events #40505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1a9996
✨ [Story analytics] Add caption state analytics events
michaeldegori May 13, 2026
5877087
✅ [Story analytics] Test captions analytics dispatch
michaeldegori May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions extensions/amp-story/1.0/amp-story.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,20 @@ export class AmpStory extends AMP.BaseElement {
false /** callToInitialize */
);

this.storeService_.subscribe(
StateProperty.CAPTIONS_STATE,
(captionsState) => {
// We do not want to trigger an analytics event for the initialization of
// the captions state.
this.analyticsService_.triggerEvent(
captionsState
? StoryAnalyticsEvent.STORY_CAPTIONS_ON
: StoryAnalyticsEvent.STORY_CAPTIONS_OFF
);
},
false /** callToInitialize */
);

this.storeService_.subscribe(StateProperty.ADVANCEMENT_MODE, (mode) => {
this.variableService_.onVariableUpdate(
AnalyticsVariable.STORY_ADVANCEMENT_MODE,
Expand Down
2 changes: 2 additions & 0 deletions extensions/amp-story/1.0/story-analytics.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ export const StoryAnalyticsEvent = {
STORY_CONTENT_LOADED: 'story-content-loaded',
STORY_MUTED: 'story-audio-muted',
STORY_UNMUTED: 'story-audio-unmuted',
STORY_CAPTIONS_ON: 'story-captions-on',
STORY_CAPTIONS_OFF: 'story-captions-off',
SHOPPING_BUY_NOW_CLICK: 'story-shopping-buy-now-click',
SHOPPING_PLP_VIEW: 'story-shopping-plp-view',
SHOPPING_PDP_VIEW: 'story-shopping-pdp-view',
Expand Down
23 changes: 22 additions & 1 deletion extensions/amp-story/1.0/test/test-amp-story.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import {
} from '../amp-story-store-service';
import {EventType, dispatch} from '../events';
import {MediaType_Enum} from '../media-pool';
import {AdvancementMode} from '../story-analytics';
import {AdvancementMode, StoryAnalyticsEvent} from '../story-analytics';
import * as utils from '../utils';

// Represents the correct value of KeyboardEvent.which for the Right Arrow
Expand Down Expand Up @@ -995,6 +995,27 @@ describes.realWin(
expect(story.element.hasAttribute('muted')).to.be.true;
});

it('should trigger analytics event on captions toggle', async () => {
await createStoryWithPages(2, ['cover', 'page-1']);

const triggerSpy = env.sandbox.spy(
story.analyticsService_,
'triggerEvent'
);

await story.layoutCallback();

story.storeService_.dispatch(Action.TOGGLE_CAPTIONS, false);
expect(triggerSpy).to.have.been.calledWith(
StoryAnalyticsEvent.STORY_CAPTIONS_OFF
);

story.storeService_.dispatch(Action.TOGGLE_CAPTIONS, true);
expect(triggerSpy).to.have.been.calledWith(
StoryAnalyticsEvent.STORY_CAPTIONS_ON
);
});

describe('#getMaxMediaElementCounts', () => {
it('should create 2 audio & video elements when no elements found', async () => {
await createStoryWithPages(2, ['cover', 'page-1']);
Expand Down
8 changes: 8 additions & 0 deletions extensions/amp-story/amp-story-analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,14 @@ The `story-audio-muted` trigger is fired when the user initiates an interaction

The `story-audio-unmuted` trigger is fired when the user initiates an interaction to unmute the audio for the current story.

### Captions on trigger (`"on": "story-captions-on"`)

The `story-captions-on` trigger is fired when the user initiates an interaction to turn captions on for the current story.

### Captions off trigger (`"on": "story-captions-off"`)

The `story-captions-off` trigger is fired when the user initiates an interaction to turn captions off for the current story.

### Page attachment enter trigger (`"on": "story-page-attachment-enter"`)

The `story-page-attachment-enter` trigger is fired when a page attachment is opened by the user.
Expand Down