Compatibilidad con metadatos personalizados custom-metadata-support

La API de recopilación de medios le permite enviar pares de clave-valor personalizados junto con parámetros estándar en eventos sessionStart, adStart y chapterStart. Los metadatos personalizados se reenvían a Adobe Analytics con los eventos de cierre de medios correspondientes.

Para que estos datos estén disponibles en Analysis Workspace, los clientes deben definir eVars personalizadas y configurar reglas de procesamiento para rellenarlas según su caso de uso. Una vez asignados a eVars o props, los datos también están disponibles en Adobe Experience Platform a través de las rutas de eVar correspondientes, siempre y cuando se haya configurado el conector de origen de Analytics.

Para implementaciones basadas en XDM que utilizan Experience Edge, consulte Compatibilidad con metadatos personalizados: formato XDM.

Información general

Los metadatos personalizados se incluyen en el cuerpo de la solicitud como un objeto customMetadata, junto a la clave params. Se aplica a tres tipos de eventos:

Estructura

Los metadatos personalizados son un objeto plano (pares clave-valor) en el nivel de evento, junto con la clave 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"
  }
}

Parámetros obligatorios por tipo de evento

Requisitos de nomenclatura clave

Metadatos personalizados de contenido principal

Enviado con sessionStart. Se aplica a los medios principales de los que se realiza un seguimiento y permanece disponible durante las llamadas de anuncio y capítulo. Cualquier metadato personalizado definido aquí se combinará automáticamente con el back-end de medios en las llamadas de cierre correspondientes. Se incluirá junto con cualquier metadato personalizado específico definido para anuncios y capítulos.

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

Añadir metadatos personalizados

Enviado con adStart. Específico para cada anuncio individual. Los metadatos personalizados de sessionStart también se combinan automáticamente por el backend de medios en la llamada de cierre de anuncio junto con cualquier metadato personalizado específico de anuncio definido aquí.

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

Metadatos personalizados de capítulo

Enviado con chapterStart. Específico para cada capítulo o segmento de contenido. Los metadatos personalizados de sessionStart también se combinan automáticamente con el backend de medios en la llamada de cierre de capítulo junto con cualquier metadato personalizado específico de capítulo definido aquí.

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

Comportamiento

Documentación relacionada