Ondersteuning voor aangepaste metagegevens custom-metadata-support

Met de Media Collection-API kunt u naast de standaardparameters ook aangepaste sleutel-waardeparen in sessionStart -, adStart - en chapterStart -gebeurtenissen verzenden. De meta-gegevens van de douane door:sturen aan Adobe Analytics met de respectieve media dichte gebeurtenissen.

Om deze gegevens beschikbaar te maken in Analysis Workspace, moeten de klanten douane eVars bepalen en verwerkingsregels vormen om hen volgens hun gebruiksgeval te bevolken. Zodra in kaart gebracht aan eVars of steunen, worden de gegevens ook beschikbaar in Adobe Experience Platform door de overeenkomstige wegen van eVar, op voorwaarde dat de ​ Analytics bronschakelaar ​ wordt gevormd.

Voor op XDM-Gebaseerde implementaties die Ervaring Edge gebruiken, zie ​ de meta-gegevenssteun van de Douane - formaat XDM ​.

Overzicht

Aangepaste metagegevens worden in de hoofdtekst van de aanvraag opgenomen als een customMetadata -object, dat naast de params -toets wordt geplaatst. Deze is van toepassing op drie gebeurtenistypen:

Structuur

De meta-gegevens van de douane zijn een vlakke voorwerp (zeer belangrijk-waardeparen) op het gebeurtenisniveau, naast de params sleutel:

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

Verplichte parameters per gebeurtenistype

Belangrijkste vereisten voor naamgeving

Aangepaste metagegevens hoofdinhoud

Verzonden met sessionStart. Is van toepassing op de primaire media die worden gevolgd en blijft beschikbaar door aanroepen van advertenties en hoofdstukken. Eventuele aangepaste metagegevens die hier worden gedefinieerd, worden automatisch samengevoegd door de mediagroep op de bijbehorende afsluitende aanroepen. Deze wordt toegevoegd naast eventuele specifieke aangepaste metagegevens die zijn gedefinieerd voor advertenties en hoofdstukken.

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

Aangepaste metagegevens toevoegen

Verzonden met adStart. Specifiek voor elke afzonderlijke advertentie. De aangepaste metagegevens van sessionStart worden ook automatisch samengevoegd door de mediagroep op de aanroep van de advertentie naast eventuele aangepaste metagegevens die hier zijn gedefinieerd.

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

Aangepaste metagegevens hoofdstuk

Verzonden met chapterStart. Specifiek voor elk inhoudshoofdstuk of segment. De aangepaste metagegevens van sessionStart worden ook automatisch samengevoegd door de mediagroep van de dichte hoofdstukaanroep naast eventuele hoofdstukspecifieke, hier gedefinieerde aangepaste metagegevens.

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

Gedrag

Gerelateerde documentatie