Интеграция вашего инструмента аналитики с AMP
Important: this documentation is not applicable to your currently selected format email!
Обзор
Если вы — владелец инструмента SaaS («программное обеспечение как услуга»), позволяющего издателям лучше анализировать свой трафик и посетителей, вы можете интегрировать свой сервис в amp-analytics
. Такая интеграция позволит вашим клиентам изучать характер трафика на своих страницах AMP HTML.
Прежде чем начать
Прежде чем вы сможете добавить свой аналитический сервис в среду выполнения AMP HTML, вам может потребоваться выполнить следующее:
- Определите типы переменных и запросов, которые понадобятся вашей службе аналитики в документе AMP HTML.
- Определите триггеры, которые будут инициировать отправку со страницы необходимых вашему сервису аналитических запросов.
- Подумайте, будете ли вы отслеживать пользователей при переходе между собственным и сторонними контекстами AMP, и если да, то каким образом.
- Определите, как ваша панель аналитики будет обрабатывать AMP-трафик.
- Выявите все недостающие функции в
amp-analytics
и отправьте запросы на добавление необходимых функций. - AMP Analytics отправляет свои переменные в предварительно настроенную конечную точку. Если у вас еще нет существующей конечной точки, просмотрите этот пример, чтобы узнать, как создать ее.
- Для всех типов транспортировки, кроме
iframe
, переменные отправляются в виде параметров строки HTTPS-запроса. - Для типа транспортировки
iframe
создается элемент iframe создается и переменные направляются в него с помощью методаwindow.postMessage
. В этом случае сообщение не обязательно должно быть URL-адресом. Эта опция доступна только поставщикам, аккредитованным MRC. - Подумайте, как интеграция с
amp-analytics
может повлиять на ваши политики (в частности, политику конфиденциальности) или соглашения.
Добавление вашей конфигурации в среду выполнения AMP HTML
- Создайте задачу Intent-To-Implement, в которой говорится, что вы добавите конфигурацию своего аналитического сервиса в среду выполнения AMP HTML. Не забудьте включить в описание строку cc @ ampproject / wg-analytics.
- Разработайте патч, который реализует следующее:
- Новый конфигурационный JSON-файл
${vendorName}.json
в папке поставщиков, включая все опции, выходящие за стандартную конфигурацию, например:"vars": {}
для дополнительных переменных по умолчанию."requests": {}
для запросов, которые будет использовать ваш сервис."optout":
при необходимости. В настоящее время у нас нет универсальной системы отписки, поэтому свяжитесь с нами, чтобы помочь нам разработать ту, которая подойдет вам."warningMessage":
при необходимости. Отображает предупреждающую информацию от поставщика (например, об устаревании или миграции) в консоли.
- Если вы используете транспортировку в iframe, добавьте также новую строку в раздел ANALYTICS_IFRAME_TRANSPORT_CONFIG файла iframe-transport-vendors.js, содержащую
"*vendor-name*": "*url*"
- Пример в справочном файле examples/analytics-vendors.amp.html.
- Тест в файле extensions/amp-analytics/0.1/test/vendor-requests.json.
- Добавьте свой аналитический сервис в список поддерживаемых поставщиков в файле extensions/amp-analytics/0.1/analytics-vendors-list.md. Укажите его тип, описание и ссылку на документацию по использованию.
- Протестируйте новый пример, который вы поместили в examples/analytics-vendors.amp.html, чтобы убедиться, что обращения из примера работают должным образом — например, что необходимые данные собираются и отображаются на инструментальной панели вашего аналитического сервиса.
- Отправьте пул-реквест с этим патчем, указав ссылку на задачу Intent-To-Implement.
- Обновите документацию по использованию вашего сервиса и проинформируйте своих клиентов.
- Настоятельно рекомендуется проводить интеграционный тест вне репозитория AMP.
Менеджеры тегов
У сервисов управления тегами есть два варианта интеграции с AMP Analytics:
- Подход с использованием конечной точки: реализуется в виде дополнительной конечная точки для
amp-analytics
, управление маркетингом осуществляется в бэкенде. - Подход с использованием конфигурации: управление тегами осуществляется с помощью динамически генерируемого файла конфигурации JSON, уникального для каждого издателя.
Подход с использованием конечной точки идентичен стандартному подходу, описанному в предыдущем разделе. Подход с использованием конфигурации состоит из создания уникальной конфигурации для amp-analytics, которая является индивидуальной для каждого издателя и включает все совместимые с ним пакеты аналитики. Издатель включит конфигурацию, используя синтаксис, подобный следующему:
<amp-analytics config="https://my-awesome-tag-manager.example.com/user-id.json" > </amp-analytics> >
Чтобы воспользоваться этим подходом, ознакомьтесь с документацией по интеграции издателей с AMP Analytics.
Дополнительные ресурсы
- Детальный разбор: почему бы просто не использовать iframe?
- Детальный разбор: управление неаутентифицированным состоянием пользователя с помощью AMP
- Пример использования amp-analytics
- Справочная документация по amp-analytics
- Справочная документация по переменным amp-analytics