AMP

Integriere dein Analytics Tool in AMP

Important: this documentation is not applicable to your currently selected format email!

Überblick

Wenn du ein Software-as-a-Service Tool für Publisher bereitstellst, mit dem diese mehr über ihren Datenverkehr und ihre Besucher erfahren können, solltest du deinen Dienst in amp-analytics integrieren. Dadurch können deine Kunden Trends im Datenverkehr ihrer AMP HTML Seiten ansehen.

Bevor du beginnst

Bevor du deinen Analysedienst zur AMP HTML Runtime hinzufügen kannst, musst du möglicherweise

  • die Arten von Variablen und Anforderungen identifizieren, die du in einem AMP HTML Dokument für deinen Analytics Dienst benötigst,
  • die Trigger identifizieren, die dazu führen, dass Analytics Anforderungen von einer Seite gesendet werden, die für deinen Dienst relevant ist,
  • überlegen, ob und wie du in AMP Kontexten von Erstanbietern und Drittanbietern die Benutzer verfolgen möchtest,
  • festlegen, wie dein Analytics Dashboard den AMP Datenverkehr verarbeitet,
  • fehlende Funktionen in amp-analytics identifizieren und für gewünschte Funktionen Anfragen erstellen.
  • AMP Analytics sendet seine Variablen an einen vorkonfigurierten Endpoint. Wenn du noch keinen Endpoint hast, sieh dir dieses Beispiel an. Es bietet eine Übersicht zum Erstellen eines Endpoints.
    • Für alle Transportarten außer iframe werden Variablen als Parameter der Abfragezeichenfolge in einer HTTPS Anforderung gesendet.
    • Für die Transportart iframe wird ein iframe erstellt und Variablen werden via window.postMessage an dieses gesendet. In diesem Fall muss die Nachricht keine URL sein. Diese Option steht nur MRC-akkreditierten Anbietern zur Verfügung.
  • Überlege dir, wie sich die Integration in amp-analytics auf Richtlinien (insbesondere deine Datenschutzrichtlinie) oder Vereinbarungen auswirken kann.

So fügst du deine Konfiguration zur AMP HTML Runtime hinzu

  1. Erstelle ein Issue mit dem Label Intent-to-Implement, das besagt, dass du die Konfiguration deines Analytics Dienstes zur AMP HTML Runtime hinzufügen möchtest. Stelle sicher, dass du cc @ampproject/wg-analytics in deine Beschreibung aufnimmst.
  2. Entwickle einen Patch, der Folgendes implementiert:
    1. Eine neue json Konfigurationsdatei ${vendorName}.json im Ordner des Anbieters, die alle Optionen enthält, die den Standard wesentlich erweitern, wie zum Beispiel:
      1. "vars": {} für zusätzliche Standardvariablen.
      2. "requests": {} für Anforderungen, die dein Dienst verwenden wird.
      3. "optout": falls erforderlich. Wir haben derzeit kein umfangreiches Opt-out System. Bitte hilf uns, eines zu entwickeln, das für deine Zwecke gut funktioniert.
      4. "warningMessage": falls erforderlich. Zeigt in der Konsole Warninformationen des Anbieters an (z. B. Veraltete Version oder Migration).
    2. Wenn du den iframe Transport verwendest, füge zu ANALYTICS_IFRAME_TRANSPORT_CONFIG in der Datei iframe-transport-vendor.js eine neue Zeile hinzu, die "*vendor-name*": "*url*" enthält.
    3. Ein Beispiel in der Referenz examples/analytics-vendors.amp.html.
    4. Einen Test in der Datei extensions/amp-analytics/0.1/test/vendor-requests.json.
    5. Füge deinen Analytics Dienst zur Liste der unterstützten Anbieter in der Datei extensions/amp-analytics/0.1/analytics-vendors-list.md hinzu. Füge den Typ, die Beschreibung und den Link zu deiner Nutzungsdokumentation hinzu.
  3. Teste das neue Beispiel, das du in examples/analytics-vendors.amp.html eingestellt hast, um sicherzustellen, dass die Treffer aus dem Beispiel erwartungsgemäß funktionieren (dass z. B. die benötigten Daten gesammelt und in deinem Analytics Dashboard angezeigt werden).
  4. Reiche einen Pull Request mit diesem Patch ein, der auf das Issue mit dem Label Intent-To-Implement verweist.
  5. Aktualisiere die Nutzungsdokumentation deines Dienstes und informiere deine Kunden.
  6. Es wird dringend empfohlen, außerhalb des AMP Repo einen Integrationstest durchzuführen.

Tag Manager

Dienste zur Verwaltung von Tags bieten zwei Optionen für die Integration in AMP Analytics:

  • Endpoint Ansatz: Agiert als zusätzlicher Endpoint für amp-analytics und führt Marketing Management im Backend durch.
  • Konfigurationsansatz: Führt die Verwaltung von Tags über eine dynamisch generierte JSON Konfigurationsdatei durch, die für jeden Publisher individuell erstellt wird.

Der Endpoint Ansatz entspricht dem im vorherigen Abschnitt beschriebenen Standardansatz. Der Konfigurationsansatz besteht darin, eine eindeutige Konfiguration für amp-analytics zu erstellen, die für jeden Publisher spezifisch ist und alle kompatiblen Analytics Pakete enthält. Ein Publisher würde die Konfiguration über eine ähnliche Syntax wie die folgende einbetten:

<amp-analytics
  config="https://my-awesome-tag-manager.example.com/user-id.json"
></amp-analytics>

Um diesen Ansatz zu verwenden, sieh dir die Dokumentation für die Integration von Publishern in AMP Analytics an.

Weitere Ressourcen