Supporto per metadati personalizzati custom-metadata-support

L’API Media Collection consente di inviare coppie chiave-valore personalizzate insieme ai parametri standard negli eventi sessionStart, adStart e chapterStart. I metadati personalizzati vengono inoltrati a Adobe Analytics con i rispettivi eventi di chiusura dei contenuti multimediali.

Per rendere questi dati disponibili in Analysis Workspace, i clienti devono definire eVar personalizzate e configurare le regole di elaborazione per compilarle in base al proprio caso d’uso. Una volta mappati a eVar o proprietà, i dati diventano disponibili in Adobe Experience Platform anche tramite i percorsi eVar corrispondenti, a condizione che il connettore di origine Analytics sia configurato.

Per le implementazioni basate su XDM che utilizzano Experience Edge, consulta Supporto metadati personalizzati - Formato XDM.

Panoramica

I metadati personalizzati sono inclusi nel corpo della richiesta come oggetto customMetadata, posizionato accanto alla chiave params. Si applica a tre tipi di evento:

Struttura

I metadati personalizzati sono un oggetto (coppie chiave-valore) piatto a livello di evento, insieme alla chiave 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"
  }
}

Parametri obbligatori per tipo di evento

Requisiti principali per la denominazione

Metadati personalizzati del contenuto principale

Inviato con sessionStart. Si applica al supporto principale tracciato e rimane disponibile durante le chiamate di annunci e capitoli. Eventuali metadati personalizzati definiti qui verranno uniti automaticamente dal backend multimediale nelle corrispondenti chiamate di chiusura. Sarà incluso insieme a tutti i metadati personalizzati specifici definiti per annunci e capitoli.

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

Aggiungere metadati personalizzati

Inviato con adStart. Specifico per ogni singolo annuncio pubblicitario. I metadati personalizzati da sessionStart vengono inoltre uniti automaticamente dal backend multimediale nella chiamata di chiusura dell’annuncio insieme a eventuali metadati personalizzati specifici dell’annuncio qui definiti.

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

Metadati personalizzati del capitolo

Inviato con chapterStart. Specifico per ogni capitolo o segmento di contenuto. I metadati personalizzati di sessionStart vengono inoltre uniti automaticamente dal backend multimediale nella chiamata di chiusura del capitolo insieme ai metadati personalizzati specifici del capitolo qui definiti.

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

Comportamento

Documentazione correlata