Prześlij szablon do Galerii szablonów społeczności

Galeria szablonów społeczności Menedżera tagów Google umożliwia organizacji tworzenie szablonów tagów i zmiennych, które są natywnie zintegrowane z Menedżerem tagów Google, oraz zarządzanie nimi. Twoja organizacja może utworzyć szablon, opublikować repozytorium szablonów na GitHubie, a następnie przesłać szablon do Galerii szablonów społeczności, aby udostępnić go użytkownikom na całym świecie. Korzyści dla Twojej organizacji:

• Klienci będą mogli łatwo dodawać i używać Twoich szablonów.
• Użytkownicy Menedżera tagów będą mieli kontakt z marką Twojej organizacji.
• Twoi klienci będą mogli wdrażać Twoje tagi w ciągu kilku minut, a nie miesięcy.
• Możesz publikować aktualizacje szablonów i udostępniać je automatycznie klientom.

Proces przesyłania nowego szablonu do Galerii szablonów obejmuje te główne kroki:

1. Tworzenie szablonu
2. Przygotowywanie plików projektu
3. Prześlij pliki do GitHuba
4. Przesyłanie szablonu

Tworzenie szablonu

Aby rozpocząć, utwórz szablon w Menedżerze tagów Google jako szablon niestandardowy. Upewnij się, że szablon został dokładnie przetestowany, jego zawartość jest zgodna ze wskazówkami redakcyjnymi oraz że masz plan lub proces, który pozwoli Ci w przyszłości utrzymywać i aktualizować szablon w razie potrzeby.

Warunki korzystania z usługi

Każde nowe przesłanie szablonu musi być zgodne z Warunkami korzystania z Galerii szablonów społeczności Menedżera tagów Google. Aby potwierdzić akceptację Warunków korzystania z usługi w przypadku szablonu:

1. Przeczytaj Warunki korzystania z Galerii szablonów w usłudze Menedżer tagów Google.
2. W Edytorze szablonów otwórz szablon do edycji i zaznacz pole na karcie Informacje o nazwie „Akceptuję Warunki korzystania z Galerii szablonów społeczności”.

Eksportowanie szablonu

Gdy szablon będzie gotowy, wyeksportuj plik szablonu na komputer lokalny i zmień jego nazwę na template.tpl.

Przygotowywanie plików projektu

Kolejny krok to przygotowanie repozytorium do opublikowania w GitHubie. Każde repozytorium powinno zawierać te pliki:

1. Wyeksportowany plik szablonu o nazwie template.tpl. Aby dodać wpis categories, musisz zaktualizować ten plik.
2. plik metadata.yaml.
3. plik LICENSE; Nazwa pliku musi być zapisana SAMYMI WIELKIMI LITERAMI, a zawartość pliku licencji musi wyłącznie zawierać licencję Apache 2.0.
4. Dodaj plik README.md (opcjonalny, ale zalecany).

Dodawanie kategorii do template.tpl

Zaktualizuj plik template.tpl, dodając wpis categories do sekcji INFO, i podaj co najmniej 1 odpowiednią wartość kategorii wybraną z tabeli poniżej. Jeśli pasuje więcej niż jedna kategoria, możesz podać maksymalnie 3 wartości kategorii, uporządkowane od najbardziej do najmniej trafnej.

Przykład:

___INFO___

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

Tabela obsługiwanych wartości kategorii:

metadata.yaml

Plik metadata.yaml zawiera informacje o szablonie, w tym linki do strony głównej organizacji, dokumentacji szablonu i informacji o wersji. Każda wersja jest oznaczona numerem zmiany, zwanym też numerem SHA, który jest numerem zmiany powiązanym z zatwierdzeniem Git. Pole changeNotes jest opcjonalne, ale zalecane, aby informować użytkowników o zmianach wprowadzonych w wersji.

Aby skonfigurować plik metadata.yaml:

1. Dodaj wpis homepage. Powinien to być adres URL strony głównej Twojej organizacji.
2. Dodaj wpis dla documentation. Powinien to być adres URL dokumentacji szablonu.
3. W GitHubie znajdź commit, który zawiera zmiany, które chcesz przesłać w pierwszej wersji szablonu, i skopiuj numer SHA. Aby łatwo uzyskać numer SHA w GitHubie, otwórz widok zatwierdzenia i kliknij ikonę schowka (). Spowoduje to skopiowanie całego numeru SHA do schowka. Wklej tę liczbę jako wartość wpisu sha jako elementu podrzędnego węzła versions, jak pokazano poniżej.
4. Dodaj wpis changeNotes do węzła versions, aby krótko opisać zmiany zawarte w tej nowej wersji.

homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

Przesyłanie do GitHuba

Następnym krokiem jest przesłanie plików do GitHub. Utwórz repozytorium GitHub z odpowiednimi plikami i strukturą zgodnie z opisem powyżej.

W przypadku repozytoriów szablonów pliki * template.tpl, metadata.yaml i LICENSE muszą znajdować się w głównym katalogu repozytorium Git. Każde repozytorium Git powinno zawierać tylko 1 plik template.tpl. Wszystkie zasoby muszą znajdować się w głównej gałęzi repozytorium GitHub. Każde repozytorium szablonów, które nie pasuje do tej struktury, zostanie usunięte z galerii.

Każdy wpis w Galerii szablonów społeczności będzie zawierać link do sekcji Problemy w repozytorium GitHub szablonu, aby użytkownicy mogli informować Cię o znalezionych błędach.

Przesyłanie szablonów

Gdy repozytorium szablonów będzie hostowane na GitHubie, możesz przesłać szablon do Galerii szablonów społeczności. Aby przesłać szablon, wykonaj te czynności:

1. Upewnij się, że logujesz się w GitHubie za pomocą konta, które ma dostęp do repozytorium szablonu, który chcesz dodać do galerii.
2. Otwórz Galerię szablonów społeczności na stronie tagmanager.google.com/gallery.
3. Kliknij more_vert i wybierz Prześlij szablon.
4. W odpowiednim polu podaj adres URL repozytorium i kliknij Prześlij.

Aktualizowanie szablonu

Po opublikowaniu szablonu możesz co jakiś czas wprowadzać w nim zmiany. Użytkownicy Twojego szablonu otrzymają powiadomienie o jego aktualizacji i będą mogli zaktualizować go do najnowszej wersji.

Plik metadata.yaml służy do określania, która wersja szablonu ma być używana w galerii. Aby opublikować nowe wersje, musisz dodać numer zmiany (numer SHA) do sekcji versions w pliku metadata.yaml.

1. Znajdź zatwierdzenie zawierające zmiany, które chcesz przesłać, i skopiuj numer SHA. Najłatwiej to zrobić w GitHubie. Wystarczy przejść do widoku zatwierdzenia i kliknąć ikonę schowka (). Spowoduje to skopiowanie całego numeru SHA do schowka.
2. Dodaj nowy wpis sha na górze listy versions w metadata.yaml. (Zobacz przykład poniżej).
3. Dodaj changeNotes, aby krótko opisać zmiany zawarte w tej nowej wersji. W razie potrzeby możesz tworzyć komentarze wielowierszowe. (Zobacz przykład poniżej).
4. Zatwierdź zmianę w metadata.yaml, a aktualizacja pojawi się w galerii zwykle w ciągu 2–3 dni.

Ten przykład pokazuje, jak dodać informacje o nowej wersji, w tym numer SHA i notatki o zmianach:

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.

Przenoszenie repozytorium

Jeśli chcesz zmienić właścicieli lub nazwy repozytoriów, możesz skorzystać z procesu przenoszenia repozytorium GitHub. Nowa lokalizacja zostanie wykryta, a użytkownicy zostaną automatycznie przekierowani do nowego repozytorium przy następnej aktualizacji szablonu.

Usuwanie szablonu

Aby usunąć szablon z galerii, usuń z repozytorium plik LICENSE lub plik metadata.yaml. System monitorowania galerii wykryje tę zmianę i automatycznie usunie szablon.