Отправить шаблон в галерею шаблонов сообщества

Галерея шаблонов сообщества Диспетчера тегов Google позволяет вашей организации создавать и управлять шаблонами тегов и переменных, которые изначально интегрируются с Диспетчером тегов 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 (необязательно, но рекомендуется).

Примечание. В качестве модели используйте репозиторий примеров шаблонов на GitHub. Скопируйте файл LICENSE из образца шаблона в свой проект, чтобы быть абсолютно уверенным в отсутствии ошибок в содержимом, и обязательно обновите строку Copyright, где указано « Copyright [yyyy] [name of copyright owner] » в образце версии. Замените yyyy годом авторского права и [name of copyright owner] авторских прав.

Добавьте категории в template.tpl

Обновите файл template.tpl , добавив в раздел INFO запись о categories , и укажите хотя бы одно соответствующее значение категории, выбранное из следующей таблицы. Если подходит более одной категории, вы можете указать до трех значений категорий, упорядоченных от наиболее релевантных до наименее релевантных.

Примечание. Значения для записи categories должны быть отформатированы как массив.

Пример:

___INFO___

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

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

Категория	Описание
РЕКЛАМА	Реклама
ПАРТНЕРСКИЙ МАРКЕТИНГ	Партнерский маркетинг
АНАЛИТИКА	Аналитика
АВТОРСТВО	Атрибуция
ЧАТ	Чат
КОНВЕРСИИ	Измерение конверсии
ХРАНИЛИЩЕ ДАННЫХ	Хранилище данных
РЕКЛАМНАЯ РАССЫЛКА	Рекламная рассылка
ЭКСПЕРИМЕНТ	A/B-эксперименты и оптимизация контента
ТЕПЛОВАЯ КАРТА	Тепловые карты
LEAD_GENERATION	Лидогенерация
МАРКЕТИНГ	Маркетинг
ПЕРСОНАЛИЗАЦИЯ	Персонализация
РЕМАРКЕТИНГ	Ремаркетинг
ПРОДАЖИ	Продажи и CRM
СЕАНС_ЗАПИСЬ	Записи сеансов
СОЦИАЛЬНОЕ	Социальное
ОПРОС	Опросы
TAG_MANAGEMENT	Системы управления тегами
ПОЛЕЗНОСТЬ	Утилиты Диспетчера тегов Google

метаданные.yaml

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

Чтобы настроить файл metadata.yaml :

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

Важно: sha и changeNotes должны быть выровнены, как показано в приведенном выше примере кода.

Примечание. Значение sha должно ссылаться на конкретный файл template.tpl, который вы хотите опубликовать. Не забывайте корректно обновлять это значение с каждой новой версией !

Загрузить на GitHub

Следующим шагом будет загрузка файлов на GitHub. Создайте репозиторий GitHub с соответствующими файлами и структурой, как описано выше .

В репозиториях шаблонов должны быть файлы * template.tpl , metadata.yaml и LICENSE , находящиеся на корневом уровне репозитория Git. В каждом репозитории Git должен быть только один файл template.tpl . Все ресурсы должны находиться в основной ветке вашего репозитория GitHub. Любой репозиторий шаблонов, не соответствующий этой структуре, будет удален из Галереи.

Каждая запись в галерее шаблонов сообщества будет ссылаться на раздел « Проблемы » репозитория шаблона GitHub, чтобы пользователи могли сообщить вам, если обнаружат ошибку. Убедитесь, что проблемы не отключены для репозитория GitHub вашего шаблона, чтобы вы могли просматривать и устранять любые возникающие проблемы.

Отправьте свой шаблон

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

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

Обновите свой шаблон

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

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

1. Найдите фиксацию, содержащую изменения, которые вы хотите отправить, и скопируйте номер SHA. Простой способ сделать это в GitHub — перейти к представлению фиксации и щелкнуть значок буфера обмена ( ). Это скопирует весь номер SHA в буфер обмена.
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.

Важно: Каждая опубликованная версия шаблона должна быть включена в раздел versions в обратном хронологическом порядке (от самой последней к самой старой).

Примечание. Не каждую инкрементную фиксацию необходимо включать в качестве изменения версии в галерею шаблонов сообщества. Например, если вы вносите добавочные изменения в коммиты 1, 2 и 3, а окончательная версия — коммит 4, у вас должна быть только одна запись для коммита 4, которая включает все изменения из коммитов 1, 2 и 3.