Как отправить шаблон в галерею общедоступных шаблонов

В галерее общедоступных шаблонов сотрудники вашей организации могут создавать теги и шаблоны переменных, совместимые с Google Менеджером тегов, и управлять ими. Вы можете создать шаблон, опубликовать репозиторий шаблонов на сайте GitHub, а затем отправить шаблон в галерею, чтобы сделать его доступным для пользователей во всем мире. Ваша организация получает следующие преимущества:

  • клиенты могут с легкостью добавлять и использовать ваши шаблоны;
  • пользователи Менеджера тегов знакомятся с вашим брендом;
  • клиенты могут развертывать теги всего за несколько минут;
  • вы сможете публиковать обновления шаблонов и автоматически делать их доступными для клиентов.

Отправка нового шаблона в галерею общедоступных шаблонов включает следующие основные этапы:

  1. Создание шаблона
  2. Подготовка файлов проекта
  3. Загрузка файлов на сайт GitHub
  4. Отправка шаблона

Создание шаблона

Создайте специальный шаблон в Google Менеджере тегов. Убедитесь, что ваш шаблон тщательно протестирован, его содержимое отвечает требованиям руководства, а также разработайте план или процесс по обслуживанию и обновлению шаблона в будущем (при необходимости).

Условия использования

При отправке нового шаблона вам нужно принять Условия использования галереи общедоступных шаблонов Google Менеджера тегов. Чтобы подтвердить свое согласие с Условиями использования для шаблона, выполните следующие действия:

  1. Прочитайте Условия использования галереи общедоступных шаблонов Google Менеджера тегов.
  2. Откройте шаблон в редакторе шаблонов и установите флажок Я принимаю Условия использования галереи общедоступных шаблонов на вкладке Информация.

Экспорт шаблона

После создания шаблона экспортируйте его файл на локальный компьютер и присвойте ему название template.tpl.

Подготовка файлов проекта

Подготовьте репозиторий для публикации на сайте GitHub. Каждый репозиторий должен содержать следующие файлы:

  1. Файл экспортированного шаблона с названием template.tpl. Измените файл, добавив запись categories.
  2. Файл metadata.yaml.
  3. Файл LICENSE. Название файла должно включать только ЗАГЛАВНЫЕ БУКВЫ, а содержимое файла лицензии должно относиться только к Apache 2.0.
  4. Добавьте файл README.md (необязательно, но рекомендуется).

Как добавить категории в файл template.tpl

В файле template.tpl добавьте запись categories в раздел INFO и укажите по меньшей мере одно подходящее значение категории из приведенной ниже таблицы. При необходимости вы можете указать до трех категорий (в порядке уменьшения приоритета).

Пример

___INFO___

{
  "displayName": "Example Template",
  "categories": ["AFFILIATE_MARKETING", "ADVERTISING"],
  // additional template properties, etc...
}

Таблица поддерживаемых значений категорий

Категория Описание
ADVERTISING Реклама
AFFILIATE_MARKETING Партнерский маркетинг
ANALYTICS Аналитика
ATTRIBUTION Атрибуция
CHAT Чат
CONVERSIONS Отслеживание конверсий
DATA_WAREHOUSING Хранение данных
EMAIL_MARKETING Маркетинг по электронной почте
EXPERIMENTATION A/B-эксперименты и оптимизация контента
HEAT_MAP Тепловые карты
LEAD_GENERATION Поиск потенциальных клиентов
MARKETING Маркетинг
PERSONALIZATION Персонализация
REMARKETING Ремаркетинг
SALES Продажи и CRM
SESSION_RECORDING Записи сеансов
SOCIAL Социальные сети
SURVEY Опросы
TAG_MANAGEMENT Системы управления тегами
UTILITY Утилиты Google Менеджера тегов

Файл metadata.yaml

Файл metadata.yaml содержит информацию о вашем шаблоне, в том числе ссылки на главную страницу вашей организации, документацию по шаблону и сведения о версии. Каждой версии присваивается номер изменения (номер SHA), который связан с фиксацией Git. Поле changeNotes не является обязательным, но его рекомендуется заполнять, чтобы пользователи могли узнать об изменениях в версии.

Чтобы настроить файл metadata.yaml, выполните следующие действия:

  1. Добавьте запись homepage – URL главной страницы сайта вашей организации.
  2. Добавьте запись documentation – URL документации вашего шаблона.
  3. На сайте GitHub найдите фиксацию с изменениями, которые вы хотите добавить в первоначальную версию шаблона, и скопируйте номер SHA. Для этого на GitHub перейдите к представлению фиксаций и нажмите на значок буфера обмена (значок буфера обмена). Вставьте номер SHA в значение записи sha в качестве дочернего элемента узла versions, как показано ниже.
  4. Добавьте запись 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.

Каждая запись в галерее общедоступных шаблонов будет включать ссылку на раздел Issues (Проблемы) репозитория GitHub для шаблона, чтобы при необходимости пользователи могли сообщить вам об ошибке. Убедитесь, что эта функция не отключена для репозитория GitHub вашего шаблона, иначе вы не сможете узнавать о проблемах и исправлять их.

Отправка шаблона

После размещения репозитория шаблона на сайте GitHub вы можете отправить шаблон в галерею общедоступных шаблонов. Для этого выполните следующие действия:

  1. Войдите в аккаунт GitHub, имеющий доступ к репозиторию шаблона, который вы хотите добавить в галерею.
  2. Перейдите на страницу галереи общедоступных шаблонов по адресу tagmanager.google.com/gallery.
  3. Нажмите и выберите Отправить шаблон.
  4. В поле URL хранилища укажите URL репозитория GitHub и нажмите Отправить.

Обновление шаблона

После публикации шаблона вам, возможно, понадобится время от времени вносить в него изменения. Пользователи будут уведомлены об изменении шаблона и при желании смогут обновиться до последней версии.

Файл metadata.yaml определяет, какая версия шаблона будет использоваться в галерее. Чтобы опубликовать новые версии, вам нужно добавить номер изменения (номер SHA) в раздел versions файла metadata.yaml.

  1. Найдите фиксацию с изменениями, которые вы хотите добавить, и скопируйте номер SHA. Для этого на сайте GitHub перейдите к представлению фиксаций и нажмите на значок буфера обмена (значок буфера обмена).
  2. Добавьте новую запись sha в начало списка versions в файлmetadata.yaml (см. пример ниже).
  3. Добавьте changeNotes, чтобы коротко описать изменения в новой версии. При необходимости можно создавать многострочные комментарии (см. пример ниже).
  4. Зафиксируйте изменение в файле 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.