record_tracking_beacon

Record a playback/ad tracking beacon (IAB/VAST event) for an asset.

record_tracking_beacon

Record a playback/ad tracking beacon (IAB/VAST event) for an asset.

Record a playback tracking beacon (portal session only).

Safety class: B · API type: portal · Min version: —

📘
Confinement
Class B: asset_id must be within your run-root anchor.

Signatures

def record_tracking_beacon(sdk, asset_id, tracking_event, live_channel_id, second, content_id=None):
    """Send a tracking beacon for asset_id at `second`; returns None."""
    return sdk.records_asset_tracking_beacon(asset_id, tracking_event, live_channel_id, content_id, second)

export async function recordTrackingBeacon(sdk, assetId, trackingEvent, liveChannelId, second, contentId = null) {
    // Send a playback tracking beacon (portal session only).
    return await sdk.recordsAssetTrackingBeacon(assetId, trackingEvent, liveChannelId, contentId, second);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`asset_id`	`assetId`	str	yes	e.g. `<asset-uuid>`
`tracking_event`	`trackingEvent`	str	yes	e.g. `Progress`
`live_channel_id`	`liveChannelId`	str	yes	e.g. `<live-channel-uuid>`
`content_id`	`contentId`	str \| None	no
`second`	`second`	int	yes	playback position in seconds

Returns

None — no body; fire-and-forget analytics beacon.

Errors

401 unauthenticated
InvalidAPITypeException on a non-portal session