Comment intégrer votre outil d'analyse à AMP
Important: this documentation is not applicable to your currently selected format email!
Présentation
Si vous utilisez un outil logiciel en tant que service permettant aux éditeurs de mieux comprendre leur trafic et leurs visiteurs, vous serez peut-être intéressé à l'idée d'intégrer votre service dans amp-analytics
. Cela permettra à vos clients de visualiser les modèles de trafic pour leurs pages HTML AMP.
Prérequis
Avant de pouvoir ajouter votre service d'analyse au runtime HTML AMP, vous devrez:
- Identifier les types de variables et de requêtes dont vous aurez besoin dans un document HTML AMP pour votre service d'analyse.
- Identifier les déclencheurs qui entraînent l'envoi de requêtes d'analyse à partir d'une page potentiellement pertinente pour votre service.
- Déterminer si et comment vous allez suivre les utilisateurs dans des contextes AMP propriétaires et tiers.
- Déterminer comment votre tableau de bord d'analyse gère le trafic AMP.
- Identifier les fonctionnalités manquantes dans
amp-analytics
et envoyer des requêtes pour les fonctionnalités nécessaires. - AMP Analytics envoie ses variables à un point de terminaison préconfiguré. Si vous ne disposez pas encore d'un point de terminaison existant, consultez cet exemple pour savoir comment en créer un.
- Pour tous les types de transport, sauf
iframe
, les variables sont envoyées sous forme de paramètres de chaîne de requête dans une requête HTTPS. - Pour le type de transport
iframe
, une iframe est créée et des variables lui sont envoyées viawindow.postMessage
. Dans ce cas, le message n'a pas besoin d'être une URL. Cette option n'est disponible que pour les fournisseurs accrédités MRC. - Voyez dans quelle mesure l'intégration de
amp-analytics
peut avoir un impact sur vos éventuelles politiques (en particulier votre politique de confidentialité) et accords.
Comment ajouter votre configuration au runtime HTML AMP
- Créez un ticket d'intention d'implémentation indiquant que vous allez ajouter la configuration de votre service d'analyse au runtime HTML AMP. Assurez-vous d'inclure cc @ ampproject / wg-analytics dans votre description.
- Développez un correctif qui implémente les éléments suivants:
- Un nouveau fichier json de configuration
${nomdufournisseur}.json
dans dossier des fournisseurs comprenant toutes les options au-delà de la valeur par défaut, telles que:"vars": {}
pour des variables par défaut supplémentaires."requests": {}
pour les requêtes que votre service utilisera."optout":
si nécessaire. Nous n'avons actuellement pas un bon système de désinscription, alors n'hésitez pas à nous contacter afin d'en concevoir un qui fonctionne bien pour vous."warningMessage":
si nécessaire. Affiche les informations d'avertissement du fournisseur (telles que l'abandon ou la migration) dans la console.
- Si vous utilisez le transport iframe, ajoutez également une nouvelle ligne à ANALYTICS_IFRAME_TRANSPORT_CONFIG dans iframe-transport-vendors.js contenant
"*vendor-name*": "*url*"
- Un exemple dans la référence exemples / analytics-vendors.amp.html.
- Un test dans le fichier extensions / amp-analytics / 0.1 / test / vendor-requests.json.
- Ajoutez votre service d'analyse à la liste des fournisseurs pris en charge dans le fichier extensions / amp-analytics / 0.1 / analytics-vendors-list.md. Incluez le type, la description et le lien vers votre documentation d'utilisation.
- Testez le nouvel exemple que vous avez mis dans examples/analytics-vendors.amp.html pour vous assurer que les résultats de l'exemple fonctionnent comme prévu. Par exemple, que les données nécessaires sont collectées et affichées dans votre tableau de bord analytique.
- Envoyez une demande tirage avec ce correctif, en faisant référence ticket d'intention d'implémentation.
- Mettez à jour la documentation d'utilisation de votre service et informez vos clients.
- Il est fortement recommandé de maintenir un test d'intégration en dehors du référentiel AMP.
Gestionnaires de balises
Les services de gestion des balises proposent deux options pour intégrer AMP Analytics:
- Approche par point de terminaison: en servant de point de terminaison supplémentaire à
amp-analytics
, et assurant la gestion du marketing en arrière-plan. - Approche par configuration: gestion des balises via un fichier de configuration JSON généré dynamiquement et unique pour chaque éditeur.
L'approche par point de terminaison est la même que l'approche standard détaillée dans la section précédente. L'approche par configuration consiste à créer une configuration unique pour amp-analytics qui est spécifique à chaque éditeur et inclut tous leurs packages d'analyse compatibles. Un éditeur peut inclure la configuration en utilisant une syntaxe similaire à celle-ci:
<amp-analytics config="https://my-awesome-tag-manager.example.com/user-id.json" > </amp-analytics> >
Pour adopter cette approche, consultez la documentation sur l'intégration d'AMP Analytics par les éditeurs.
Autres ressources
- Approfondissement: Pourquoi ne pas simplement utiliser une iframe?
- Approfondissement: Gérer l'état des utilisateurs non authentifiés avec AMP
- amp-analytics sample
- documentation de référence amp-analytics
- documentation de référence sur les variables amp-analytics