קובץ עזר ל-extension.yaml

קובץ המפרט של התוסף (extension.yaml) מכיל את המטא-נתונים של התוסף, מצהיר על המשאבים שנוצרו על ידי התוסף ועל ממשקי ה-API והגישה שנדרשים לתוסף, ומגדיר את כל הפרמטרים שמוגדרים על ידי המשתמש ומסופקים על ידי התוסף.

בטבלאות שבדף הזה מתוארים השדות הזמינים לקובץ extension.yaml.

מידע בסיסי ומזהה

name: your-extension-name
version: 1.0.0         # Semantic versioning (semver)
specVersion: v1beta    # Always "v1beta"
license: Apache-2.0    # Always "Apache-2.0" (required to publish on extensions.dev)
billingRequired: true  # Always "true"

displayName: Your extension name
description: >-
  Description of the extension. (One or two
  sentences.)
icon: icon.png
tags: [tag, anothertag]

sourceUrl: https://github.com/your-org/your-repo   # GitHub repo URL
releaseNotesUrl: https://github.com/your-org/your-repo/blob/main/CHANGELOG.md

author:
  authorName: Your Company
  email: extensions@example.com
  url: https://example.com/
contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: colleague@example.net
    url: https://github.com/their-org/
שדות בסיסיים
name
string
(חובה)

מזהה של התוסף.

יכול להכיל רק אותיות קטנות, מספרים ומקפים. מגבלת התווים היא 40 תווים.

הערה: הערך הזה משמש ליצירת מזהה המכונה של התוסף (כלומר, כדי ליצור את השמות של חשבון השירות של התוסף ושל המשאבים הספציפיים לתוספים).

version
string
(חובה)

גרסת התוסף.

חייבת להיות תואמת למערכת semver למתן גרסאות (לדוגמה, 1.2.0).
specVersion
string
(חובה)

גרסת מפרט התוספים ל-Firebase.

הערך הנוכחי: v1beta
license
string
(אופציונלי)

הרישיון של התוסף.

צריך להנפיק רישיון לתוסף באמצעות Apache-2.0.
billingRequired
boolean
(אופציונלי)

האם השירותים שבהם התוסף משתמש דורשים חשבון לחיוב ב-Firebase ברמה בתשלום.

הערך תמיד מוגדר ל-true.
displayName
string
(אופציונלי)

שם תצוגה ידידותי של התוסף (3-5 מילים).

מגבלה של 40 תווים.
description
מחרוזת
(אופציונלי) 		תיאור קצר של המשימה שהתוסף מבצע (משפט אחד בערך).
icon
string
(אופציונלי)

קובץ שישמש כסמל של התוסף ב-extensions.dev ובמסוף Firebase.

הקובץ הזה חייב להיות קובץ PNG מרובע בגודל שבין 512x512 ל-1,024x1,024 פיקסלים. צריך לשמור את הקובץ באותה ספרייה כמו extension.yaml. אי אפשר לציין ספריית משנה.

כשמעצבים סמל לתוסף, חשוב לזכור את ההנחיות הבאות:

  • בוחרים צבעים לרקע ולגרפיקה שמתאימים למותג.
  • כדאי ליצור צבעי סמל פשוטים וב-2 צבעים בלבד. שימוש בכמה צבעים יכול להפוך את הסמל למסובך מדי מבחינה ויזואלית.
  • מאותה סיבה, אין להשתמש בהדרגהים בסמל שלכם. קשה להבחין בגוונים משתנים בגדלים קטנים, והם הופכים את הסמל למורכב מבחינה חזותית.
  • כדאי להשתמש בתמונות פשוטות וייחודיות שממחישות את הפונקציונליות של התוסף.
  • אם החברה שלכם מפתחת כמה תוספי מודעות, אל תשתמשו בלוגו בתור הסמל. המשתמשים יתקשו להבדיל בין התוספים שלכם.
  • כדאי שהגרפיקה תהיה בולטת. לא להשתמש בגרפיקות עדינות או מורכבות, כי הן לא ייראו טוב בגדלים קטנים יותר.
  • אין לכלול מילים שמסבירות מה התוסף עושה. לעיתים קרובות אי אפשר לקרוא טקסט בגדלים קטנים.
tags
רשימת מחרוזות
(אופציונלי) 		תגים שיעזרו למשתמשים לגלות את התוסף. התגים הבאים ממופים לקטגוריות במרכז התוספים: marketing, messaging, payments, search, shipping, social, utilities, ai
sourceUrl
string
(אופציונלי) 		כתובת URL ציבורית שבה אפשר לגשת לספריית התוספים.
releaseNotesUrl
string
(אופציונלי) 		כתובת URL ציבורית שבה אפשר לגשת למידע על הגרסה של התוסף.
author
אובייקט author אחד
(אופציונלי)

המחבר הראשי ואיש הקשר של התוסף.

author:
  authorName: Your Company
  email: extensions@example.com
  url: https://example.com/
שדות המחבר
authorName
מחרוזת
(חובה)

שם המחבר.

יכול להיות אדם, חברה, ארגון וכו'.
email
מחרוזת
(אופציונלי) 		כתובת האימייל של המחבר.
url
מחרוזת
(אופציונלי) 		כתובת URL ציבורית שבה ניתן לגשת למידע על המחבר.
contributors
רשימת אובייקטים של מחבר
(אופציונלי)

מחברים תורמים נוספים של התוסף.

contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: colleague@example.net
    url: https://github.com/their-org/
שדות המחבר
authorName
מחרוזת
(חובה)

שם המחבר.

יכול להיות אדם, חברה, ארגון וכו'.
email
מחרוזת
(אופציונלי) 		כתובת האימייל של המחבר.
url
מחרוזת
(אופציונלי) 		כתובת URL ציבורית שממנה אפשר לגשת למידע על המחבר/ת.

ממשקי API של Firebase ו-Google Cloud

השדות האלה מציינים את ממשקי ה-API של Firebase ו-Google שבהם התוסף משתמש. כשמשתמשים מתקינים את התוסף, הם יכולים להפעיל באופן אוטומטי את ממשקי ה-API האלה בפרויקט שלהם.

apis:
  - apiName: apiname.googleapis.com
    reason: Explanation of why the extension uses this API
  - apiName: anotherapiname.googleapis.com
    reason: Explanation of why the extension uses this API
שדות API
apiName
string
(חובה)

שם Google API

השדה חייב להתאים לשדה שם השירות שמופיע בדף הסקירה הכללית של כל API (דוגמה) בספריית Google Cloud API.

reason
string
(חובה) 		תיאור קצר של הסיבה לכך שהתוסף צריך להשתמש ב-API הזה

תפקידי IAM

השדות האלה מציינים את תפקידי Cloud IAM שנדרשים לתוסף. חשבון השירות שהוקצה לתוסף מקבל את התפקידים האלה.

אפשר לציין רק אחד מהתפקידים הנתמכים.

roles:
  - role: product.role
    reason: Explanation of why the extension needs this level of access
  - role: anotherproduct.role
    resource: projects/${project_id}/resource_type/*
    reason: Explanation of why the extension needs this level of access
שדות של תפקידים
role
string
(חובה)

שם תפקיד ה-IAM שנדרש כדי שהתוסף יפעל

חייב להיות אחד מהתפקידים הנתמכים

reason
string
(חובה) 		תיאור קצר של הסיבה לכך שהתוסף זקוק לגישה שמקבלים מהתפקיד הזה
resource
string
(אופציונלי)

מגבילים את היקף התפקיד למשאב הזה.

אם לא צוין ערך, ברירת המחדל היא projects/${project_id}. ראו צמצום היקף התפקידים.

שירותים חיצוניים

בשדות האלה מפורטים השירותים שאינם של Firebase ושירותים שאינם של Google שבהם התוסף משתמש (בדרך כלל ממשקי API ל-REST). פלטפורמת התוספים של Firebase לא מספקת אמצעי להפעלה אוטומטית של השירותים האלה או לביצוע הרשאה עבורם.

externalServices:
  - name: Example API
    pricingUri: https://developers.example.com/pricing
  - name: Another Example API
    pricingUri: https://developers.example.com/pricing
שדות של שירותים חיצוניים
name
string
(חובה) 		שם השירות החיצוני שנדרש כדי שהתוסף יפעל
pricingUri
string
(חובה) 		URI לפרטי התמחור של השירות

פרמטרים שניתן להגדיר על ידי משתמשים

השדות האלה מגדירים את הפרמטרים שהתוסף מאפשר למשתמשים להגדיר.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      What do you want to set PARAM_ID to?
      This is a longer description of the parameter, often phrased as a prompt
      to the user.
  - param: ANOTHER_PARAM_ID
    label: Short description of the parameter
    description: >
      What do you want to set ANOTHER_PARAM_ID to?
      This is a longer description of the parameter.
    example: example-input
    validationRegex: "^[a-zA-Z][a-zA-Z-]*[a-zA-Z]?$"
    validationErrorMessage:
      Must be a hyphen-delimited string of alphabetic characters
    default: default-value
    required: false
    immutable: true
שדות פרמטרים
param
string
(חובה) 		שם הפרמטר. השם הזה משמש להפניה לערך הפרמטר בקוד.
label
string
(חובה) 		תיאור קצר של הפרמטר. מוצג למשתמש כשמוצגת לו בקשה להזין את הערך של הפרמטר.
description
string
(אופציונלי)

תיאור מפורט של הפרמטר. מוצג למשתמש כשמוצגת בקשה להזין את ערך הפרמטר.

תמיכה ב-Markdown.
example
string
(אופציונלי) 		ערך לדוגמה של הפרמטר.
default
string
(אופציונלי) 		ערך ברירת המחדל של הפרמטר אם המשתמש משאיר את הערך של הפרמטר ריק.
validationRegex
מחרוזת
(אופציונלי) 		ביטוי רגולרי לאימות הערך שהוגדר על ידי המשתמש לפרמטר. תחביר של Google RE2.
validationErrorMessage
string
(אופציונלי) 		הודעת השגיאה שתוצג אם אימות הביטוי הרגולרי נכשל.
required
boolean
(אופציונלי) 		ההגדרה קובעת אם המשתמש יכול לשלוח מחרוזת ריקה כשמתבקשים להזין את הערך של הפרמטר. ברירת המחדל היא true.
immutable
boolean
(אופציונלי)

ההגדרה קובעת אם המשתמש יכול לשנות את הערך של הפרמטר אחרי ההתקנה (למשל, אם הוא מגדיר מחדש את התוסף). ברירת המחדל היא false.

הערה: אם מגדירים פרמטר 'location' לפונקציות הפרוסות של התוסף, צריך להגדיר את השדה הזה לערך true.
type
string
(אופציונלי) 		סוג הפרמטר. יכול להיות שלסוגים מיוחדים של פרמטרים יהיו דרישות נוספות או הצגה שונה של ממשק המשתמש. עיינו בקטעים הבאים.

פרמטרים שניתן לבחור אותם ופרמטרים שניתן לבחור כמה מהם

פרמטרים שניתן לבחור אותם או לבחור כמה מהם מאפשרים למשתמשים לבחור מתוך רשימה של אפשרויות מוגדרות מראש.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      Do you want to enable the option?
    type: select
    options:
      - label: Yes
        value: true
      - label: No
        value: false
  - param: ANOTHER_PARAM_ID
    label: Short description of the parameter
    description: >-
      Which options do you want to enable?
    type: multiselect
    options:
      - value: red
      - value: green
      - value: blue
שדות פרמטרים עם שאלות אמריקאיות
type
מחרוזת

select או multiselect

מציין שהפרמטר יכול להיות ערך אחד (select) או כמה ערכים (multiselect) שנבחרים מתוך קבוצה של אפשרויות מוגדרות מראש
options
רשימת אפשרויות
(חובה)

האפשרויות שמהן המשתמש יכול לבחור

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

פרמטרים של משאבים שניתן לבחור

פרמטרים של משאבים שניתן לבחור מאפשרים למשתמשים לבחור משאב (מכונה של מסד נתונים, קטגוריית אחסון וכו') מהפרויקט שלהם.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      Which resource do you want to use?
    type: selectresource
    resourceType: product.googleapis.com/ResourceType
שדות של פרמטרים של משאבים
type
מחרוזת

selectresource

מציין שהפרמטר מייצג משאב של פרויקט
resourceType
string
(חובה)

סוג המשאב שהמשתמש יתבקש לבחור.

הערכים האפשריים:

  • storage.googleapis.com/Bucket
  • firestore.googleapis.com/Database
  • firebasedatabase.googleapis.com/DatabaseInstance

עם זאת, רק לקטגוריות של Cloud Storage יש כרגע ממשק משתמש לבחירה (סוגי משאבים אחרים מוצגים כשדות להזנת טקסט בפורמט חופשי).

פרמטרים סודיים

ערכים סודיים שהמשתמשים סיפקו (כמו מפתחות API) מטופלים באופן שונה:

  • הערכים של הסודות מאוחסנים באמצעות Cloud Secret Manager. רק לקוחות מורשים (כמו מופע מותקן של תוסף) יכולים לגשת לערכים האלה.
  • כשהמשתמשים יתבקשו להזין את הערכים האלה, הקלט שלהם לא יוצג.
params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      What is the secret value?
    type: secret
שדות של פרמטרים סודיים
type
מחרוזת

secret

מציין שהפרמטר הוא ערך סודי

משאבים לפונקציה של Cloud Functions

בשדות האלה מוצהר על הפונקציות של Cloud Functions שכלולות בתוסף. התחביר של הצהרת המשאבים שונה מעט בין פונקציות מדור ראשון לבין פונקציות מדור שני, שיכולות להתקיים יחד בתוסף.

Cloud Functions מדור ראשון

resources:
  - name: functionName
    type: firebaseextensions.v1beta.function
    description: >-
      Description of what the function does. (One or two
      sentences.)
    properties:
      runtime: runtime-version
      eventTrigger:
        eventType: google.product.event
        resource: projects/_/resource/specifier
שדות משאבים
name
מחרוזת
(חובה)

שם ידידותי למשתמש של הפונקציה המיוצאת.

אם לא מציינים את המאפיין entryPoint (ראו בהמשך), הערך הזה חייב להתאים לשם הפונקציה בקוד המקור של הפונקציות.

השם הסופי של הפונקציה שפורסה יהיה בפורמט הבא: ext-extension-instance-id-name.
type
מחרוזת
(חובה) 		למשאב פונקציה מדור ראשון: firebaseextensions.v1beta.function
description
string
(חובה)

תיאור קצר של המשימה שהפונקציה מבצעת עבור התוסף.
properties
(חובה)

נכסי Cloud Functions מדור ראשון. המאפיינים החשובים ביותר מפורטים בהמשך, אבל אפשר למצוא את הרשימה המלאה בחומר העזר של Cloud Functions.

נכסים
location
(אופציונלי)

המיקום שבו רוצים לפרוס את הפונקציה. ברירת המחדל היא us-central1
entryPoint
(אופציונלי) 		השם של הפונקציה שמיוצאת בקוד המקור של הפונקציות, שהתוסף צריך לחפש. ערך ברירת המחדל הוא הערך של name, שמופיע למעלה.
sourceDirectory
(אופציונלי)

הספרייה שמכילה את package.json ברמה הבסיסית (root). הקובץ של קוד המקור של הפונקציות צריך להיות בתיקייה הזו. ברירת המחדל היא functions

הערה: השדה main ב-package.json מציין את הקובץ של קוד המקור של הפונקציות (כמו index.js).
timeout
(אופציונלי)

זמן הביצוע המקסימלי של הפונקציה.

  • ברירת מחדל: 60s
  • הערך המקסימלי: 540s
availableMemoryMb
(אופציונלי)

נפח הזיכרון (ב-MB) שזמין לפונקציה.

  • ברירת מחדל: 256
  • הערכים התקפים: 128,‏ 256,‏ 512,‏ 1024 ו-2048
runtime
(מומלץ)

סביבת זמן הריצה של הפונקציה.
httpsTrigger
or
eventTrigger
or
scheduleTrigger
or
taskQueueTrigger
(אחד מסוגי הטריגרים האלה לפונקציה נדרש) 		מידע ספציפי על כל סוג טריגר מופיע במאמר כתיבה של Cloud Functions עבור תוסף.

Cloud Functions מדור שני

resources:
  - name: functionName
    type: firebaseextensions.v1beta.v2function
    description: >-
      Description of what the function does. (One or two
      sentences.)
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: crashlytics.newFatalIssue
שדות המשאבים
name
מחרוזת
(חובה)

שם ידידותי למשתמש של הפונקציה המיוצאת.

אם לא מציינים את המאפיין entryPoint (ראו בהמשך), הערך הזה חייב להתאים לשם הפונקציה בקוד המקור של הפונקציות.

השם הסופי של הפונקציה שפורסה יהיה בפורמט הבא: ext-extension-instance-id-name.
type
string
(חובה) 		למשאב פונקציה מדור שני: firebaseextensions.v1beta.v2function
description
מחרוזת
(חובה)

תיאור קצר של המשימה שהפונקציה מבצעת עבור התוסף.
properties
(חובה)

נכסי Cloud Functions מדור שני. המאפיינים החשובים ביותר מפורטים בהמשך, אבל אפשר למצוא את הרשימה המלאה בחומר העזר של Cloud Functions.

נכסים
location
(אופציונלי)

המיקום שבו לפרוס את הפונקציה. ברירת המחדל היא us-central1
sourceDirectory
(אופציונלי)

הספרייה שמכילה את package.json ברמה הבסיסית (root). הקובץ של קוד המקור של הפונקציות צריך להיות בתיקייה הזו. ברירת המחדל היא functions

הערה: השדה main ב-package.json מציין את הקובץ של קוד המקור של הפונקציות (כמו index.js).

יש גם שלושה שדות מסוג אובייקט עם מאפיינים משלהם:

נכסי buildConfig
buildConfig.runtime
(מומלץ)

סביבת זמן הריצה של הפונקציה.
buildConfig.entryPoint
(אופציונלי) 		השם של הפונקציה שמיוצאת בקוד המקור של הפונקציות, והתוסף צריך לחפש אותו. ערך ברירת המחדל הוא הערך של name, שמופיע למעלה.
מאפייני serviceConfig
serviceConfig.timeoutSeconds
(אופציונלי)

משך ההפעלה המקסימלי של הפונקציה.

  • ברירת מחדל: 60
  • הערך המקסימלי: 540
serviceConfig.availableMemory
(אופציונלי) 		נפח הזיכרון שזמין לפונקציה. ברירת המחדל היא 256M. היחידות הנתמכות הן k,‏ M,‏ G,‏ Mi ו-Gi. אם לא מציינים יחידה, הערך מפורש כבייט.
מאפייני eventTrigger
eventTrigger.eventType
(חובה) 		סוג האירוע שרוצים להאזין לו. במאמר כתיבת פונקציות של Cloud Functions לתוסף מפורטים סוגי האירועים שזמינים לכל מוצר.
eventTrigger.eventFilters
(אופציונלי) 		מסננים שמגבילים עוד יותר את האירועים שרוצים להאזין להם. לדוגמה, אפשר להאזין רק לאירועים שתואמים לדפוס משאב ספציפי. למידע על סינון של כל סוג אירוע, תוכלו לקרוא את המאמר כתיבה של פונקציות Cloud לתוסף.
eventTrigger.channel
(אופציונלי) 		שם הערוץ שמשויך לטריגר בפורמט projects/{project}/locations/{location}/channels/{channel}. אם משמיטים את המאפיין הזה, הפונקציה תאזין לאירועים בערוץ ברירת המחדל של הפרויקט.
eventTrigger.triggerRegion
(אופציונלי) 		הטריגר יקבל רק אירועים שמקורם באזור הזה. אפשר להזין את אותו אזור כמו הפונקציה, אזור אחר או מספר אזורים אחר, או האזור הגלובלי. אם לא מציינים אזור, ברירת המחדל היא אותו אזור שבו נמצאת הפונקציה.

אירועים במחזור החיים

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

lifecycleEvents:
  onInstall:
    function: myTaskFunction
    processingMessage: Describes the task being completed
  onUpdate:
    function: myOtherTaskFunction
    processingMessage: Describes the task being completed
  onConfigure:
    function: myOtherTaskFunction
    processingMessage: Describes the task being completed
שדות של אירועים במחזור חיים
onInstall
(אופציונלי)

מציין פונקציה שפועלת כשמשתמש מתקין את התוסף.

מפרט הפונקציה
function
מחרוזת
(חובה)

שם הפונקציה שמופעלת בתור המשימה, שתטפל באירוע.

צריך להצהיר על הפונקציה הזו בקטע resources ולהגדיר את taskQueue.
processingMessage
מחרוזת
(חובה) 		ההודעה שתוצג במסוף Firebase בזמן שהמשימה מתבצעת.
onUpdate
(אופציונלי)

מציינת פונקציה שרצה כשמשתמש מעדכן את התוסף.

מפרט הפונקציה
function
מחרוזת
(חובה)

שם הפונקציה שמופעלת בתור המשימה, שתטפל באירוע.

צריך להצהיר על הפונקציה הזו בקטע resources ולהגדיר את taskQueue.
processingMessage
מחרוזת
(חובה) 		ההודעה שתוצג במסוף Firebase בזמן שהמשימה מתבצעת.
onConfigure
(אופציונלי)

מציין פונקציה שתופעל כשמשתמש מגדיר מחדש את התוסף.

מפרט הפונקציה
function
מחרוזת
(חובה)

שם הפונקציה שמופעלת בתור המשימה, שתטפל באירוע.

צריך להצהיר על הפונקציה הזו בקטע resources ולהגדיר את taskQueue.
processingMessage
מחרוזת
(חובה) 		ההודעה שתוצג במסוף Firebase בזמן שהמשימה מתבצעת.

אירועים מותאמים אישית (Eventarc)

אירועים בהתאמה אישית הם אירועים שהתוסף פולט כדי לאפשר למשתמשים להוסיף לוגיקה משלהם לתוסף. מידע נוסף מופיע בקטע Eventarc במאמר הוספת הוּקים של משתמשים לתוסף.

events:
  - type: publisher-id.extension-name.version.event-name
    description: Description of the event
  - type: publisher-id.extension-name.version.another-event-name
    description: Description of the other event
שדות אירוע בהתאמה אישית
type
string
(חובה) 		מזהה הסוג של האירוע. יוצרים את המזהה מ-3-4 שדות שממופרדים בנקודות: השדות 'מזהה בעל התוכן הדיגיטלי', 'שם התוסף' ו'שם האירוע' הם שדות חובה, והשדה 'גרסה' הוא מומלץ. כדאי לבחור שם ייחודי ותיאור של כל סוג אירוע שאתם מפרסמים.
description
מחרוזת
(חובה) 		תיאור האירוע.