שליחת תבנית לגלריית תבניות הקהילה

גלריית התבניות לקהילה של Google Tag Manager מאפשרת לארגון ליצור ולנהל תבניות של תגים ומשתנים שמשולבים באופן מקורי עם Google Tag Manager. הארגון שלכם יכול ליצור תבנית, לפרסם את מאגר התבניות ב-GitHub ולאחר מכן לשלוח את התבנית לגלריית התבניות של הקהילה כדי שהיא תהיה זמינה למשתמשים ברחבי העולם. היתרונות לארגון כוללים:

• הלקוחות יוכלו להוסיף את התבניות שלכם ולהשתמש בהן בקלות.
• משתמשי Tag Manager ייחשפו למותג של הארגון.
• הלקוחות שלכם יוכלו לפרוס את התגים תוך דקות, ולא תוך חודשים.
• אתם יכולים לפרסם עדכונים בתבניות שלכם ולהפוך את העדכונים האלה לזמינים באופן אוטומטי ללקוחות שלכם.

התהליך לשליחת תבנית חדשה לגלריית התבניות של הקהילה כולל את השלבים העיקריים הבאים:

1. יצירת התבנית
2. הכנת קובצי הפרויקט
3. העלאת הקבצים ל-GitHub
4. שליחת התבנית

יצירת התבנית

כדי להתחיל, יוצרים את התבנית ב-Google Tag Manager כתבנית בהתאמה אישית. חשוב לוודא שהתבנית נבדקה לעומק, שהתוכן שלה עומד בדרישות של מדריך הסגנון ושיש לכם תוכנית או תהליך לתחזוקה ולעדכון של התבנית, למקרה שתצטרכו לעשות זאת בעתיד.

תנאים והגבלות

כל שליחת תבנית חדשה חייבת להיות כפופה לתנאים ולהגבלות של גלריית התבניות לקהילות של Google Tag Manager. כדי לאשר את הסכמתכם לתנאים ולהגבלות של התבנית:

1. התנאים וההגבלות של גלריית התבניות לקהילות של Google Tag Manager
2. פותחים את התבנית לצורך עריכה בכלי לעריכת התבניות ומסמנים את התיבה הסכמה לתנאים ולהגבלות של גלריית התבניות של הקהילה בכרטיסייה מידע.

ייצוא התבנית

אחרי שהתבנית מוכנה, מייצאים את קובץ התבנית למחשב המקומי ומעניקים לקובץ את השם template.tpl.

הכנת קבצי הפרויקט

בשלב הבא, עליכם להכין את המאגר לפרסום ב-GitHub. כל מאגר צריך להכיל את הקבצים הבאים:

1. קובץ תבנית שיוצאו בשם template.tpl. צריך לעדכן את הקובץ הזה כדי להוסיף רשומה של categories.
2. קובץ metadata.yaml.
3. קובץ LICENSE. שם הקובץ חייב להיות באותיות רישיות, ותוכן קובץ הרישיון חייב להיות רק Apache 2.0.
4. מוסיפים קובץ README.md (אופציונלי, אבל מומלץ).

הערה: אפשר להשתמש במאגר התבניות לדוגמה ב-GitHub כמודל. מעתיקים את הקובץ LICENSE מהתבנית לדוגמה לפרויקט כדי לוודא בוודאות שאין שגיאות בתוכן, ומעדכנים את השורה 'זכויות יוצרים' שבה כתוב 'Copyright [yyyy] [name of copyright owner]' בגרסה לדוגמה. מחליפים את yyyy בשנת זכויות היוצרים ואת [name of copyright owner] בשם של בעלי זכויות היוצרים.

הוספת קטגוריות ל-template.tpl

מעדכנים את הקובץ template.tpl עם רשומה categories בקטע INFO, ומספקים לפחות ערך קטגוריה רלוונטי אחד שנבחר מהטבלה הבאה. אם יש יותר מקטגוריה אחת שמתאימה, אפשר לספק עד שלושה ערכים של קטגוריות, בסדר מהקטגוריה הרלוונטית ביותר לקטגוריה הכי פחות רלוונטית.

הערה: הערכים של הרשומה categories צריכים להיות בפורמט של מערך.

דוגמה:

___INFO___

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

טבלה של ערכי הקטגוריות הנתמכים:

קטגוריה	תיאור
פרסום	פרסום
AFFILIATE_MARKETING	שיווק שותפים
ניתוח נתונים	Analytics
ייחוס	שיוך (Attribution)
צ'אט	צ'אט
לאחר אופטימיזציה	מעקב המרות
DATA_WAREHOUSING	מחסן נתונים (data warehouse)
EMAIL_MARKETING	שיווק בדוא"ל
ניסויים	ניסויים מסוג A/B ואופטימיזציה של תוכן
HEAT_MAP	מפות חום
LEAD_GENERATION	יצירת לידים
שיווק	שיווק
התאמה אישית	התאמה אישית
שיווק מחדש	רימרקטינג
מכירות	מכירות וניהול קשרי לקוחות
SESSION_RECORDING	הקלטות של סשנים
חברתי	רשתות חברתיות
סקר	סקרים
TAG_MANAGEMENT	מערכות ניהול תגים
שימושי	כלי Google Tag Manager

metadata.yaml

קובץ metadata.yaml מכיל מידע על התבנית, כולל קישורים לדף הבית של הארגון, למסמכי העזרה של התבנית ולפרטי הגרסה. כל גרסה מסומנת במספר שינוי, שנקרא גם מספר SHA, שהוא מספר השינוי שמשויך ל-commit ב-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 בסדר כרונולוגי הפוך (מהגרסה העדכנית ביותר לגרסת המקור).

הערה: לא כל השינויים המצטברים צריכים להיכלל כשינוי גרסה בגלריה של התבניות לקהילה. לדוגמה, אם מבצעים שינויים מצטברים ב-commit 1, ב-commit 2 וב-commit 3, והגרסה הסופית היא commit 4, צריכה להיות רק רשומה אחת ל-commit 4 שכוללת את כל השינויים מ-commit 1, מ-commit 2 ומ-commit 3.

העברת המאגר

אם אתם רוצים לשנות את הבעלים או את השמות של המאגרים, תוכלו להשתמש בתהליך ההעברה של מאגרים ב-GitHub. המיקום החדש יזוהה והמשתמשים יועברו באופן אוטומטי למאגר החדש בפעם הבאה שהם יעדכנו את התבנית.

הסרת התבנית

כדי להסיר תבנית מהגלריה, מוחקים את הקובץ LICENSE או את הקובץ metadata.yaml מהמאגר שלו. מערכת המעקב אחרי הגלריה תזהה את השינוי הזה ותסיר את התבנית באופן אוטומטי.