Ondersteuning voor aangepaste metagegevens - XDM-indeling

Met de Experience Edge API kunt u aangepaste metagegevens voor media verzenden naast standaard XDM-velden in API-gebeurtenissen sessionStart , adStart en chapterStart . De douanemetagegevens van media die via het formaat XDM worden verzonden kunnen aan zowel Adobe Analytics als Adobe Experience Platform door:sturen.

Voor de implementaties van API van de Inzameling van Media, zie ​ de meta-gegevenssteun van de Douane ​.

Overzicht

De douanemetagegevens van media kunnen in twee plaatsen binnen een verzoek van Edge van de Ervaring worden verzonden, elk met verschillend verpletterend gedrag:

Aangepaste metagegevens zijn van toepassing op drie gebeurtenistypen:

Structuur

xdm.mediaCollection.customMetadata (Analytics + AEP)

De meta-gegevens van de douane zijn een serie van naam-waarde voorwerpen binnen het mediaCollection voorwerp:

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

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

customMetadata moet een serie binnen mediaCollection zijn, niet op het xdm wortelniveau.

Onjuist:

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

Correct:

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

_data (alleen Analytics)

Het _data -object is een speciale Experience Edge-constructie die gegevens exclusief naar Adobe Analytics verzendt, waarbij AEP-gegevenssets worden overgeslagen. Aangepaste metagegevens moeten onder __adobe.analytics.contextData worden geplaatst.

In tegenstelling tot xdm.mediaCollection.customMetadata die een serie van naam-waarde voorwerpen gebruikt, gebruikt de _data afbeelding een vlak zeer belangrijk-waardevoorwerp direct onder contextData:

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

Naamconventies

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.

Verzoek

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

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.

Verzoek

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

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.

Verzoek

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

Het object _data gebruiken (alleen-analytische metagegevens)

Gebruik het _data voorwerp wanneer u meta-gegevens in Adobe Analytics nodig hebt die niet in de datasets van AEP zouden moeten worden opgeslagen — bijvoorbeeld, tijdelijke vlaggen, het zuiveren variabelen, of analytisch-specifieke verwerkingswenken.

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

Gegevens die via _data worden verzonden, worden niet opgeslagen in Adobe Experience Platform en zijn niet beschikbaar voor Real-Time CDP, Journey Orchestration of andere AEP-services.

Verzoek

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

In dit voorbeeld:

• _mycompany.league → verzonden naar zowel Analytics als AEP
• debugMode en testFlag (onder _data.__adobe.analytics.contextData) → alleen verzonden naar Analytics

Downstreamgegevenslocatie

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

xdm.mediaCollection.customMetadata is de binnenkomende API weg wordt gebruikt om douanemetagegevens met gebeurtenissen te verzenden die. Na verwerking worden de gegevens naar Adobe Analytics doorgestuurd als contextgegevensvariabelen en in Adobe Experience Platform opgeslagen onder mediaReporting.customMetadata en als samengevoegde velden op hoofdniveau.

Adobe Analytics:

• Na verwerking worden aangepaste metagegevens naar Adobe Analytics doorgestuurd als contextgegevensvariabelen. Het voorvoegsel _tenant wordt automatisch verwijderd, zodat verwerkingsregels alleen verwijzen naar het veldpad na _tenant (de code _mycompany.contentCategory wordt bijvoorbeeld contentCategory )
• Via _data verzonden gegevens worden ook doorgestuurd naar Adobe Analytics en zijn beschikbaar via verwerkingsregels
• Gebruik verwerkingsregels om contextgegevensvariabelen toe te wijzen aan eVars, props of andere analytische variabelen. Zie ​ veranderlijke afbeelding van Gegevens voor Adobe Experience Platform Edge Network ​ voor details.

Adobe Experience Platform:

• Aangepaste metagegevensvelden moeten worden gedefinieerd als aangepaste velden in uw XDM-schema (bijvoorbeeld _mycompany ) en kunnen in AEP worden opgeslagen en gevraagd als samengevoegde velden

  

• Voor het rapporteren en vragen zijn aangepaste metagegevens beschikbaar onder mediaReporting.customMetadata en ook als samengevoegde velden op hoofdniveau. Gebruik de meest geschikte voor uw geval.

• Toegankelijk voor segmentatie, Journey Orchestration en Real-Time CDP activering

Gedrag

• Alle waarden van douanemetagegevens moeten koorden zijn. Zet aantallen en booleans om alvorens te verzenden.
• sessionStart metagegevens blijven gedurende de gehele sessie bestaan; voor updates is een nieuwe sessie vereist
• Elke adStart - en chapterStart -gebeurtenis kan verschillende aangepaste metagegevens bevatten
• Voorkeur voor standaard XDM-velden (sessionDetails, advertisingDetails , chapterDetails ) boven aangepaste metagegevens wanneer een standaardveld bestaat

Gerelateerde documentatie

• ​ de meta-gegevenssteun van de Douane ​. — MC API (JSON-indeling)
• ​ het gegevenstype van de Details van de Inzameling van Media ​ — XDM schemaverwijzing
• ​ veranderlijke afbeelding van Gegevens voor Adobe Experience Platform Edge Network ​ — de contextgegevens van Analytics voor XDM gebieden