Stöd för anpassade metadata custom-metadata-support

Med Media Collection API kan du skicka anpassade nyckelvärdepar tillsammans med standardparametrar i händelserna sessionStart, adStart och chapterStart. Anpassade metadata vidarebefordras till Adobe Analytics med respektive mediastängningshändelse.

För att dessa data ska vara tillgängliga i Analysis Workspace måste kunderna definiera anpassade eVars-variabler och konfigurera bearbetningsregler för att fylla i dem efter användningsfall. När data har mappats till eVars eller props blir de även tillgängliga i Adobe Experience Platform via motsvarande eVar-sökvägar, förutsatt att källkopplingen för analyser har konfigurerats.

Information om XDM-baserade implementeringar med Experience Edge finns i Stöd för anpassade metadata - XDM-format.

Översikt

Anpassade metadata inkluderas i begärandetexten som ett customMetadata-objekt, placerat bredvid params-nyckeln. Det gäller tre händelsetyper:

Struktur

Anpassade metadata är ett platt objekt (nyckelvärdepar) på händelsenivån, tillsammans med params-nyckeln:

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

Obligatoriska parametrar per händelsetyp

Viktiga namnkrav

Anpassade metadata för huvudinnehåll

Skickat med sessionStart. Gäller för det primära mediet som spåras och är tillgängligt under alla annons- och kapitelanrop. Alla anpassade metadata som definieras här sammanfogas automatiskt av medieservern vid motsvarande stängningsanrop. Den kommer att inkluderas tillsammans med eventuella anpassade metadata som definierats för annonser och kapitel.

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

Lägg till anpassade metadata

Skickat med adStart. Specifikt för varje enskild annons. Anpassade metadata från sessionStart sammanfogas automatiskt av medieservern på stängningsanropet för annonsen tillsammans med eventuella egna anpassade metadata som definieras här.

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

Anpassade metadata för kapitel

Skickat med chapterStart. Specifikt för varje kapitel eller segment. De anpassade metadata från sessionStart sammanfogas automatiskt av medieservern i kapitelstängningsanropet tillsammans med eventuella kapitelspecifika anpassade metadata som definieras här.

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

Beteende

Relaterad dokumentation