Suporte a metadados personalizados custom-metadata-support

A API Media Collection permite enviar pares de valores chave personalizados juntamente com parâmetros padrão em eventos sessionStart, adStart e chapterStart. Os metadados personalizados são encaminhados ao Adobe Analytics com os respectivos eventos de fechamento de mídia.

Para disponibilizar esses dados no Analysis Workspace, os clientes devem definir eVars personalizadas e configurar regras de processamento para preenchê-las de acordo com seu caso de uso. Depois de mapeados para eVars ou props, os dados também ficam disponíveis no Adobe Experience Platform por meio dos caminhos do eVar correspondentes, desde que o Conector de origem do Analytics esteja configurado.

Para implementações baseadas em XDM usando o Experience Edge, consulte Suporte a metadados personalizados - formato XDM.

Visão geral

Os metadados personalizados estão incluídos no corpo da solicitação como um objeto customMetadata, posicionado junto com a chave params. Ela se aplica a três tipos de evento:

Estrutura

Os metadados personalizados são um objeto simples (pares de valores chave) no nível do evento, ao lado da chave 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 obrigatórios por tipo de evento

Requisitos de nomenclatura de chave

Metadados personalizados do conteúdo principal

Enviado com sessionStart. Aplica-se à mídia principal que está sendo rastreada e permanece disponível em chamadas de anúncio e capítulo. Quaisquer metadados personalizados definidos aqui serão mesclados automaticamente pelo back-end de mídia nas chamadas de fechamento correspondentes. Ele será incluído junto com quaisquer metadados personalizados específicos definidos para anúncios e 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"
  }
}'

Adicionar metadados personalizados

Enviado com adStart. Específico para cada anúncio individual. Os metadados personalizados de sessionStart também são mesclados automaticamente pelo back-end de mídia na chamada de fechamento de anúncio ao lado de qualquer metadado personalizado específico do anúncio definido aqui.

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

Metadados personalizados de capítulo

Enviado com chapterStart. Específico para cada capítulo ou segmento de conteúdo. Os metadados personalizados do sessionStart também são mesclados automaticamente pelo back-end de mídia na chamada de fechamento do capítulo ao lado de qualquer metadado personalizado específico do capítulo definido aqui.

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

Documentação relacionada