Галерея шаблонов сообщества Google Tag Manager позволяет вашей организации создавать и управлять шаблонами тегов и переменных, которые изначально интегрируются с Google Tag Manager. Ваша организация может создать шаблон, опубликовать репозиторий шаблонов на GitHub, а затем отправить свой шаблон в Галерею шаблонов сообщества, чтобы сделать его доступным для пользователей по всему миру. Преимущества для вашей организации включают:
- Ваши клиенты смогут легко добавлять и использовать ваши шаблоны.
- Пользователи Менеджера тегов увидят бренд вашей организации.
- Ваши клиенты смогут развернуть ваши теги в течение нескольких минут, а не месяцев.
- Вы можете публиковать обновления своих шаблонов и делать эти обновления автоматически доступными для своих клиентов.
Процесс отправки нового шаблона в Галерею шаблонов сообщества включает в себя следующие основные этапы:
- Создайте свой шаблон
- Подготовьте файлы вашего проекта
- Загрузите ваши файлы на GitHub
- Отправьте свой шаблон
Создайте свой шаблон
Для начала создайте свой шаблон в Google Tag Manager как пользовательский шаблон . Убедитесь, что ваш шаблон был тщательно протестирован, что его содержимое соответствует Руководству по стилю , и что у вас есть план или процесс для поддержания и обновления вашего шаблона, если в будущем возникнет такая необходимость.
Условия обслуживания
Каждая новая отправка шаблона должна соответствовать Условиям обслуживания галереи шаблонов сообщества Google Tag Manager. Чтобы подтвердить согласие с Условиями обслуживания для вашего шаблона:
- Ознакомьтесь с Условиями обслуживания галереи шаблонов сообщества Google Tag Manager .
- В редакторе шаблонов откройте шаблон для редактирования и установите флажок на вкладке « Информация» с надписью «Согласен с Условиями обслуживания галереи шаблонов сообщества» .
Экспортируйте свой шаблон
После завершения создания шаблона экспортируйте файл шаблона на локальный компьютер и переименуйте файл template.tpl
.
Подготовьте файлы вашего проекта
Следующий шаг — подготовить ваш репозиторий для публикации на GitHub. Каждый репозиторий должен содержать следующие файлы:
- Экспортированный файл шаблона с именем
template.tpl
. Этот файл необходимо обновить, чтобы добавить записьcategories
. - Файл
metadata.yaml
. - Файл
LICENSE
. Имя файла должно быть ВСЕМИ ЗАГЛАВНЫМИ БУКВАМИ, а содержимое файла лицензии должно быть только Apache 2.0 . - Добавьте файл
README.md
(необязательно, но рекомендуется).
Добавить категории в template.tpl
Обновите файл template.tpl
, добавив в раздел INFO
запись categories
, и укажите хотя бы одно релевантное значение категории, выбранное из следующей таблицы. Если подходит более одной категории, вы можете указать до трех значений категории, упорядоченных от наиболее релевантных до наименее релевантных.
Пример:
___INFO___
{
"displayName": "Example Template",
"categories": ["AFFILIATE_MARKETING", "ADVERTISING"],
// additional template properties, etc...
}
Таблица поддерживаемых значений категорий:
Категория | Описание |
---|---|
РЕКЛАМА | Реклама |
АФФИЛИАТ_МАРКЕТИНГ | Партнерский маркетинг |
АНАЛИТИКА | Аналитика |
АТРИБУЦИЯ | Атрибуция |
ЧАТ | Чат |
КОНВЕРСИИ | Измерение конверсии |
ХРАНЕНИЕ_ДАННЫХ | Хранилище данных |
МАРКЕТИНГ_ЭЛЕКТРОННОЙ ПОЧТЫ | Маркетинг по электронной почте |
ЭКСПЕРИМЕНТИРОВАНИЕ | Эксперименты A/B и оптимизация контента |
ТЕПЛОВАЯ_КАРТА | Тепловые карты |
ГЕНЕРАЦИЯ_ЛИДОВ | Генерация лидов |
МАРКЕТИНГ | Маркетинг |
ПЕРСОНАЛИЗАЦИЯ | Персонализация |
РЕМАРКЕТИНГ | Ремаркетинг |
ПРОДАЖИ | Продажи и CRM |
ЗАПИСЬ_СЕАНСА | Записи сеансов |
СОЦИАЛЬНЫЕ | Социальный |
ОПРОС | Опросы |
УПРАВЛЕНИЕ_ТЕГОМ | Системы управления тегами |
ПОЛЕЗНОСТЬ | Утилиты Google Tag Manager |
метаданные.yaml
Файл metadata.yaml
содержит информацию о вашем шаблоне, включая ссылки на домашнюю страницу вашей организации, документацию шаблона и информацию о версии. Каждая версия обозначается номером изменения, также известным как номер SHA, который является номером изменения, связанным с коммитом Git. Поле changeNotes
необязательно, но рекомендуется для информирования пользователей об изменениях, включенных в версию.
Чтобы настроить файл metadata.yaml
:
- Добавьте
homepage
записи. Это должен быть URL-адрес, указывающий на домашнюю страницу вашей организации. - Добавьте запись для
documentation
. Это должен быть URL, указывающий на документацию для вашего шаблона. - В GitHub найдите коммит, включающий изменения, которые вы хотите отправить для вашей первоначальной версии шаблона, и скопируйте номер SHA. Простой способ получить номер SHA в GitHub — перейти к просмотру коммита и щелкнуть значок буфера обмена (
). Это скопирует весь номер SHA в буфер обмена. Вставьте этот номер в качестве значения для вашей записи
sha
в качестве дочернего элемента узлаversions
, как показано ниже. - Добавьте запись
changeNotes
в узелversions
, чтобы кратко описать изменения, содержащиеся в этой новой версии.
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
- sha: 5f02a788b90ae804f86b04aa24af8937e567874a
changeNotes: Initial release.
Загрузить на GitHub
Следующий шаг — загрузить файлы на GitHub. Создайте репозиторий GitHub с соответствующими файлами и структурой, как описано выше .
Репозитории шаблонов должны иметь файлы * template.tpl
, metadata.yaml
и LICENSE
, находящиеся на корневом уровне репозитория Git. Каждый репозиторий Git должен иметь только один файл template.tpl
. Все ресурсы должны находиться в основной ветке вашего репозитория GitHub. Любой репозиторий шаблонов, который не соответствует этой структуре, будет удален из Галереи.
Каждая запись в галерее шаблонов сообщества будет ссылаться на раздел Issues репозитория шаблона GitHub, чтобы пользователи могли сообщить вам, если они найдут ошибку. Убедитесь, что Issues не отключены для репозитория вашего шаблона GitHub, чтобы вы могли просматривать и решать любые возникающие проблемы.
Отправьте свой шаблон
После того, как ваш репозиторий шаблонов будет размещен на GitHub, вы можете приступить к отправке вашего шаблона в Community Template Gallery. Чтобы отправить ваш шаблон, выполните следующие действия:
- Убедитесь, что вы вошли в GitHub с учетной записью, имеющей доступ к репозиторию шаблонов, который вы хотите добавить в Галерею.
- Перейдите в Галерею шаблонов сообщества по адресу tagmanager.google.com/gallery .
- Нажмите more_vert и выберите «Отправить шаблон» .
- Укажите URL-адрес репозитория в соответствующем поле и нажмите «Отправить» .
Обновите свой шаблон
После публикации шаблона вы можете время от времени предоставлять обновления для вашего шаблона. Ваши пользователи шаблона будут уведомлены, если есть обновление шаблона, и будут иметь возможность обновить шаблон до последней версии .
Файл metadata.yaml
используется для определения версии вашего шаблона, которую следует использовать в галерее. Чтобы опубликовать новые версии, вам необходимо добавить номер изменения (номер SHA) в раздел versions
вашего файла metadata.yaml
.
- Найдите коммит, включающий изменения, которые вы хотите отправить, и скопируйте номер SHA. Самый простой способ сделать это в GitHub — перейти к просмотру коммита и щелкнуть значок буфера обмена (
). Это скопирует весь номер SHA в буфер обмена.
- Добавьте новую запись
sha
в начало спискаversions
вmetadata.yaml
. (См. пример ниже.) - Добавьте
changeNotes
, чтобы кратко описать изменения, содержащиеся в этой новой версии. При желании вы можете создать многострочные комментарии. (См. пример ниже.) - Зафиксируйте изменение в
metadata.yaml
, и ваше обновление появится в галерее, как правило, в течение 2–3 дней.
В этом примере показано, как добавить информацию о новой версии, включая номер SHA и примечания к изменениям:
homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
# Latest version
- sha: 5f02a788b90ae804f86b04aa24af8937e567874c
changeNotes: |2
Fix bug with the whatsamajig.
Improve menu options.
Update API calls.
# Older versions
- sha: 5f02a788b90ae804f86b04aa24af8937e567874b
changeNotes: Adds eject button.
- sha: 5f02a788b90ae804f86b04aa24af8937e567874a
changeNotes: Initial release.
Переместите свой репозиторий
Если вы хотите изменить владельцев или имена репозиториев, вы можете использовать процесс переноса репозитория GitHub . Новое местоположение будет обнаружено, и пользователи будут автоматически перенаправлены в новый репозиторий при следующем обновлении шаблона.
Удалить ваш шаблон
Чтобы удалить шаблон из галереи, удалите либо файл LICENSE
, либо файл metadata.yaml
из его репозитория. Система мониторинга галереи обнаружит это изменение и автоматически удалит шаблон.