Unterstützung benutzerspezifischer Metadaten custom-metadata-support

Mit der Mediensammlungs-API können Sie benutzerdefinierte Schlüssel-Wert-Paare zusammen mit Standardparametern in sessionStart-, adStart- und chapterStart senden. Benutzerdefinierte Metadaten werden an Adobe Analytics weitergeleitet, wobei die entsprechenden Medienereignisse geschlossen werden.

Um diese Daten in Analysis Workspace verfügbar zu machen, müssen Kunden benutzerdefinierte eVars definieren und Verarbeitungsregeln konfigurieren, um sie entsprechend ihrem Anwendungsfall auszufüllen. Nach der Zuordnung zu eVars oder Props werden die Daten auch in Adobe Experience Platform über die entsprechenden eVar-Pfade verfügbar, sofern der Analytics-Quell-Connector konfiguriert ist.

Informationen zu XDM-basierten Implementierungen mit Experience Edge finden Sie unter Unterstützung benutzerdefinierter Metadaten - XDM-Format.

Überblick

Benutzerdefinierte Metadaten werden im Anfragetext als customMetadata neben dem params positioniert. Sie gilt für drei Ereignistypen:

Struktur

Benutzerdefinierte Metadaten sind ein flaches Objekt (Schlüssel-Wert-Paare) auf Ereignisebene neben dem params Schlüssel:

{
  "playerTime": {
    "playhead": 0,
    "ts": 1646938800000
  },
  "eventType": "sessionStart",
  "params": {
    "analytics.trackingServer": "example.sc.omtrdc.net",
    "analytics.reportSuite": "example-rsid",
    "visitor.marketingCloudOrgId": "0123456789@AdobeOrg",
    "media.id": "sample-video-id",
    "media.length": 3600,
    "media.contentType": "vod",
    "media.playerName": "HTML5 Player",
    "media.channel": "Sports"
  },
  "customMetadata": {
    "field": "value"
  }
}

Obligatorische Parameter nach Ereignistyp

Wichtige Benennungsanforderungen

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.

curl -X POST "https://{uri}/api/v1/sessions" \
--header 'Content-Type: application/json' \
--data '{
  "playerTime": {
    "playhead": 0,
    "ts": 1646938800000
  },
  "eventType": "sessionStart",
  "params": {
    "analytics.trackingServer": "example.sc.omtrdc.net",
    "analytics.reportSuite": "example-rsid",
    "analytics.visitorId": "visitor123",
    "visitor.marketingCloudOrgId": "0123456789@AdobeOrg",
    "media.id": "sample-video-id",
    "media.name": "Sample Video",
    "media.length": 3600,
    "media.contentType": "vod",
    "media.playerName": "HTML5 Player",
    "media.channel": "Sports"
  },
  "customMetadata": {
    "contentCategory": "Live Sports",
    "leagueType": "Professional",
    "broadcastRights": "Premium"
  }
}'

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.

curl -X POST "https://{uri}/api/v1/sessions/{sid}/events" \
--header 'Content-Type: application/json' \
--data '{
  "playerTime": {
    "playhead": 30,
    "ts": 1646938830000
  },
  "eventType": "adStart",
  "params": {
    "media.ad.id": "summer-sale-2026",
    "media.ad.name": "Summer Sale Ad",
    "media.ad.length": 30,
    "media.ad.playerName": "HTML5 Player",
    "media.ad.podPosition": 1
  },
  "customMetadata": {
    "campaignId": "SUMMER2026",
    "targetAudience": "18-34",
    "adFormat": "skippable"
  }
}'

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.

curl -X POST "https://{uri}/api/v1/sessions/{sid}/events" \
--header 'Content-Type: application/json' \
--data '{
  "playerTime": {
    "playhead": 600,
    "ts": 1646938200000
  },
  "eventType": "chapterStart",
  "params": {
    "media.chapter.friendlyName": "Introduction",
    "media.chapter.length": 300,
    "media.chapter.index": 1,
    "media.chapter.offset": 600
  },
  "customMetadata": {
    "chapterType": "tutorial",
    "difficulty": "beginner",
    "instructor": "Jane Smith"
  }
}'

Verhalten

Verwandte Dokumentation