CTA — Sponsor Badge

The LiSA Player generates a message whenever a the sponsor badge in the Live Player is clicked.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard CTA message properties, a Sponsor Badge message includes the following additional properties:

Name	Type	Description
auxiliaryData	AuxiliaryData Required.	The auxiliaryData property is an object that holds additional metadata related to a Call-to-Action. Please refer to AuxiliaryData for detailed information.
ctaType	Literal Required.	sponsor

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name	Type	Description
action	Literal Required.	click ⚠️ Please use messageType instead.
ctaId	Literal Required.	sponsor-badge ⚠️ Please use ctaType instead.
ref	Literal Required.	sponsor-badge ⚠️ Please use ctaType instead.
sponsorId	String Optional.	The sponsorId field represents a unique identifier for a sponsor. This ID can be used by the host app or environment to retrieve detailed sponsorship information. It helps associate sponsored content, branding, or promotions with the relevant sponsor. ⚠️ Please use messageType instead.
sponsorLabel	String Required.	The sponsorLabel field represents the text displayed on the sponsor badge in the Player header. ⚠️ Please use auxiliaryData.sponsorLabel instead.
target	Literal Required.	cta ⚠️ Please use messageType instead.
type	Literal Required.	lsc:cta:click ⚠️ Please use messageType instead.

---

Type Definition

interface CommentCtaMessage extends Omit<
  CtaMessage,
  'auxiliaryData' | 'ctaType'
> {
  auxiliaryData: SponsorCtaAuxiliaryData;
  ctaType: 'sponsor';
}

AuxiliaryData

Name	Type	Description
sponsorId	String Optional.	The sponsorId field represents a unique identifier for a sponsor. This ID can be used by the host app or environment to retrieve detailed sponsorship information. It helps associate sponsored content, branding, or promotions with the relevant sponsor.
sponsorLabel	String Required.	The sponsorLabel field represents the text displayed on the sponsor badge in the Player header.

interface SponsorCtaAuxiliaryData {
  sponsorId?: string;
  sponsorLabel: string;
}

Examples

{
  "clockDriftInMs": 0,
  "auxiliaryData": {
    "sponsorId": "LiSA",
    "sponsorLabel": "Sponsored"
  },
  "ctaType": "sponsor",
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:cta:click",
  "progress": {
    "bufferedTimeInMs": 636036,
    "currentTimeInMs": 619609,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 22761,
    "isLive": true,
    "isPlaying": true,
    "skipTimeInMs": 600000,
    "visitorDwellTimeInMs": 23882
  },
  "sender": "LiSA",

  "action": "click",
  "additional":  {
    "showDate": "2025-01-15T18:00:00.000Z",
    "showId": "9f333331-45cb-4289-8bcd-9023c1871111",
    "showName": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️",
    "showState": "live",
    "showTitle": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️",
    "playing": true,
    "time": 620
  },
  "ctaId": "sponsor-badge",
  "ref": "sponsor-badge",
  "target": "cta",
  "type": "lsc:cta:click"
}