View a markdown version of this page

函數生命週期關聯 - AWS Elemental MediaTailor

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

函數生命週期關聯

生命週期關聯定義 MediaTailor 在播放期間執行函數的時間。此頁面是輸入欄位、輸出命名空間以及管理每個勾點之資料流程的規則的完整參考。

概觀

MediaTailor 支援四個生命週期掛鉤:

  • PRE_SESSION_INITIALIZATION 當檢視器啟動新的工作階段時, 會觸發一次。將其用於一次性設定工作,例如擷取受眾客群。此時,沒有發生廣告休息時間,因此廣告休息時間內容不可用。

  • PRE_ADS_REQUEST 會在每個廣告決策伺服器 (ADS) 請求之前觸發 - 串流中的每個廣告休息時間一次。使用它來自訂具有目標資料的 ADS 請求、修改 ADS URL 或新增標頭。

  • POST_ADS_RESPONSE 在 MediaTailor 接收並剖析 ADS 回應後觸發,包括影片廣告服務範本 (VAST) 包裝函式重新導向的解析。在 MediaTailor 選取要插入的廣告之前,使用它來篩選、重新排序、修改或補充 ADS 傳回的廣告。

  • PRE_MANIFEST_INSERTION 在廣告休息時間個人化結束時,在廣告選擇、轉碼檢查和填充政策之後,緊接在 MediaTailor 將廣告寫入資訊清單中之前,就會觸發。使用它來檢查或修改最終廣告集,包括將其他廣告插入填充不足的廣告休息時間。

勾點在時間和範圍上有所不同。 PRE_SESSION_INITIALIZATION會執行一次,並設定在整個工作階段中持續存在的資料。 PRE_ADS_REQUEST 會圍繞每個 ADS 互動POST_ADS_RESPONSE執行。 會PRE_ADS_REQUEST形成傳出請求,並在選取廣告前對剖析的回應POST_ADS_RESPONSE採取行動。 會在選取完成後PRE_MANIFEST_INSERTION執行,並在單一調用中查看所有新個人化廣告休息時間的最終廣告集。

重要

PRE_ADS_REQUEST、 POST_ADS_RESPONSE和 PRE_MANIFEST_INSERTION勾點共用單一請求的合併執行預算為 2,000 毫秒。此預算是附加於每個勾點本身的 2,000 毫秒逾時。勾點的有效逾時是其自身逾時和剩餘預算中較小者。較早掛鉤所花費的時間,可縮短相同請求中稍後掛鉤的可用時間。如果剩餘的預算在勾點開始之前用盡,MediaTailor 會略過該勾點,並繼續在沒有該勾點的情況下處理請求。 會在工作階段初始化期間PRE_SESSION_INITIALIZATION執行,且不屬於合併預算的一部分。如需詳細資訊,請參閱限制。

注意

在本文件中,廣告休息時間也稱為時段。輸入欄位名稱 (例如 avail.availId和 avails.avails) 和 CloudWatch 指標使用 avail表單。

輸入欄位參考

下表列出每個生命週期掛鉤可用的輸入欄位。在欄位欄中,parent[].child表示parent陣列中每個元素的欄位。

欄位 Type PRE_SESSION_INITIALIZATION PRE_ADS_REQUEST POST_ADS_RESPONSE PRE_MANIFEST_INSERTION
session.idLong✓✓✓✓
session.uuidString✓✓✓✓
session.client_ip字串✓✓✓✓
session.user_agent字串✓✓✓✓
session.referer*String✓✓✗✗
session.avail_duration_secsLong✗✓✗✗
session.avail_duration_msLong✗✓✗✗
session.streaming_modeString✗✗✓✓
session.media_protocol字串✗✗✗✓
player_params.*字串✓✓✓✓
event.id字串✓✓✓✓
event.hook字串✓✓✓✓
event.timestampString✓✓✓✓
avail.indexInt✗✓✗✗
avail.randomLong✗✓✗✗
avail.source_content_time_epoch_msLong✗✓✗✗
avail.availId†String✗✗✓✗
avail.durationSeconds†數字✗✗✓✗
avail.startTime†String✗✗✓✗
scte.event_idInt✗✓✗✗
scte.avail_numInt✗✓✗✗
scte.segmentation_event_idInt✗✓✗✗
scte.segmentation_type_idInt✗✓✗✗
scte.segmentation_upidString✗✓✗✗
scte.segmentation_upid.assetId字串✗✓✗✗
scte.segmentation_upid.cueData.key字串✗✓✗✗
scte.segmentation_upid.cueData.valueString✗✓✗✗
scte.unique_program_idInt✗✓✗✗
scte.archive_allowed_flagBoolean✗✓✗✗
scte.delivery_not_restricted_flagBoolean✗✓✗✗
scte.device_restrictionsInt✗✓✗✗
scte.no_regional_blackout_flagBoolean✗✓✗✗
scte.segment_numInt✗✓✗✗
scte.segments_expectedInt✗✓✗✗
scte.sub_segment_numInt✗✓✗✗
scte.sub_segments_expectedInt✗✓✗✗
scte.avails_expectedLong✗✓✗✗
asset.*String✗✓✗✗
inference.enrichedBoolean✗✓✗✗
inference.feedIdString✗✓✗✗
inference.dataEndpointString✗✓✗✗
inference.ptsLong✗✓✗✗
inference.timescaleLong✗✓✗✗
inference.regionString✗✓✗✗
inference.previousBreakEndPtsLong✗✓✗✗
inference.parseErrorBoolean✗✓✗✗
adsRequest.urlString✗✓✓✗
adsRequest.method字串✗✓✓✗
adsRequest.headers.<key>字串✗✓✓✗
adsRequest.body字串✗✓✗✗
adsResponse.responseTypeString✗✗✓✗
adsResponse.ads陣列✗✗✓✗
adsResponse.ads[].adId‡String✗✗✓✗
adsResponse.ads[].durationSeconds數字✗✗✓✗
adsResponse.ads[].adSystemString✗✗✓✗
adsResponse.ads[].adTitle字串✗✗✓✗
adsResponse.ads[].creativeIdString✗✗✓✗
adsResponse.ads[].sequenceInt✗✗✓✗
adsResponse.ads[].mediaFiles陣列✗✗✓✗
adsResponse.ads[].mediaFiles[].urlString✗✗✓✗
adsResponse.ads[].mediaFiles[].mimeTypeString✗✗✓✗
adsResponse.ads[].mediaFiles[].widthInt✗✗✓✗
adsResponse.ads[].mediaFiles[].heightInt✗✗✓✗
adsResponse.ads[].mediaFiles[].bitrateInt✗✗✓✗
adsResponse.ads[].trackingEvents.<eventType>字串陣列✗✗✓✗
avails.avails陣列✗✗✗✓
avails.avails[].availIdString✗✗✗✓
avails.avails[].durationSeconds數字✗✗✗✓
avails.avails[].startTimeNumber✗✗✗✓
avails.avails[].mediaProtocol字串 (HLS | DASH)✗✗✗✓
avails.avails[].streamingMode字串 (LIVE | VOD)✗✗✗✓
avails.avails[].fillDurationSecondsNumber✗✗✗✓
avails.avails[].fillRate數字 (0–1)✗✗✗✓
avails.avails[].mutableBoolean✗✗✗✓
avails.avails[].ads陣列✗✗✗✓
avails.avails[].ads[].adId§String✗✗✗✓
avails.avails[].ads[].vastAdId字串✗✗✗✓
avails.avails[].ads[].creativeId字串✗✗✗✓
avails.avails[].ads[].insertionUuidString✗✗✗✓
avails.avails[].ads[].sequenceInAvailInt✗✗✗✓
avails.avails[].ads[].durationSecondsNumber✗✗✗✓
avails.avails[].ads[].adSystemString✗✗✗✓
avails.avails[].ads[].adTitle字串✗✗✗✓
avails.avails[].ads[].mediaUrlString✗✗✗✓
avails.avails[].ads[].trackingEvents.<eventType>字串陣列✗✗✗✓
avails.avails[].ads[].mediaFiles陣列✗✗✗✓
avails.avails[].skippedAds陣列✗✗✗✓
avails.avails[].skippedAds[].adIdString✗✗✗✓
avails.avails[].skippedAds[].vastAdIdString✗✗✗✓
avails.avails[].skippedAds[].durationSeconds數字✗✗✗✓
avails.avails[].skippedAds[].creativeUrlString✗✗✗✓
avails.avails[].skippedAds[].reasonString✗✗✗✓

* session.referer 只有在工作階段初始化請求中包含參考者標頭時才存在。使用 $exists(session.referer) 在存取之前檢查 。

† 只有在 ADS 回應套用至單一廣告休息時間時,才會出現avail命名空間。它不適用於多中斷 (VMAP) 回應或預先擷取的回應。使用 $exists(avail) 在存取之前檢查 。

‡ 在 , POST_ADS_RESPONSE adId 是 VAST <Ad>元素的id屬性。

§ 在 PRE_MANIFEST_INSERTION, adId 是內部置放識別符。它對於廣告休息時間內的廣告是穩定的,但它不是 VAST 廣告 ID,而且無法跨廣告休息時間或跨勾點進行比較。對於跨越廣告休息時間或勾點的身分檢查,請使用 vastAdId(VATS <Ad>元素的 id 屬性) 或 creativeId。

¶ 在 DASH VOD 串流上, adTitle和 adSystem null位於此勾點。在 述詞creativeId中使用 vastAdId或 。