Anfrageparameter
Erstellt für:
- Benutzende
- Admin
- Entwickler
Analytics-Daten
Anforderungsschlüssel | erforderlich | Anfragetyp-Schlüssel | Eingerichtet auf… | Beschreibung |
---|---|---|---|---|
analytics.trackingServer | J | string | sessionStart | Die URL Ihres Adobe Analytics-Servers |
analytics.reportSuite | J | string | sessionStart | Die ID, die Ihre Analytics-Reporting-Daten identifiziert |
analytics.enableSSL | N | boolean | sessionStart | True oder False für die SSL-Aktivierung |
analytics.visitorId | N | string | sessionStart | Die Adobe-Besucher-ID ist eine benutzerdefinierte ID, die Sie in mehreren Adobe-Anwendungen verwenden können. Die visitorId in Heartbeat entspricht der VID. in Analytics. |
Besucherdaten
Anforderungsschlüssel | erforderlich | Anfragetyp-Schlüssel | Eingerichtet auf… | Beschreibung |
---|---|---|---|---|
visitor.marketingCloudOrgId | J | string | sessionStart | Die Experience Cloud-Organisations-ID, die Ihre Organisation innerhalb der Adobe Experience Cloud-Umgebung identifiziert |
visitor.marketingCloudUserId | N | string | sessionStart | Dies ist die Experience Cloud-Benutzer-ID (ECID). In den meisten Szenarien ist dies die ID, die Sie zur Identifizierung eines Benutzers verwenden sollten. Die marketingCloudUserId in Heartbeat entspricht der MID in Adobe Analytics. Dieser Parameter ist zwar technisch nicht erforderlich, aber für den Zugriff auf die Apps der Experience Cloud-Familie erforderlich. |
visitor.aamLocationHint | N | Ganzzahl | sessionStart | Stellt Adobe Audience Manager Edge-Daten bereit - Wenn kein Wert eingegeben wird, ist der Wert null. |
appInstallationId | N | string | sessionStart | Die appInstallationId identifiziert Anwendung und Gerät eindeutig. |
Inhaltsdaten
Anforderungsschlüssel | erforderlich | Anfragetyp-Schlüssel | Eingerichtet auf… | Beschreibung |
---|---|---|---|---|
media.id | J | string | sessionStart | Eindeutige Kennung für den Inhalt |
media.name | N | string | sessionStart | Lesbarer Name für den Inhalt |
media.length | J | number | sessionStart | Inhaltsdauer (in Sekunden) |
media.contentType | J | string | sessionStart | Format des Streams (hierbei kann es sich um eine beliebige Zeichenfolge handeln, empfohlen werden jedoch Werte wie „Live“, „VOD“ oder „Linear“) |
media.playerName | J | string | sessionStart | Der Name des Players, der für das Rendering des Inhalts verantwortlich ist |
media.channel | J | string | sessionStart | Der Verbreitungskanal für den Inhalt. Dabei kann es sich um den Namen einer App, einer Website oder einer Eigenschaft handeln. |
media.resume | N | boolean | sessionStart | Gibt an, ob ein Benutzer eine vorherige Sitzung fortsetzt (statt eine neue Sitzung zu starten) |
media.sdkVersion | N | string | sessionStart | Die vom Player verwendete SDK-Version |
Standardmäßige Inhaltsmetadaten
media.streamFormat
sessionStart
media.show
sessionStart
media.season
sessionStart
media.episode
sessionStart
media.assetId
sessionStart
media.genre
sessionStart
media.firstAirDate
sessionStart
media.firstDigitalDate
sessionStart
media.rating
sessionStart
media.originator
sessionStart
media.network
sessionStart
media.showType
sessionStart
Der Inhaltstyp, angegeben als Integer-Wert zwischen 0 und 3:
- 0 - Vollständige Folge
- 1 - Vorschau
- 2 - Clip
- 3 - Sonstiges
media.adLoad
sessionStart
media.pass.mvpd
sessionStart
media.pass.auth
sessionStart
media.dayPart
sessionStart
media.feed
sessionStart
Anzeigedaten
media.ad.podFriendlyName
adBreakStart
media.ad.podIndex
adBreakStart
media.ad.podSecond
adBreakStart
media.ad.podPosition
adStart
media.ad.name
adStart
media.ad.id
adStart
media.ad.length
adStart
media.ad.playerName
adStart
Standardmäßige Anzeigenmetadaten
media.ad.advertiser
adStart
media.ad.campaignId
adStart
media.ad.creativeId
adStart
media.ad.siteId
adStart
media.ad.creativeURL
adStart
media.ad.placementId
adStart
Kapiteldaten
media.chapter.index
chapterStart
media.chapter.offset
chapterStart
media.chapter.length
chapterStart
media.chapter.friendlyName
chapterStart
Qualitätsdaten
media.qoe.bitrate
media.qoe.droppedFrames
media.qoe.framesPerSecond
media.qoe.timeToStart
Parameter des California Consumer Privacy Act (CCPA)
analytics.optOutServerSideForwarding
sessionStart
analytics.optOutShare
sessionStart
Zusätzliche Details
visitor.marketingCloudUserId
Übergeben Sie die Experience Cloud-Benutzer-ID (auch als MID
oder MCID
bezeichnet) im sessionStart
-Aufruf, indem Sie sie mit folgendem Schlüssel in der params
-Map angeben: visitor.marketingCloudUserId. Diese Funktion ist hilfreich, wenn Sie schon andere Experience Cloud-Produkte integriert haben und bereits über eine MCID verfügen.
appInstallationId
-
Wenn Sie den
appInstallationId
-Wert nicht übergeben: Das MA-Backend generiert keine MCID mehr, sondern überlässt diese Aufgabe Adobe Analytics. Adobe empfiehlt, entweder eine MCID (sofern verfügbar) oder eineappInstallationId
zu senden (neben der erforderlichenmarketingCloudOrgId
), damit die Mediensammlungs-API die MCID generiert und bei allen Aufrufen sendet. -
Wenn Sie den
appInstallationId
-Wertübergeben: Die MCID kann vom MA-Backend generiert werden, wenn Sie Werte für die ParameterappInstallationId
undmarketingCloudOrgId
(erforderlich) übergeben. Wenn SieappInstallationId
nicht selbst übergeben, muss der Wert clientseitig persistent sein. Er muss außerdem eindeutig für die Anwendung auf dem Gerät sein und beibehalten werden, bis die Anwendung neu installiert wird.
appInstallationId
identifiziert die Anwendung und das Gerät eindeutig. Sie muss für jede Anwendung auf jedem Gerät eindeutig sein. Zwei Anwender, die dieselbe Version der Anwendung auf verschiedenen Geräten verwenden, müssen also eine unterschiedliche (eindeutige) appInstallationId
senden.visitor.marketingCloudOrgId
Dieser Parameter ist nicht nur für die MCID-Generierung erforderlich, sondern wird auch als Wert für die Herausgeber-ID verwendet (basierend auf der Media Analytics den Abgleich von Verknüpfungsregeln durchführt).
Analytics-Legacy-Anwender-ID (aid) und deklarierte Anwender-IDs (customerIDs)
-
analytics.aid:
Der Wert dieses Schlüssels muss eine Zeichenfolge sein, die die veraltete Analytics-Benutzer-ID darstellt
-
visitor.customerIDs:
Der Wert dieses Schlüssels muss ein Objekt im folgenden Format sein:
"<<insert your ID name here>>": { "id": " <<insert your id here>>", "authState": <<insert one of 0, 1, 2>> }
Beachten Sie, dass der Wert visitor.customerIDs
über mehrere Objekte im angegebenen Format verfügen kann.
visitor.aamLocationHint
Dieser Parameter gibt an, welcher AAM-Edge (Adobe Audience Manager) angesteuert wird, wenn Adobe Analytics die Kundendaten an Audience Manager sendet. Wenn kein Wert eingegeben wird, ist der Wert null. Das ist insbesondere dann wichtig, wenn Endanwender ihre Geräte an geografisch weit entfernten Standorten verwenden (z. B. US-Ost- und -Westküste, Europa, Asien). Andernfalls werden die Benutzerdaten über mehrere AAM-Edges verteilt.
media.resume
Wenn die Anwendung feststellt, dass eine Sitzung geschlossen und später wiederaufgenommen wurde – z. B. weil der Anwender das Video verlassen hat, aber zu einem späteren Zeitpunkt zurückgekehrt ist und der Player die Wiedergabe von der vorherigen Position fortgesetzt hat –, können Sie einen optionalen booleschen media.resume-Parameter im params-Bereich des sessionStart
-Aufrufs festlegen.