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:

Standort
An Adobe Analytics senden
An Adobe Experience Platform senden
Anwendungsfall
xdm.mediaCollection.customMetadata
✅ Ja
✅ Ja
In beiden Systemen erforderliche Geschäftsdaten
_data
✅ Ja
Analytics-spezifische Flags oder Verarbeitungshinweise

Benutzerdefinierte Metadaten gelten für drei Ereignistypen:

Ereignis
Metadaten gelten für
sessionStart
Hauptinhalt (gesamte Sitzung)
adStart
Individuelle Werbung
chapterStart
Kapitel oder Segment des Inhalts

Struktur

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:

Ansatz
Struktur
Ziel
xdm.mediaCollection.customMetadata
Array von {"name": "...", "value": "..."} Objekten
Analytics und AEP
_data.__adobe.analytics.contextData
Flacher Schlüssel-Wert-{"key": "value"}
Nur Analytics
{
  "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.contextData platziert. 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:

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:

Adobe Experience Platform:

Verhalten

Verwandte Dokumentation

recommendation-more-help
media-analytics-help