Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Funktionen Lifecycle-Hooks
Ein Lifecycle-Hook definiert, wann Ihre Funktion während der Wiedergabe MediaTailor ausgeführt wird. Diese Seite ist eine vollständige Referenz für Eingabefelder, Ausgabe-Namespaces und die Regeln, die den Datenfluss an jedem Hook regeln.
-Übersicht
MediaTailor unterstützt vier Lifecycle-Hooks:
-
PRE_SESSION_INITIALIZATIONwird einmal ausgelöst, wenn ein Zuschauer eine neue Sitzung startet. Verwenden Sie es für einmalige Einrichtungsarbeiten wie das Abrufen von Zielgruppensegmenten. Zu diesem Zeitpunkt ist noch keine Werbeunterbrechung aufgetreten, sodass der Kontext für die Werbeunterbrechung nicht verfügbar ist. -
PRE_ADS_REQUESTwird vor jeder ADS-Anfrage (Ad Decision Server) ausgelöst — einmal pro Werbeunterbrechung im Stream. Verwenden Sie ihn, um die ADS-Anfrage mit Targeting-Daten anzupassen, die ADS-URL zu ändern oder Header hinzuzufügen. -
POST_ADS_RESPONSEwird ausgelöst, nachdem die ADS-Antwort MediaTailor empfangen und analysiert wurde, einschließlich der Auflösung der Video Ad Serving Template (VAST) -Wrapper-Weiterleitungen. Verwenden Sie diese Option, um die vom ADS zurückgegebenen Anzeigen zu filtern, neu anzuordnen, zu ändern oder zu ergänzen, bevor Sie die einzufügenden MediaTailor Anzeigen auswählen. -
PRE_MANIFEST_INSERTIONwird am Ende der Personalisierung von Werbeunterbrechungen ausgelöst, nach der Anzeigenauswahl, der Transcodierungsprüfung und der Füllrichtlinie, unmittelbar bevor Anzeigen in das MediaTailor Manifest geschrieben werden. Verwenden Sie ihn, um das endgültige Anzeigenset zu überprüfen oder zu ändern. Sie können auch zusätzliche Werbeanzeigen in unterfüllte Werbeblöcke einfügen.
Die Hooks unterscheiden sich in Zeitpunkt und Umfang. PRE_SESSION_INITIALIZATIONwird einmal ausgeführt und richtet Daten ein, die für die gesamte Sitzung bestehen bleiben. PRE_ADS_REQUESTund POST_ADS_RESPONSE führen Sie jede ADS-Interaktion durch. PRE_ADS_REQUESTformt die ausgehende Anfrage und POST_ADS_RESPONSE reagiert auf die analysierte Antwort vor der Anzeigenauswahl. PRE_MANIFEST_INSERTIONwird ausgeführt, nachdem die Auswahl abgeschlossen ist, und die endgültige Anzeigenschaltung für alle neu personalisierten Werbeunterbrechungen wird in einem einzigen Aufruf angezeigt.
Wichtig
Die PRE_ADS_REQUESTPOST_ADS_RESPONSE, und PRE_MANIFEST_INSERTION Hooks teilen sich ein kombiniertes Ausführungsbudget von 2.000 ms für eine einzelne Anfrage. Dieses Budget kommt zu dem Timeout von 2.000 ms für jeden Hook hinzu. Der effektive Timeout eines Hooks ist der jeweils kleinere Wert aus seinem eigenen Timeout und dem verbleibenden Budget. Die Zeit, die für einen früheren Hook aufgewendet wurde, reduziert die Zeit, die für spätere Hooks in derselben Anfrage zur Verfügung steht. Wenn das verbleibende Budget aufgebraucht ist, bevor ein Hook gestartet wird, wird dieser Hook MediaTailor übersprungen und die Bearbeitung der Anfrage ohne Hook fortgesetzt. PRE_SESSION_INITIALIZATIONwird während der Sitzungsinitialisierung ausgeführt und ist nicht Teil des Gesamtbudgets. Weitere Informationen finden Sie unter Einschränkungen.
Anmerkung
In dieser Dokumentation wird eine Werbeunterbrechung auch als Avail bezeichnet. Eingabefeldnamen (wie avail.availId undavails.avails) und CloudWatch Metriken verwenden das avail Formular.
Referenz zum Eingabefeld
In der folgenden Tabelle sind die Eingabefelder aufgeführt, die an jedem Lifecycle-Hook verfügbar sind. In der Spalte Feld gibt die parent[].child Notation ein Feld jedes Elements im parent Array an.
Anmerkung
Die PRE_MANIFEST_INSERTION Hooks POST_ADS_RESPONSE und machen Sitzungsfelder in CamelCase verfügbar (zum Beispielsession.clientIp), während die ersten beiden Hooks snake_case verwenden (zum Beispiel). session.client_ip Player-Parameter sind an den ersten beiden Hooks über den player_params Namespace und an den anderen beiden als Objekt verfügbar. session.playerParams
| Feld | Typ | PRE_SESSION_INITIALIZATION | PRE_ADS_REQUEST | POST_ADS_RESPONSE | PRE_MANIFEST_INSERTION |
|---|---|---|---|---|---|
session.id | Long | ✓ | ✓ | ✓ | ✓ |
session.uuid | Zeichenfolge | ✓ | ✓ | ✓ | ✓ |
session.client_ip | Zeichenfolge | ✓ | ✓ | ✗ | ✗ |
session.clientIp | Zeichenfolge | ✗ | ✗ | ✓ | ✓ |
session.user_agent | Zeichenfolge | ✓ | ✓ | ✗ | ✗ |
session.userAgent | Zeichenfolge | ✗ | ✗ | ✓ | ✓ |
session.referer* | Zeichenfolge | ✓ | ✓ | ✗ | ✗ |
session.avail_duration_secs | Long | ✗ | ✓ | ✗ | ✗ |
session.avail_duration_ms | Long | ✗ | ✓ | ✗ | ✗ |
session.streamingProtocol | Zeichenfolge | ✗ | ✗ | ✓ | ✓ |
session.playerParams | Objekt | ✗ | ✗ | ✓ | ✓ |
player_params.* | Zeichenfolge | ✓ | ✓ | ✗ | ✗ |
event.id | Zeichenfolge | ✓ | ✓ | ✓ | ✓ |
event.hook | Zeichenfolge | ✓ | ✓ | ✓ | ✓ |
event.timestamp | Zeichenfolge | ✓ | ✓ | ✓ | ✓ |
avail.index | Int | ✗ | ✓ | ✗ | ✗ |
avail.random | Long | ✗ | ✓ | ✗ | ✗ |
avail.source_content_time_epoch_ms | Long | ✗ | ✓ | ✗ | ✗ |
avail.availId† | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
avail.durationSeconds† | Zahl | ✗ | ✗ | ✓ | ✗ |
avail.startTime† | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
scte.event_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.avail_num | Int | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_event_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_type_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid.assetId | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid.cueData.key | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
scte.segmentation_upid.cueData.value | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
scte.unique_program_id | Int | ✗ | ✓ | ✗ | ✗ |
scte.archive_allowed_flag | Boolesch | ✗ | ✓ | ✗ | ✗ |
scte.delivery_not_restricted_flag | Boolesch | ✗ | ✓ | ✗ | ✗ |
scte.device_restrictions | Int | ✗ | ✓ | ✗ | ✗ |
scte.no_regional_blackout_flag | Boolesch | ✗ | ✓ | ✗ | ✗ |
scte.segment_num | Int | ✗ | ✓ | ✗ | ✗ |
scte.segments_expected | Int | ✗ | ✓ | ✗ | ✗ |
scte.sub_segment_num | Int | ✗ | ✓ | ✗ | ✗ |
scte.sub_segments_expected | Int | ✗ | ✓ | ✗ | ✗ |
scte.avails_expected | Long | ✗ | ✓ | ✗ | ✗ |
asset.* | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
inference.enriched | Boolesch | ✗ | ✓ | ✗ | ✗ |
inference.feedId | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
inference.dataEndpoint | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
inference.pts | Long | ✗ | ✓ | ✗ | ✗ |
inference.timescale | Long | ✗ | ✓ | ✗ | ✗ |
inference.region | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
inference.previousBreakEndPts | Long | ✗ | ✓ | ✗ | ✗ |
inference.parseError | Boolesch | ✗ | ✓ | ✗ | ✗ |
adsRequest.url | Zeichenfolge | ✗ | ✓ | ✓ | ✗ |
adsRequest.method | Zeichenfolge | ✗ | ✓ | ✓ | ✗ |
adsRequest.headers.<key> | Zeichenfolge | ✗ | ✓ | ✓ | ✗ |
adsRequest.body | Zeichenfolge | ✗ | ✓ | ✗ | ✗ |
adsResponse.responseType | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads | Array | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].adId‡ | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].durationSeconds | Zahl | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].adSystem | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].adTitle | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].creativeId | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].sequence | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles | Array | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].url | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].mimeType | Zeichenfolge | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].width | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].height | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].mediaFiles[].bitrate | Int | ✗ | ✗ | ✓ | ✗ |
adsResponse.ads[].trackingEvents.<eventType> | Zeichenfolgen-Array | ✗ | ✗ | ✓ | ✗ |
avails.avails | Array | ✗ | ✗ | ✗ | ✓ |
avails.avails[].availId | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].durationSeconds | Zahl | ✗ | ✗ | ✗ | ✓ |
avails.avails[].startTime | Zahl | ✗ | ✗ | ✗ | ✓ |
avails.avails[].mediaProtocol | Zeichenfolge (|) HLS DASH | ✗ | ✗ | ✗ | ✓ |
avails.avails[].streamingMode | Zeichenfolge (LIVE|VOD) | ✗ | ✗ | ✗ | ✓ |
avails.avails[].fillDurationSeconds | Zahl | ✗ | ✗ | ✗ | ✓ |
avails.avails[].fillRate | Zahl (0—1) | ✗ | ✗ | ✗ | ✓ |
avails.avails[].mutable | Boolesch | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads | Array | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].adId§ | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].vastAdId | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].creativeId | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].insertionUuid | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].sequenceInAvail | Int | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].durationSeconds | Zahl | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].adSystem¶ | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].adTitle¶ | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].mediaUrl | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].trackingEvents.<eventType> | Zeichenfolgen-Array | ✗ | ✗ | ✗ | ✓ |
avails.avails[].ads[].mediaFiles | Array | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds | Array | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].adId | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].vastAdId | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].durationSeconds | Zahl | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].creativeUrl | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
avails.avails[].skippedAds[].reason | Zeichenfolge | ✗ | ✗ | ✗ | ✓ |
* session.referer ist nur vorhanden, wenn ein Referer-Header in der Anfrage zur Sitzungsinitialisierung enthalten ist. Wird $exists(session.referer) zur Überprüfung vor dem Zugriff verwendet.
† Der avail Namespace ist nur vorhanden, wenn sich die ADS-Antwort auf eine einzelne Werbeunterbrechung bezieht. Er ist nicht für Multi-Break-Antworten (VMAP) oder Prefetch-Antworten vorhanden. Verwenden Sie diese Option, um dies vor $exists(avail) dem Zugriff zu überprüfen.
‡ AtPOST_ADS_RESPONSE, adId ist das id Attribut des <Ad> VAST-Elements.
§ AtPRE_MANIFEST_INSERTION, adId ist ein interner Platzierungsbezeichner. Er ist für eine Anzeige innerhalb ihres Anzeigenblocks stabil, aber es handelt sich nicht um die VAST-Anzeigen-ID und ist nicht über Anzeigenumbrüche oder Hooks hinweg vergleichbar. Für Identitätsprüfungen, die sich über Werbeblöcke oder Hooks erstrecken, verwende vastAdId (das id Attribut des <Ad> VAST-Elements) odercreativeId.
¶ Auf DASH-VOD-Streams adTitle und adSystem sind null an diesem Haken. Benutze vastAdId oder creativeId in Prädikaten dort.
