本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
函数生命周期挂钩
生命周期挂钩定义了在播放期间何时 MediaTailor 运行您的函数。此页面是输入字段、输出命名空间以及管理每个挂钩数据流的规则的完整参考。
概述
MediaTailor 支持四个生命周期挂钩：
-
PRE_SESSION_INITIALIZATION当查看者启动新会话时触发一次。将其用于一次性设置工作，例如获取受众细分。此时，还没有出现广告插播时间，因此广告插播背景不可用。 -
PRE_ADS_REQUEST在每个广告决策服务器 (ADS) 请求之前触发——直播中每个广告插播时段触发一次。使用它来使用定位数据自定义 ADS 请求、修改 ADS 网址或添加标题。 -
POST_ADS_RESPONSE在 MediaTailor 接收和解析广告响应（包括视频广告投放模板 (VAST) 包装器重定向的解析）后触发。在 MediaTailor 选择要插入的广告之前，使用它来筛选、重新排序、修改或补充广告返回的广告。 -
PRE_MANIFEST_INSERTION在广告插播个性化设置结束时触发，在广告选择、转码检查和填写政策之后，紧接着将广告 MediaTailor 写入清单中。使用它来检查或修改最终的广告集，包括在填充不足的广告插播栏中注入更多广告。
挂钩的时间和范围不同。PRE_SESSION_INITIALIZATION运行一次并设置在整个会话中持续存在的数据。PRE_ADS_REQUEST然后绕POST_ADS_RESPONSE过每次 ADS 互动。PRE_ADS_REQUEST塑造传出的请求，并在选择广告之前对解析后的响应POST_ADS_RESPONSE采取行动。PRE_MANIFEST_INSERTION在选择完成后运行，一次调用即可查看所有新增个性化广告插播时段的最终广告设置。
重要
对于单个请求POST_ADS_RESPONSE，PRE_ADS_REQUEST、和PRE_MANIFEST_INSERTION挂钩的总执行预算为 2,000 毫秒。此预算是对每个挂钩自己的 2,000 毫秒超时时间之外的补充。挂钩的有效超时时间是其自身超时时间和剩余预算中的较小值。较早的挂接所花费的时间减少了同一请求中可供后期挂钩使用的时间。如果剩余预算在挂钩开始之前用尽，则 MediaTailor 跳过该挂钩，在没有挂钩的情况下继续处理请求。PRE_SESSION_INITIALIZATION在会话初始化期间运行，不属于合并预算。有关更多信息，请参阅 限制。
注意
在本文档中，广告插播也称为无济于事。输入字段名称（例如avail.availId和avails.avails）和 CloudWatch 指标使用表avail单。
输入字段参考
下表列出了每个生命周期挂钩中可用的输入字段。在字段列中，parent[].child表示法表示parent数组中每个元素的字段。
注意
POST_ADS_RESPONSE和PRE_MANIFEST_INSERTION挂钩在 camelCase 中显示会话字段（例如，session.clientIp），而前两个挂钩使用 snake_case（例如，）。session.client_ip玩家参数可通过player_params命名空间在前两个挂钩处获得，在另外两个挂钩处作为session.playerParams对象可用。
| 字段 | Type | 会话前初始化 | PRE_ADS_REQUEST | POST_ADS_RESPONSE | 预清单插入 |
|---|---|---|---|---|---|
session.id | 长整型 | ✓ | ✓ | ✓ | ✓ |
session.uuid | 字符串 | ✓ | ✓ | ✓ | ✓ |
session.client_ip | 字符串 | ✓ | ✓ | ✗ | ✗ |
session.clientIp | 字符串 | ✗ | ✗ | ✓ | ✓ |
session.user_agent | 字符串 | ✓ | ✓ | ✗ | ✗ |
session.userAgent | 字符串 | ✗ | ✗ | ✓ | ✓ |
session.referer* | 字符串 | ✓ | ✓ | ✗ | ✗ |
session.avail_duration_secs | 长整型 | ✗ | ✓ | ✗ | ✗ |
session.avail_duration_ms | 长整型 | ✗ | ✓ | ✗ | ✗ |
session.streamingProtocol | 字符串 | ✗ | ✗ | ✓ | ✓ |
session.playerParams | 对象 | ✗ | ✗ | ✓ | ✓ |
player_params.* | 字符串 | ✓ | ✓ | ✗ | ✗ |
event.id | 字符串 | ✓ | ✓ | ✓ | ✓ |
event.hook | 字符串 | ✓ | ✓ | ✓ | ✓ |
event.timestamp | 字符串 | ✓ | ✓ | ✓ | ✓ |
avail.index | Int | ✗ | ✓ | ✗ | ✗ |
avail.random | 长整型 | ✗ | ✓ | ✗ | ✗ |
avail.source_content_time_epoch_ms | 长整型 | ✗ | ✓ | ✗ | ✗ |
avail.availId† | 字符串 | ✗ | ✗ | ✓ | ✗ |
avail.durationSeconds† | 数字 | ✗ | ✗ | ✓ | ✗ |
avail.startTime† | 字符串 | ✗ | ✗ | ✓ | ✗ |
scte.event_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.avail_num | Int | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_event_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_type_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid | 字符串 | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid.assetId | 字符串 | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid.cueData.key | 字符串 | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid.cueData.value | 字符串 | ✗ | ✓ | ✗ | ✗ |
scte.unique_program_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.archive_allowed_flag | 布尔值 | ✗ | ✓ | ✗ | ✗ |
scte.delivery_not_restricted_flag | 布尔值 | ✗ | ✓ | ✗ | ✗ |
scte.device_restrictions | Int | ✗ | ✓ | ✗ | ✗ |
scte.no_regional_blackout_flag | 布尔值 | ✗ | ✓ | ✗ | ✗ |
scte.segment_num | Int | ✗ | ✓ | ✗ | ✗ |
scte.segments_expected | Int | ✗ | ✓ | ✗ | ✗ |
scte.sub_segment_num | Int | ✗ | ✓ | ✗ | ✗ |
scte.sub_segments_expected | Int | ✗ | ✓ | ✗ | ✗ |
scte.avails_expected | 长整型 | ✗ | ✓ | ✗ | ✗ |
asset.* | 字符串 | ✗ | ✓ | ✗ | ✗ |
inference.enriched | 布尔值 | ✗ | ✓ | ✗ | ✗ |
inference.feedId | 字符串 | ✗ | ✓ | ✗ | ✗ |
inference.dataEndpoint | 字符串 | ✗ | ✓ | ✗ | ✗ |
inference.pts | 长整型 | ✗ | ✓ | ✗ | ✗ |
inference.timescale | 长整型 | ✗ | ✓ | ✗ | ✗ |
inference.region | 字符串 | ✗ | ✓ | ✗ | ✗ |
inference.previousBreakEndPts | 长整型 | ✗ | ✓ | ✗ | ✗ |
inference.parseError | 布尔值 | ✗ | ✓ | ✗ | ✗ |
adsRequest.url | 字符串 | ✗ | ✓ | ✓ | ✗ |
adsRequest.method | 字符串 | ✗ | ✓ | ✓ | ✗ |
adsRequest.headers.<key> | 字符串 | ✗ | ✓ | ✓ | ✗ |
adsRequest.body | 字符串 | ✗ | ✓ | ✗ | ✗ |
adsResponse.responseType | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads | 数组 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].adId‡ | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].durationSeconds | 数字 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].adSystem | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].adTitle | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].creativeId | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].sequence | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles | 数组 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].url | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].mimeType | 字符串 | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].width | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].height | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].bitrate | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].trackingEvents.<eventType> | 字符串数组 | ✗ | ✗ | ✓ | ✗ |
avails.avails | 数组 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].availId | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].durationSeconds | 数字 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].startTime | 数字 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].mediaProtocol | 字符串 (HLS|DASH) | ✗ | ✗ | ✗ | ✓ |
avails.avails[].streamingMode | 字符串 (LIVE|VOD) | ✗ | ✗ | ✗ | ✓ |
avails.avails[].fillDurationSeconds | 数字 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].fillRate | 数字 (0—1) | ✗ | ✗ | ✗ | ✓ |
avails.avails[].mutable | 布尔值 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads | 数组 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].adId§ | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].vastAdId | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].creativeId | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].insertionUuid | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].sequenceInAvail | Int | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].durationSeconds | 数字 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].adSystem¶ | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].adTitle¶ | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].mediaUrl | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].trackingEvents.<eventType> | 字符串数组 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].mediaFiles | 数组 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds | 数组 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].adId | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].vastAdId | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].durationSeconds | 数字 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].creativeUrl | 字符串 | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].reason | 字符串 | ✗ | ✗ | ✗ | ✓ |
* session.referer 仅当会话初始化请求中包含 Referer 标头时才会出现。用于$exists(session.referer)在访问之前进行检查。
† 仅当 ADS 响应适用于单个广告插播时段时，avail命名空间才会出现。它不适用于多重中断 (VMAP) 响应或预取的响应。用于$exists(avail)在访问之前进行检查。
‡ At POST_ADS_RESPONSE adId 是 VAST <Ad> 元素的id属性。
§ AtPRE_MANIFEST_INSERTION，adId是内部放置标识符。它对于广告时段内的广告来说是稳定的，但它不是 VAST 广告 ID，在广告时段或挂钩之间无法进行比较。要进行跨广告插播或挂钩的身份检查，请使用vastAdId（VAST <Ad> 元素的id属性）或creativeId。
¶ 在 DASH VOD 上直播，adTitle并且adSystemnull处于挂机状态。在那里creativeId的谓词中使用vastAdId或。
