DocumentatieAnalyticsGids voor Media Analytics

Parameters aanvragen request-parameters

Last update: Fri Nov 11 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • User
  • Admin
  • Developer

Analysegegevens

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
analytics.trackingServer
Y
string
sessionStart
De URL van uw Adobe Analytics-server
analytics.reportSuite
Y
string
sessionStart
De id die uw analysegegevens identificeert
analytics.enableSSL
N
boolean
sessionStart
Waar of onwaar voor het inschakelen van SSL
analytics.visitorId
N
string
sessionStart
De Adobe-bezoeker-id is een aangepaste id die u kunt gebruiken in meerdere Adobe-toepassingen. De hartslag visitorId is gelijk aan de analysemogelijkheden VID.

Bezoekersgegevens

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
visitor.marketingCloudOrgId
Y
string
sessionStart
de Experience Cloud Organisatie-id; identificeert uw organisatie binnen het ecosysteem van Adobe Experience Cloud
visitor.marketingCloudUserId
N
string
sessionStart
Dit is de Experience Cloud-gebruikersnaam (ECID). In de meeste gevallen is dit de id die u moet gebruiken om een gebruiker te identificeren. De hartslag marketingCloudUserId is gelijk aan de MID in Adobe Analytics. Hoewel deze parameter technisch niet vereist is, is deze vereist voor toegang tot de Experience Cloud-reeks apps.
visitor.aamLocationHint
N
integer
sessionStart
Biedt Adobe Audience Manager Edge-gegevens — Als geen waarde wordt ingevoerd, is de waarde null.
appInstallationId
N
string
sessionStart
De appInstallationId identificeert de app en het apparaat op unieke wijze

Inhoudsgegevens

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
media.id
Y
string
sessionStart
Unieke id voor de inhoud
media.name
N
string
sessionStart
Menselijke leesbare naam voor de inhoud
media.length
Y
getal
sessionStart
Lengte van inhoud (seconden)
media.contentType
Y
string
sessionStart
Indeling van de stream (kan elke tekenreeks zijn, een aantal aanbevolen waarden zijn "Live", "VOD" of "Lineair")
media.playerName
Y
string
sessionStart
De naam van de speler die verantwoordelijk is voor het renderen van de inhoud
media.channel
Y
string
sessionStart
Het distributiekanaal van de inhoud. Dit kan een mobiele toepassingsnaam of een websitenaam, eigenschapsnaam zijn
media.resume
N
boolean
sessionStart
Geeft aan of een gebruiker een vorige sessie hervat (in tegenstelling tot het starten van een nieuwe sessie)
media.sdkVersion
N
string
sessionStart
De SDK-versie die door de speler wordt gebruikt

Metagegevens inhoudstandaard

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
media.streamFormat
N
string
sessionStart
Stroomindeling, bijvoorbeeld "HD"
media.show
N
string
sessionStart
De naam van het programma of de serie
media.season
N
string
sessionStart
Het seizoensnummer waartoe de show of serie behoort
media.episode
N
string
sessionStart
Het nummer van de episode
media.assetId
N
string
sessionStart
De unieke id voor de inhoud van het video-element, zoals de aflevering-id van de tv-reeks, de id van het filmelement of de livegebeurtenis. Deze id's zijn doorgaans afgeleid van metagegevensautoriteiten zoals EIDR, TMS/Gracenote of Rovi. Deze id's kunnen ook afkomstig zijn van andere bedrijfseigen of interne systemen.
media.genre
N
string
sessionStart
Het type inhoud zoals gedefinieerd door de inhoudproducent
media.firstAirDate
N
string
sessionStart
De datum waarop de inhoud voor het eerst op televisie werd uitgezonden
media.firstDigitalDate
N
string
sessionStart
De datum waarop de inhoud voor het eerst is verzonden op een digitaal platform
media.rating
N
string
sessionStart
De rating zoals gedefinieerd in de TV Parental Guidelines
media.originator
N
string
sessionStart
De maker van de inhoud
media.network
N
string
sessionStart
De naam van het netwerk/kanaal
media.showType
N
string
sessionStart

Het type inhoud, uitgedrukt als een geheel getal tussen 0 en 3:

  • 0 - Volledige aflevering
  • 1 - Voorvertoning
  • 2 - Clip
  • 3 - Overige
media.adLoad
N
string
sessionStart
Het type geladen advertentie
media.pass.mvpd
N
string
sessionStart
MVPD verstrekt door de authentificatie van de Adobe
media.pass.auth
N
string
sessionStart
Geeft aan dat de gebruiker is geautoriseerd via Adobe-verificatie (kan alleen waar zijn als deze is ingesteld)
media.dayPart
N
string
sessionStart
De tijd van de dag waarop de inhoud werd uitgezonden
media.feed
N
string
sessionStart
Het type diervoeder, bijvoorbeeld "West-HD"

Advertentiegegevens

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
media.ad.podFriendlyName
N
string
adBreakStart
Vriendschappelijke naam van het advertentiepad
media.ad.podIndex
Y
integer
adBreakStart
De index van de advertentiepod in de video
media.ad.podSecond
Y
getal
adBreakStart
De tweede waarmee de pod is gestart
media.ad.podPosition
Y
integer
adStart
De index van de advertentie binnen het advertentiespoor dat bij 1 begint
media.ad.name
N
string
adStart
Vriendelijke naam van de advertentie
media.ad.id
Y
string
adStart
Naam van de advertentie
media.ad.length
Y
getal
adStart
Lengte van de video en in seconden
media.ad.playerName
Y
string
adStart
De naam van de speler die verantwoordelijk is voor het renderen van de advertentie

Standaardmetagegevens toevoegen

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
media.ad.advertiser
N
string
adStart
De onderneming of het merk waarvan het product in de advertentie voorkomt
media.ad.campaignId
N
string
adStart
De id van de advertentiecampagne
media.ad.creativeId
N
string
adStart
De id van de advertentie is creatief
media.ad.siteId
N
string
adStart
De id van de advertentiesite
media.ad.creativeURL
N
string
adStart
De URL van de advertentie
media.ad.placementId
N
string
adStart
De plaatsings-id van de advertentie

Hoofdgegevens

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
media.chapter.index
Y
integer
chapterStart
Hiermee wordt de positie van het hoofdstuk in de inhoud aangegeven
media.chapter.offset
Y
getal
chapterStart
De tweede functie in het afspelen waar het hoofdstuk begint
media.chapter.length
Y
getal
chapterStart
De lengte van het hoofdstuk in seconden
media.chapter.friendlyName
N
string
chapterStart
De mensvriendelijke naam van het hoofdstuk

Kwaliteitsgegevens

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
media.qoe.bitrate
N
integer
Alle
De gemiddelde bitsnelheid (in bps). De gemiddelde bitsnelheid wordt berekend als het gewogen gemiddelde van alle bitsnelheidwaarden die betrekking hebben op de afspeelduur die tijdens een afspeelsessie is opgetreden.
media.qoe.droppedFrames
N
integer
Alle
Het aantal gedropte frames in de stream
media.qoe.framesPerSecond
N
integer
Alle
Het aantal frames per seconde
media.qoe.timeToStart
N
integer
Alle
De hoeveelheid tijd (in milliseconden) die wordt doorgegeven tussen het moment dat de gebruiker in aanraking komt met afspelen en het moment waarop de inhoud wordt geladen en het moment waarop wordt begonnen met afspelen

California Consumer Privacy Act (CCPA) Parameters ccpa-params

Aanvraagsleutel
Vereist
Sleutel aanvraagtype
Instellen op…
Beschrijving
analytics.optOutServerSideForwarding
N
boolean
sessionStart
Ingesteld op true wanneer de eindgebruiker ervoor heeft gekozen geen gegevens meer te delen tussen Adobe Analytics en andere Experience Cloud-oplossingen (bijvoorbeeld Audience Manager)
analytics.optOutShare
N
boolean
sessionStart
Wordt ingesteld op true wanneer de eindgebruiker heeft opgegeven dat zijn gegevens niet meer worden gefedereerd (bijvoorbeeld aan andere Adobe Analytics-clients).

Aanvullende details additional-details

visitor.marketingCloudUserId

Geef de Experience Cloud-gebruikersnaam door (ook wel de MID of MCID) over de sessionStart vraag door het binnen te omvatten params kaart die de volgende sleutel gebruikt: bezoeker.marketingCloudUserId. Dit is een handige functie als u al met andere Experience Cloud-producten hebt geïntegreerd en de MCID al hebt verkregen.

NOTE
Media Analytics (MA) is geïntegreerd met de Experience Cloud-reeks apps (Adobe Analytics, Audience Manager, Doel, enzovoort). U hebt een Experience Cloud-id nodig om deze apps te openen. ECID is wat u zou moeten gebruiken om gebruikers in de meeste scenario's te identificeren.

appInstallationId

  • Als u niet passeren appInstallationId waarde - De back-end voor MA genereert niet langer een MCID, maar vertrouwt in plaats daarvan op Adobe Analytics om dit te doen. of een MCID-nummer wordt verzonden appInstallationId (samen met de nog steeds verplichte marketingCloudOrgId) zodat de API van de Inzameling van Media MCID produceert en het op alle vraag verzendt.

  • Als u do passeren appInstallationId waarde - De MCID kan gegenereerd door het achterste deel van het MA als u waarden doorgeeft voor appInstallationId en de (vereiste) marketingCloudOrgId parameters. Als u appInstallationId zelf, moet u zijn waarde op de cliëntkant voortzetten. De toepassing moet uniek zijn voor de toepassing op een apparaat en moet blijvend zijn zolang de toepassing niet opnieuw wordt geïnstalleerd.

NOTE
De appInstallationId de app op unieke wijze identificeert en het apparaat. Deze moet uniek zijn voor elke toepassing op elk apparaat, d.w.z. twee gebruikers die dezelfde versie van dezelfde app op verschillende apparaten gebruiken, moeten elk een andere (unieke) versie verzenden appInstallationId.

visitor.marketingCloudOrgId

Deze parameter is niet alleen nodig voor het genereren van MCID wanneer dat niet is opgegeven, maar wordt ook gebruikt als de waarde voor de uitgevers-id (op basis waarvan Media Analytics uitvoert overeenkomende federatieregel.)

Verouderde gebruikersnaam (hulp) en gedeclareerde gebruikers-id's (CustomerID's) voor analyse

  • analytics.aid:

    De waarde van deze sleutel moet een tekenreeks zijn die de oude gebruikers-id voor Analytics vertegenwoordigt

  • bezoeker.customerIDs:

    De waarde van deze sleutel moet een voorwerp van het volgende formaat zijn:

    code language-js 
    "<<insert your ID name here>>": {
  "id": " <<insert your id here>>",
   "authState": <<insert one of 0, 1, 2>>
}

De visitor.customerIDs De waarde kan om het even welk aantal voorwerpen in het voorgestelde formaat hebben.

visitor.aamLocationHint

Deze parameter geeft aan welke Adobe Audience Manager (AAM) Edge wordt bereikt wanneer Adobe Analytics de klantgegevens naar de Audience Manager verzendt. Wanneer geen waarde wordt ingevoerd, is de waarde null. Dit is met name van belang wanneer eindgebruikers hun apparaten doorgaans gebruiken op geografisch afgelegen locaties (bijvoorbeeld VS-Oost, VS-West, Europa, Azië). Anders worden de gebruikersgegevens over meerdere AAM Randen verspreid.

media.resume

Als de app bepaalt dat een sessie is gesloten en later wordt hervat, bijvoorbeeld wanneer de gebruiker de video heeft verlaten maar uiteindelijk is teruggekeerd en de speler de video heeft hervat vanaf de afspeelkop waar deze is gestopt, kunt u een optionele booleaanse video verzenden media.resume parameter binnen de paramentenemmer van de sessionStart vraag.

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb