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

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

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

Процесс добавления нового шаблона в Галерею шаблонов сообщества включает в себя следующие основные шаги:

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

Создайте свой шаблон

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

Условия предоставления услуг

Каждый новый шаблон, добавленный в сообщество, должен соответствовать условиям использования галереи шаблонов Google Tag Manager Community Template Gallery. Чтобы подтвердить согласие с условиями использования вашего шаблона:

1. Ознакомьтесь с условиями использования галереи шаблонов сообщества Google Tag Manager .
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...
}

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

metadata.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.

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

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

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

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

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

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

1. Убедитесь, что вы вошли в GitHub с учетной записью, имеющей доступ к репозиторию шаблонов, который вы хотите добавить в Галерею.
2. Перейдите в Галерею шаблонов сообщества по адресу tagmanager.google.com/gallery .
3. Нажмите more_vert и выберите «Отправить шаблон» .
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.

Переместите свой репозиторий

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

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

Чтобы удалить шаблон из галереи, удалите из его репозитория либо файл LICENSE , либо файл metadata.yaml . Система мониторинга галереи обнаружит это изменение и автоматически удалит шаблон.