Unterstützung benutzerdefinierter Metadaten - XDM-Format
Mit der Experience Edge-API können Sie benutzerdefinierte Medienmetadaten zusammen mit standardmäßigen XDM-Feldern in sessionStart-, adStart- und chapterStart-API-Ereignissen senden. Benutzerdefinierte Medienmetadaten, die über das XDM-Format gesendet werden, können sowohl an Adobe Analytics als auch an Adobe Experience Platform weitergeleitet.
Informationen zu Implementierungen der Mediensammlungs-API finden Sie unter Unterstützung benutzerdefinierter Metadaten.
Überblick
Benutzerdefinierte Medien-Metadaten können an zwei Stellen innerhalb einer Experience Edge-Anfrage gesendet werden, die jeweils ein unterschiedliches Routing-Verhalten aufweisen:
xdm.mediaCollection.customMetadata_dataBenutzerdefinierte Metadaten gelten für drei Ereignistypen:
sessionStartadStartchapterStartStruktur
xdm.mediaCollection.customMetadata (Analytics und AEP)
Benutzerdefinierte Metadaten sind ein Array von Name/Wert-Objekten innerhalb des mediaCollection:
{
"xdm": {
"mediaCollection": {
"customMetadata": [
{
"name": "_tenant.fieldName",
"value": "fieldValue"
}
]
}
}
}
<InlineAlert variant=“warning” slots=“text” />
customMetadata muss ein Array innerhalb von mediaCollection sein, nicht auf xdm Stammebene.
Falsch:
{
"xdm": {
"eventType": "media.sessionStart",
"customMetadata": [...] // ❌ Wrong location
}
}
Richtig:
{
"xdm": {
"eventType": "media.sessionStart",
"mediaCollection": {
"customMetadata": [...] // ✅ Inside mediaCollection
}
}
}
_data (nur Analytics)
Das _data-Objekt ist ein spezielles Experience Edge-Konstrukt, das Daten ausschließlich an Adobe Analytics sendet und AEP-Datensätze umgeht. Benutzerdefinierte Metadaten müssen unter __adobe.analytics.contextData platziert werden.
Im Gegensatz zu xdm.mediaCollection.customMetadata, das ein Array von Name-Wert- verwendet, verwendet die _data-Zuordnung ein flaches Schlüssel-Wert- direkt unter contextData:
xdm.mediaCollection.customMetadata{"name": "...", "value": "..."} Objekten_data.__adobe.analytics.contextData{"key": "value"}{
"xdm": { ... },
"_data": {
"__adobe": {
"analytics": {
"contextData": {
"debugMode": "true",
"internalTestFlag": "QA-Session"
}
}
}
}
}
Benennungskonventionen
- XDM-Format Präfix mit Mandanten-Namespace unter Verwendung eines Unterstrichs. Sie können auch Strukturen in Ihrer benutzerdefinierten Feldergruppe des Mandanten erstellen, z. B.
_<tenant>.<struct_name>.<field_name>. _data: Felder werden unter_data.__adobe.analytics.contextDataplatziert. Für den Feldnamen ist kein Unterstrichpräfix erforderlich (z. B.debugFlag)
Benutzerdefinierte Metadaten für Hauptinhalte
Mit sessionStart gesendet. Gilt für die verfolgten primären Medien und bleibt für alle Anzeigen- und Kapitelaufrufe verfügbar. Alle hier definierten benutzerdefinierten Metadaten werden beim entsprechenden Schließen-Aufruf automatisch vom Medien-Backend zusammengeführt. Er wird zusammen mit allen spezifischen benutzerdefinierten Metadaten eingefügt, die für Anzeigen und Kapitel definiert sind.
Anfrage
curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
"events": [
{
"xdm": {
"eventType": "media.sessionStart",
"mediaCollection": {
"sessionDetails": {
"name": "Sample Video",
"playerName": "HTML5 Player",
"contentType": "VOD",
"length": 3600,
"channel": "Sports"
},
"playhead": 0,
"customMetadata": [
{
"name": "_mycompany.contentCategory",
"value": "Live Sports"
},
{
"name": "_mycompany.leagueType",
"value": "Professional"
}
]
},
"timestamp": "2026-03-10T18:00:00Z"
}
}
]
}'
Hinzufügen benutzerdefinierter Metadaten
Mit adStart gesendet. Spezifisch für jede einzelne Anzeige. Die benutzerdefinierten Metadaten aus sessionStart werden auch automatisch vom Medien-Backend beim Aufruf zum Schließen der Anzeige zusammen mit allen hier definierten anzeigenspezifischen benutzerdefinierten Metadaten zusammengeführt.
Anfrage
curl -X POST "https://edge.adobedc.net/ee/va/v1/adStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
"events": [
{
"xdm": {
"eventType": "media.adStart",
"mediaCollection": {
"sessionID": "your-session-id",
"playhead": 30,
"advertisingDetails": {
"name": "Summer Sale Ad",
"playerName": "HTML5 Player",
"length": 30,
"podPosition": 1
},
"customMetadata": [
{
"name": "_mycompany.campaignId",
"value": "SUMMER2026"
},
{
"name": "_mycompany.targetAudience",
"value": "18-34"
},
{
"name": "_mycompany.adFormat",
"value": "skippable"
}
]
},
"timestamp": "2026-03-10T18:05:30Z"
}
}
]
}'
Benutzerdefinierte Kapitel-Metadaten
Mit chapterStart gesendet. Spezifisch für jedes Inhaltskapitel oder Segment. Die benutzerdefinierten Metadaten aus sessionStart werden beim Kapitelabschlussaufruf auch automatisch vom Medien-Backend zusammen mit den hier definierten kapitelspezifischen benutzerdefinierten Metadaten zusammengeführt.
Anfrage
curl -X POST "https://edge.adobedc.net/ee/va/v1/chapterStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
"events": [
{
"xdm": {
"eventType": "media.chapterStart",
"mediaCollection": {
"sessionID": "your-session-id",
"playhead": 600,
"chapterDetails": {
"friendlyName": "Introduction",
"length": 300,
"index": 1,
"offset": 600
},
"customMetadata": [
{
"name": "_mycompany.chapterType",
"value": "tutorial"
},
{
"name": "_mycompany.difficulty",
"value": "beginner"
}
]
},
"timestamp": "2026-03-10T18:10:00Z"
}
}
]
}'
Verwenden des _data-Objekts (nur Analytics-Metadaten)
Verwenden Sie das _data-Objekt, wenn Sie Metadaten in Adobe Analytics benötigen die nicht in AEP-Datensätzen gespeichert werden sollen, z. B. temporäre Flags, Debugging-Variablen oder Analytics-spezifische Verarbeitungshinweise.
<InlineAlert variant=“warning” slots=“text” />
Daten, die über _data gesendet werden, werden nicht in Adobe Experience Platform gespeichert und sind nicht für Real-Time CDP, Journey Orchestration oder andere AEP-Services verfügbar.
Anfrage
curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
"events": [
{
"xdm": {
"eventType": "media.sessionStart",
"mediaCollection": {
"sessionDetails": {
"name": "Sample Video",
"playerName": "HTML5 Player",
"contentType": "VOD",
"length": 3600
},
"playhead": 0,
"customMetadata": [
{
"name": "_mycompany.league",
"value": "Action"
}
]
},
"timestamp": "2026-03-10T18:00:00Z"
},
"_data": {
"__adobe": {
"analytics": {
"contextData": {
"debugMode": "true",
"testFlag": "QA-Session"
}
}
}
}
}
]
}'
In diesem Beispiel:
_mycompany.league→ an Analytics und AEP gesendetdebugModeundtestFlag(unter_data.__adobe.analytics.contextData) → nur an Analytics gesendet
Speicherort nachgelagerter Daten
<InlineAlert variant=“info” slots=“text” />
xdm.mediaCollection.customMetadata ist der eingehende API-Pfad der zum Senden benutzerdefinierter Metadaten mit Ereignissen verwendet wird. Nach der Verarbeitung werden die Daten als Kontextdatenvariablen an Adobe Analytics weitergeleitet und in Adobe Experience Platform unter mediaReporting.customMetadata und als reduzierte Felder der obersten Ebene gespeichert.
Adobe Analytics:
- Nach der Verarbeitung werden benutzerdefinierte Metadaten als Kontextdatenvariablen an Adobe Analytics weitergeleitet. Das
_tenantPräfix wird automatisch entfernt, sodass Verarbeitungsregeln nur auf den Feldpfad nach der_tenantverweisen (z. B._mycompany.contentCategorywirdcontentCategory) - Über
_datagesendete Daten werden ebenfalls an Adobe Analytics weitergeleitet und stehen über Verarbeitungsregeln zur Verfügung - Verwenden Sie Verarbeitungsregeln, um Kontextdatenvariablen eVars, Props oder anderen Analytics-Variablen zuzuordnen. Weitere finden Sie unter „Datenvariablenzuordnung für die Adobe Experience PlatformEdge Network".
Adobe Experience Platform:
-
Benutzerdefinierte Metadatenfelder müssen als benutzerdefinierte Felder in Ihrem XDM-Schema definiert werden (z. B.
_mycompany) und können in AEP als reduzierte Felder gespeichert und abgefragt werden -
Für Berichte und Abfragen sind benutzerdefinierte Metadaten unter
mediaReporting.customMetadatasowie als reduzierte Felder der obersten Ebene verfügbar. Verwenden Sie je nachdem, was für Ihren Anwendungsfall am besten geeignet ist. -
Abrufbar für Segmentierung, Journey Orchestration- und Real-Time CDP-Aktivierung
Verhalten
- Alle benutzerdefinierten Metadatenwerte müssen "". Konvertieren Sie Zahlen und boolesche Werte vor dem Versand.
sessionStartMetadaten bleiben für die gesamte Sitzung erhalten. Für Aktualisierungen ist eine neue Sitzung erforderlich- Jedes
adStart- undchapterStart-Ereignis kann unterschiedliche benutzerdefinierte Metadaten enthalten - Standard-XDM-Felder (
sessionDetails,advertisingDetails,chapterDetails) werden gegenüber benutzerdefinierten Metadaten bevorzugt, wenn ein Standardfeld vorhanden ist
Verwandte Dokumentation
- Unterstützung benutzerdefinierter Metadaten. — MC API (JSON-Format)
- Datentyp „Media Collection Details — XDM-Schemareferenz
- Datenvariablenzuordnung für die Adobe Experience Platform Edge Network — Analytics-Kontextdatenzuordnung für XDM-Felder