Stöd för anpassade metadata - XDM-format

Med Experience Edge API kan du skicka anpassade metadata för media tillsammans med XDM-standardfält i API-händelserna sessionStart, adStart och chapterStart. Anpassade metadata för media som skickas via XDM-formatet kan vidarebefordras till både Adobe Analytics och Adobe Experience Platform.

API-implementeringar för Media Collection finns i Stöd för anpassade metadata.

Översikt

Anpassade metadata för media kan skickas på två platser i en Experience Edge-begäran, där vart och ett har olika routningsbeteenden:

Anpassade metadata gäller för tre händelsetyper:

Struktur

xdm.mediaCollection.customMetadata (Analytics + AEP)

Anpassade metadata är en array med name-value-objekt inuti mediaCollection-objektet:

{
  "xdm": {
    "mediaCollection": {
      "customMetadata": [
        {
          "name": "_tenant.fieldName",
          "value": "fieldValue"
        }
      ]
    }
  }
}

<InlineAlert variant=“warning” slots=“text” />

customMetadata måste vara en array inuti mediaCollection, inte på rotnivån xdm.

Felaktigt:

{
  "xdm": {
    "eventType": "media.sessionStart",
    "customMetadata": [...]  // ❌ Wrong location
  }
}

Korrekt:

{
  "xdm": {
    "eventType": "media.sessionStart",
    "mediaCollection": {
      "customMetadata": [...]  // ✅ Inside mediaCollection
    }
  }
}

_data (endast analys)

Objektet _data är en speciell Experience Edge-konstruktion som skickar data exklusivt till Adobe Analytics, utan att AEP datauppsättningar skickas. Anpassade metadata måste placeras under __adobe.analytics.contextData.

Till skillnad från xdm.mediaCollection.customMetadata som använder en -array med name-value-objekt, använder _data-mappningen ett platt key-value-objekt direkt under contextData:

{
  "xdm": { ... },
  "_data": {
    "__adobe": {
      "analytics": {
        "contextData": {
          "debugMode": "true",
          "internalTestFlag": "QA-Session"
        }
      }
    }
  }
}

Namnkonventioner

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.

Begäran

curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
          "sessionDetails": {
            "name": "Sample Video",
            "playerName": "HTML5 Player",
            "contentType": "VOD",
            "length": 3600,
            "channel": "Sports"
          },
          "playhead": 0,
          "customMetadata": [
            {
              "name": "_mycompany.contentCategory",
              "value": "Live Sports"
            },
            {
              "name": "_mycompany.leagueType",
              "value": "Professional"
            }
          ]
        },
        "timestamp": "2026-03-10T18:00:00Z"
      }
    }
  ]
}'

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.

Begäran

curl -X POST "https://edge.adobedc.net/ee/va/v1/adStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.adStart",
        "mediaCollection": {
          "sessionID": "your-session-id",
          "playhead": 30,
          "advertisingDetails": {
            "name": "Summer Sale Ad",
            "playerName": "HTML5 Player",
            "length": 30,
            "podPosition": 1
          },
          "customMetadata": [
            {
              "name": "_mycompany.campaignId",
              "value": "SUMMER2026"
            },
            {
              "name": "_mycompany.targetAudience",
              "value": "18-34"
            },
            {
              "name": "_mycompany.adFormat",
              "value": "skippable"
            }
          ]
        },
        "timestamp": "2026-03-10T18:05:30Z"
      }
    }
  ]
}'

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.

Begäran

curl -X POST "https://edge.adobedc.net/ee/va/v1/chapterStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.chapterStart",
        "mediaCollection": {
          "sessionID": "your-session-id",
          "playhead": 600,
          "chapterDetails": {
            "friendlyName": "Introduction",
            "length": 300,
            "index": 1,
            "offset": 600
          },
          "customMetadata": [
            {
              "name": "_mycompany.chapterType",
              "value": "tutorial"
            },
            {
              "name": "_mycompany.difficulty",
              "value": "beginner"
            }
          ]
        },
        "timestamp": "2026-03-10T18:10:00Z"
      }
    }
  ]
}'

Använda objektet _data (metadata endast för analys)

Använd objektet _data när du behöver metadata i Adobe Analytics som inte ska lagras i AEP datamängder, till exempel tillfälliga flaggor, felsökningsvariabler eller analysspecifika bearbetningstips.

<InlineAlert variant=“warning” slots=“text” />

Data som skickas via _data lagras inte i Adobe Experience Platform och är inte tillgängliga för Real-Time CDP, Journey Orchestration eller andra AEP-tjänster.

Begäran

curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
          "sessionDetails": {
            "name": "Sample Video",
            "playerName": "HTML5 Player",
            "contentType": "VOD",
            "length": 3600
          },
          "playhead": 0,
          "customMetadata": [
            {
              "name": "_mycompany.league",
              "value": "Action"
            }
          ]
        },
        "timestamp": "2026-03-10T18:00:00Z"
      },
      "_data": {
        "__adobe": {
          "analytics": {
            "contextData": {
              "debugMode": "true",
              "testFlag": "QA-Session"
            }
          }
        }
      }
    }
  ]
}'

I detta exempel:

• _mycompany.league → skickat till både Analytics och AEP
• debugMode och testFlag (under _data.__adobe.analytics.contextData) → skickas endast till Analytics

Underordnad dataplats

<InlineAlert variant=“info” slots=“text” />

xdm.mediaCollection.customMetadata är den inkommande API-sökvägen som används för att skicka anpassade metadata med händelser. Efter bearbetning vidarebefordras data till Adobe Analytics som kontextdatavariabler och lagras i Adobe Experience Platform under xdm.mediaReporting.customMetadata och som översta förenklade fält.

Adobe Analytics:

• Efter bearbetning vidarebefordras anpassade metadata till Adobe Analytics som kontextdatavariabler. Prefixet _tenant tas bort automatiskt, så bearbetningsreglerna refererar bara till fältsökvägen efter _tenant (t.ex. _mycompany.contentCategory blir contentCategory)
• Data som skickas via _data vidarebefordras också till Adobe Analytics och är tillgängliga via bearbetningsregler
• Använd bearbetningsregler för att mappa sammanhangsdatavariabler till eVars, props eller andra Analytics-variabler. Mer information finns i Datavariabelmappning för Adobe Experience Platform Edge Network.

Adobe Experience Platform:

• Anpassade metadatafält måste definieras som anpassade fält i XDM-schemat (t.ex. _mycompany) och de kan lagras och frågas i AEP som förenklade fält

  

• Anpassade metadata är tillgängliga under xdm.mediaReporting.customMetadata och även som förenklade fält på den översta nivån för rapportering och frågor. Använd det som är lämpligast för ditt användningssätt.

• Kan användas för segmentering, Journey Orchestration och Real-Time CDP-aktivering

Beteende

• Alla anpassade metadatavärden måste vara strängar. Konvertera tal och boolesk innan du skickar.
• sessionStart metadata kvarstår för hela sessionen; uppdateringar kräver en ny session
• Varje adStart- och chapterStart-händelse kan innehålla olika anpassade metadata
• Använd XDM-standardfält (sessionDetails, advertisingDetails, chapterDetails) framför anpassade metadata när det finns ett standardfält

Related Articles

• Stöd för anpassade metadata
• Datatypen Detaljer för mediainsamling
• Datavariabelmappning för Adobe Experience Platform Edge Network