Anfrageparameter

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 Anzahl 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

Anforderungsschlüssel erforderlich Anfragetyp-Schlüssel Eingerichtet auf… Beschreibung
media.streamFormat N string sessionStart Stream-Format, z. B. „HD“
media.show N string sessionStart Der Name des Programms oder der Serie
media.season N string sessionStart Die Staffelnummer der Sendung oder Serie
media.episode N string sessionStart Die Folge der Sendung oder Serie
media.assetId N string sessionStart Die eindeutige ID für den Inhalt des Video-Assets, z. B. die Kennung einer Serienfolge, eines Film-Assets oder eines Live-Events. Normalerweise stammen diese IDs von Metadatensystemen wie EIDR, TMS/Gracenote oder Rovi. Diese Kennungen können auch von anderen proprietären oder internen Systemen stammen.
media.genre N string sessionStart Die Art des Inhalts nach Definition des Inhaltserstellers
media.firstAirDate N string sessionStart Das Datum der Erstausstrahlung des Inhalts im Fernsehen
media.firstDigitalDate N string sessionStart Das Datum der Erstausstrahlung des Inhalts auf einer digitalen Plattform
media.rating N string sessionStart Die Alterseinstufung nach der Definition von TV Parental Guidelines
media.originator N string sessionStart Der Ersteller des Inhalts
media.network N string sessionStart Der Name des Netzwerks/Senders
media.showType N string sessionStart Der Inhaltstyp, angegeben als Integer-Wert zwischen 0 und 3:
  • 0 - Vollständige Folge
  • 1 - Vorschau
  • 2 - Clip
  • 3 - Sonstiges
media.adLoad N string sessionStart Die Art der geladenen Anzeige
media.pass.mvpd N string sessionStart Der von der Adobe-Authentifizierung bereitgestellte MVPD
media.pass.auth N string sessionStart Zeigt an, dass der Anwender durch die Adobe-Authentifizierung autorisiert wurde (dieser Parameter kann nur true lauten, wenn er festgelegt wurde).
media.dayPart N string sessionStart Die Tageszeit, zu der der Inhalt übertragen wurde
media.feed N string sessionStart Die Art des Feeds, z. B. „West-HD“

Anzeigedaten

Anforderungsschlüssel erforderlich Anfragetyp-Schlüssel Eingerichtet auf… Beschreibung
media.ad.podFriendlyName N string adBreakStart Der Anzeigename der Werbeunterbrechung
media.ad.podIndex J Ganzzahl adBreakStart Der Index der Anzeigen-Pods im Video
media.ad.podSecond J Anzahl adBreakStart Die Sekunde, in der der Pod gestartet wurde
media.ad.podPosition J Ganzzahl adStart Der Index der Anzeige innerhalb der Werbegruppe (beginnend bei 1)
media.ad.name N string adStart Der Anzeigename der Werbeanzeige
media.ad.id J string adStart Der Name der Werbeanzeige
media.ad.length J Anzahl adStart Die Länge der Videoanzeige in Sekunden
media.ad.playerName J string adStart Der Name des Players, der für das Rendering der Werbeanzeige verantwortlich ist

Standardmäßige Anzeigenmetadaten

Anforderungsschlüssel erforderlich Anfragetyp-Schlüssel Eingerichtet auf… Beschreibung
media.ad.advertiser N string adStart Das Unternehmen oder die Marke des Produkts, das in der Anzeige vorgestellt wird
media.ad.campaignId N string adStart Die ID der Anzeigenkampagne
media.ad.creativeId N string adStart Die ID der Werbeanzeige
media.ad.siteId N string adStart Die ID der Anzeigen-Site
media.ad.creativeURL N string adStart Die URL der Werbeanzeige
media.ad.placementId N string adStart Die Platzierungs-ID der Anzeige

Kapiteldaten

Anforderungsschlüssel erforderlich Anfragetyp-Schlüssel Eingerichtet auf… Beschreibung
media.chapter.index J Ganzzahl chapterStart Identifiziert die Position des Kapitels im Inhalt
media.chapter.offset J Anzahl chapterStart Die Sekunde, in der die Wiedergabe des Kapitels beginnt
media.chapter.length J Anzahl chapterStart Die Länge des Kapitels in Sekunden
media.chapter.friendlyName N string chapterStart Der Anzeigename des Kapitels

Qualitätsdaten

Anforderungsschlüssel erforderlich Anfragetyp-Schlüssel Eingerichtet auf… Beschreibung
media.qoe.bitrate N Ganzzahl Eines Die durchschnittliche Bitrate (in Bit/s). Die durchschnittliche Bitrate wird als gewichteter Durchschnitt aller Bitratenwerte im Zusammenhang mit der Wiedergabedauer berechnet, die während einer Wiedergabesitzung aufgetreten sind.
media.qoe.droppedFrames N Ganzzahl Eines Die Anzahl der Dropped Frames im Stream
media.qoe.framesPerSecond N Ganzzahl Eines Die Anzahl der Frames pro Sekunde
media.qoe.timeToStart N Ganzzahl Eines Die Dauer (in Millisekunden) zwischen der Aktivierung der Wiedergabetaste durch den Benutzer und dem Laden und Abspielen des Inhalts

Parameter des California Consumer Privacy Act (CCPA)

Anforderungsschlüssel erforderlich Anfragetyp-Schlüssel Eingerichtet auf… Beschreibung
analytics.optOutServerSideForwarding N boolean sessionStart Auf „true“ (wahr) setzen, wenn der Endbenutzer die Freigabe seiner Daten für Adobe Analytics und andere Experience Cloud-Lösungen (z. B. Audience Manager) abgelehnt hat.
analytics.optOutShare N boolean sessionStart Auf „true“ (wahr) setzen, wenn der Endbenutzer die Verknüpfung seiner Daten (z. B. mit anderen Adobe Analytics-Clients) abgelehnt hat.

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.

HINWEIS

Media Analytics (MA) ist in das Portfolio von Experience Cloud-Anwendungen (Adobe Analytics, Audience Manager, Target usw.) integriert. Sie benötigen eine Experience Cloud ID, um auf diese Anwendungen zuzugreifen. In den meisten Szenarien sollten Sie die ECID verwenden, um Benutzer zu identifizieren.

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 eine appInstallationId zu senden (neben der erforderlichen marketingCloudOrgId), damit die Mediensammlungs-API die MCID generiert und bei allen Aufrufen sendet.

  • Wenn Sie denappInstallationId-Wertübergeben: Die MCID kann vom MA-Backend generiert werden, wenn Sie Werte für die Parameter appInstallationId und marketingCloudOrgId (erforderlich) übergeben. Wenn Sie appInstallationId 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.

HINWEIS

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.

Auf dieser Seite