Prise en charge des métadonnées personnalisées custom-metadata-support

L’API Media Collection vous permet d’envoyer des paires clé-valeur personnalisées avec des paramètres standard dans les événements sessionStart, adStart et chapterStart. Les métadonnées personnalisées sont transférées vers ​​avec les événements de fermeture de média correspondants.

Pour rendre ces données disponibles dans Analysis Workspace, les clients doivent définir des eVars personnalisées et configurer des règles de traitement pour les remplir en fonction de leur cas d’utilisation. Une fois mappées à des eVars ou des props, les données sont également disponibles dans Adobe Experience Platform par le biais des chemins eVar correspondants, à condition que le ​ connecteur source Analytics ​ soit configuré.

Pour les implémentations basées sur XDM utilisant Experience Edge, consultez Prise en charge des métadonnées personnalisées - Format XDM.

Vue d’ensemble

Les métadonnées personnalisées sont incluses dans le corps de la requête sous la forme d’un objet customMetadata, positionné à côté de la clé params. Elle s’applique à trois types d’événements :

Structure

Les métadonnées personnalisées sont un objet plat (paires clé-valeur) au niveau de l’événement, avec la clé params :

{
  "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"
  }
}

Paramètres obligatoires par type d’événement

Principales exigences en matière de dénomination

Métadonnées personnalisées du contenu principal

Envoyé avec sessionStart. S’applique au média principal faisant l’objet d’un suivi et reste disponible tout au long des appels de publicité et de chapitre. Toutes les métadonnées personnalisées définies ici seront automatiquement fusionnées par le serveur principal du média lors des appels de fermeture correspondants. Elle est incluse avec toute métadonnée personnalisée spécifique définie pour les annonces publicitaires et les chapitres.

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"
  }
}'

Ajout de métadonnées personnalisées

Envoyé avec adStart. Spécifique à chaque publicité individuelle. Les métadonnées personnalisées d’sessionStart sont également automatiquement fusionnées par le serveur principal du média lors de l’appel de fermeture de l’annonce publicitaire avec toutes les métadonnées personnalisées spécifiques à l’annonce définies ici.

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"
  }
}'

Métadonnées personnalisées de chapitre

Envoyé avec chapterStart. Spécifique à chaque chapitre ou segment de contenu. Les métadonnées personnalisées de sessionStart sont également automatiquement fusionnées par le serveur principal de médias lors de l’appel de fermeture du chapitre avec toutes les métadonnées personnalisées spécifiques au chapitre définies ici.

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"
  }
}'

Comportement

Documentation connexe