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

גלריית התבניות לקהילות של 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	Analytics
ייחוס	שיוך (Attribution)
צ'אט	צ'אט
לאחר אופטימיזציה	מעקב המרות
DATA_WAREHOUSING	מחסן נתונים
EMAIL_MARKETING	שיווק בדוא"ל
ניסויים	ניסויי A/B ואופטימיזציה של תוכן
HEAT_MAP	מפות חום
LEAD_GENERATION	יצירת לידים
שיווק	שיווק
PERSONALIZATION	התאמה אישית
שיווק מחדש	רימרקטינג
מכירות	מכירות וניהול קשרי לקוחות (CRM)
SESSION_RECORDING	הקלטות של סשנים
חברתי	רשתות חברתיות
סקר	סקרים
TAG_MANAGEMENT	מערכות לניהול תגים
שימושיות	כלי השירות של Google Tag Manager

metadata.yaml

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

כל רשומה בגלריית תבניות הקהילה תכלול קישור לקטע Issues במאגר GitHub של התבנית, כדי שהמשתמשים יוכלו להודיע לכם אם הם ימצאו באג.

חשוב: מוודאים שהאפשרות Issues לא הושבתה במאגר 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 והעדכון יופיע בגלריה בדרך כלל תוך יומיים עד שלושה.

בדוגמה הזו מוסבר איך להוסיף פרטי גרסה חדשים, כולל מספר ה-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, 2 ו-3, והגרסה הסופית היא קומיט 4, צריך להיות רק רשומה אחת לקומיט 4 שכוללת את כל השינויים מקומיטים 1, 2 ו-3.

העברת המאגר

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

הסרת התבנית

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