- EventObject
- CommonEventObject
- HostApp
- פלטפורמה
- TimeZone
- מכשירים לקליטת נתונים
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- מארגן
- משתתף
- ConferenceData
- ConferenceSolution
- מקש
- EntryPoint
- פרמטרים
- AddOnParameters
- יכולות
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- צ'יפ
- סמל
- StyledText
- סגנון
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
אירוע אינטראקציה עם תוסף של Google שמכיל נתונים על האינטראקציה של המשתמש עם תוסף באפליקציה מארחת.
אובייקט האירוע מועבר כ-JSON לפונקציית קריאה חוזרת (callback) או לטריגר של תוסף (ב-AppsScript), או לנקודת קצה (endpoint) של https (ב-HTTP), כשמשתמש יוצר אינטראקציה עם תוסף באפליקציה מארחת. אובייקט האירוע מאחסן אובייקט אירוע של אפליקציה מארחת שמוגדר על ידי כל אפליקציה מארחת, וגם אובייקט אירוע נפוץ שמכיל כמה שדות נפוצים שקשורים לאירוע.
מידע נוסף זמין במאמר אובייקטים מסוג אירוע.
| ייצוג ב-JSON |
|---|
{ "commonEventObject": { object ( |
| שדות | |
|---|---|
commonEventObject |
אובייקט שמכיל מידע שמשותף לכל האובייקטים מסוג אירוע, בלי קשר לאפליקציה המארחת. |
authorizationEventObject |
מוגדר רק לבקשות לנקודות קצה (endpoint) של HTTP |
| ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
calendar |
מוצג רק אם המארח המזמין הוא יומן Google. אובייקט שמכיל מידע על היומן ועל האירוע. |
drive |
מוצג רק אם המארח שמבצע את הקריאה הוא Google Drive. אובייקט שמכיל מידע על Drive. |
gmail |
מוצג רק אם המארח שמבצע את השיחה הוא Gmail. אובייקט שמכיל מידע מ-Gmail. |
sheets |
מוצג רק אם המארח שמתקשר הוא Google Sheets. אובייקט שמכיל מידע על Sheets. |
slides |
מוצג רק אם המארח שמתקשר הוא Google Slides. אובייקט שמכיל מידע על Slides. |
docs |
מוצג רק אם המארח המזמין הוא Google Docs. אובייקט שמכיל מידע על Docs. |
chat |
מוצג רק אם המארח של השיחה הוא Google Chat. אובייקט שמכיל מידע על הצ'אט. |
workflow |
מופיע רק אם המארח שמתקשר הוא Google Workspace Studio. אובייקט שמכיל מידע על תהליך העבודה. |
| סוף השדות שמוציאים זה את זה. | |
CommonEventObject
אובייקט מסוג אירוע נפוץ הוא החלק באובייקט מסוג אירוע הכולל שמעביר מידע כללי, שלא תלוי במארח, לתוסף מהלקוח של המשתמש. המידע הזה כולל פרטים כמו הלוקאל, האפליקציה המארחת והפלטפורמה של המשתמש.
בנוסף לטריגרים של דף הבית וטריגרים לפי הקשר, התוספים יוצרים אובייקטים מסוג אירוע ומעבירים אותם לפונקציות קריאה חוזרת של פעולות כשהמשתמש יוצר אינטראקציה עם ווידג'טים. פונקציית הקריאה החוזרת של התוסף יכולה לשלוח שאילתה לאובייקט מסוג אירוע נפוץ כדי לקבוע את התוכן של ווידג'טים פתוחים בתוכנת הלקוח של המשתמש. לדוגמה, התוסף יכול לאתר את הטקסט שהמשתמש הזין בווידג'ט TextInput באובייקט eventObject.commentEventObject.formInputs.
באפליקציות ל-Chat, שם הפונקציה שהמשתמש הפעיל כשהייתה לו אינטראקציה עם ווידג'ט.
| ייצוג ב-JSON |
|---|
{ "userLocale": string, "hostApp": enum ( |
| שדות | |
|---|---|
userLocale |
מושבתת כברירת מחדל. מזהה השפה והמדינה או האזור של המשתמש בפורמט של קוד שפה לפי תקן ISO 639 וקוד מדינה או אזור לפי תקן ISO 3166. לדוגמה, כדי להפעיל את השדה הזה, צריך להגדיר את |
hostApp |
מציין את האפליקציה המארחת שבה התוסף פעיל כשאובייקט מסוג אירוע נוצר. הערכים האפשריים כוללים:
|
platform |
טיפוס הנתונים המנייתי של הפלטפורמה שמציין את הפלטפורמה שבה האירוע נוצר ( |
timeZone |
מושבתת כברירת מחדל. מזהה אזור הזמן וההפרש מהזמן האוניברסלי המתואם (UTC). כדי להפעיל את השדה הזה, צריך להגדיר את נתמך רק בסוגי האירועים |
formInputs |
מפה שמכילה את הערכים הנוכחיים של הווידג'טים בכרטיס שמוצג. המפתחות של המפה הם ערכי המחרוזת המבנה של אובייקט הערך של המפה תלוי בסוג הווידג'ט: הערה: הדוגמאות הבאות מותאמות לסביבת ההרצה של V8 ב-Apps Script. אם משתמשים בסביבת זמן הריצה Rhino, צריך להוסיף
דוגמה: לווידג'ט של קלט טקסט עם
דוגמה: בווידג'ט עם כמה ערכים שבו
דוגמה: בבורר עם
דוגמה: בבורר עם
דוגמה: בבורר עם אובייקט שמכיל רשימה של צמדי |
parameters |
כל פרמטר נוסף שאתם מספקים לפעולה באמצעות תצוגה מקדימה למפתחים: בתוספים שמרחיבים את Google Chat, כדי להציע פריטים על סמך מה שהמשתמשים מקלידים בתפריטים לבחירה מרובה, צריך להשתמש בערך של המפתח אובייקט שמכיל רשימה של צמדי |
invokedFunction |
שם הפונקציה שרוצים להפעיל. השדה הזה לא מאוכלס בתוספים ל-Google Workspace שמרחיבים את Google Chat. במקום זאת, כדי לקבל נתוני פונקציות כמו מזהים, תוספים שמרחיבים את Chat צריכים להשתמש בשדה |
HostApp
אפליקציית Google Workspace לתוסף ל-Google Workspace או לאפליקציה ל-Google Chat.
בתוספים, אפליקציית Workspace שממנה מופעל תוסף ל-Google Workspace. באפליקציות ל-Chat, האפליקציה המארחת היא תמיד CHAT.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED_HOST_APP |
Google לא יכולה לזהות אפליקציה מארחת. |
GMAIL |
התוסף מופעל מ-Gmail. |
CALENDAR |
התוסף מופעל מיומן Google. |
DRIVE |
התוסף מופעל מ-Google Drive. |
DEMO |
לא בשימוש. |
DOCS |
התוסף מופעל מ-Google Docs. |
MEET |
התוסף מופעל מ-Google Meet. |
SHEETS |
התוסף מופעל מ-Google Sheets. |
SLIDES |
התוסף מופעל מ-Google Slides. |
DRAWINGS |
התוסף מופעל מ-Google Drawings. |
CHAT |
אפליקציה ל-Google Chat. |
פלטפורמה
מזהה את הפלטפורמה שממנה הגיעה הקריאה.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
מזהה אזור הזמן וההפרש מהזמן האוניברסלי המתואם (UTC). נתמך רק בסוגי האירועים CARD_CLICKED ו-SUBMIT_DIALOG.
| ייצוג ב-JSON |
|---|
{ "id": string, "offset": integer } |
| שדות | |
|---|---|
id |
קוד מסד הנתונים של אזור הזמן IANA TZ, כמו "America/Toronto". |
offset |
ההפרש בין אזור הזמן של המשתמש לבין זמן אוניברסלי מתואם (UTC), באלפיות השנייה. |
כניסות קלט
סוגי הנתונים שהמשתמשים יכולים להזין בכרטיסים או בתיבות דו-שיח. סוג הקלט תלוי בסוג הערכים שהווידג'ט מקבל.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| שדות | |
|---|---|
| ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
stringInputs |
רשימה של מחרוזות שמייצגות את הערכים שהמשתמש מזין בווידג'ט. אם הווידג'ט מקבל רק ערך אחד, כמו ווידג'ט |
dateTimeInput |
ערכי קלט של תאריך ושעה מווידג'ט |
dateInput |
ערכי קלט של תאריכים מווידג'ט |
timeInput |
ערכי קלט של זמן מווידג'ט |
| סוף השדות שמוציאים זה את זה. | |
StringInputs
פרמטר קלט לווידג'טים רגילים. בווידג'טים עם ערך יחיד, זו רשימה של ערך יחיד. בווידג'טים עם כמה ערכים, כמו תיבת סימון, כל הערכים מוצגים.
| ייצוג ב-JSON |
|---|
{ "value": [ string ] } |
| שדות | |
|---|---|
value[] |
רשימה של מחרוזות שהמשתמש הזין. |
DateTimeInput
ערכי קלט של תאריך ושעה.
| ייצוג ב-JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| שדות | |
|---|---|
msSinceEpoch |
הזמן שחלף מאז ראשית זמן יוניקס (Unix epoch), באלפיות השנייה. |
hasDate |
אם הקלט של |
hasTime |
אם הקלט של |
DateInput
ערכי קלט של תאריכים.
| ייצוג ב-JSON |
|---|
{ "msSinceEpoch": string } |
| שדות | |
|---|---|
msSinceEpoch |
הזמן שחלף מאז ראשית זמן יוניקס (Unix epoch), באלפיות השנייה. |
TimeInput
ערכי קלט של זמן.
| ייצוג ב-JSON |
|---|
{ "hours": integer, "minutes": integer } |
| שדות | |
|---|---|
hours |
השעה בשעון של 24 שעות. |
minutes |
מספר הדקות אחרי השעה העגולה. הערכים התקינים הם 0 עד 59. |
AuthorizationEventObject
מכיל את פרטי ההרשאה לבקשת התוסף
| ייצוג ב-JSON |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| שדות | |
|---|---|
userOAuthToken |
טוקן הגישה ל-OAuth של משתמש הקצה, שאושר עם ההיקפים המבוקשים. (אחרי ביטול החבילה של הסכמת OAuth, ההרשאה תתבצע באמצעות היקפי הרשאות שמשתמשי הקצה אישרו) |
userIdToken |
טוקן של מזהה של משתמש קצה, אם נשלחה בקשה להיקפי מזהה מתאימים |
systemIdToken |
טוקן של מזהה לחשבון השירות של התוספים ל-G Suite לפריסה הזו |
authorizedScopes[] |
רשימה של היקפי הרשאות OAuth שהמשתמש אישר. |
CalendarEventObject
אובייקט מסוג אירוע ביומן הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על היומן ועל האירועים ביומן של המשתמש. הוא מופיע באובייקט מסוג אירוע רק אם האפליקציה המארחת היא יומן Google.
בטבלה הבאה מפורטים השדות שמופיעים בשדה calendar של אובייקט מסוג אירוע. שדות שמסומנים כנתונים שנוצרו על ידי משתמשים קיימים באובייקט מסוג אירוע רק אם הנתונים קיימים באירוע ביומן והתוסף מגדיר את שדה addOns.calendar.currentEventAccess במניפסט שלו כ-READ או כ-READ_WRITE.
| ייצוג ב-JSON |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| שדות | |
|---|---|
id |
מזהה האירוע. |
recurringEventId |
המזהה של אירוע חוזר. |
calendarId |
מזהה היומן. |
organizer |
אובייקט שמייצג את מארגן האירוע. |
attendees[] |
נתונים שנוצרו על ידי משתמשים. רשימת המשתתפים באירוע ביומן. |
conferenceData |
נתונים שנוצרו על ידי משתמשים. אובייקט שמייצג את נתוני שיחת הוועידה שמשויכים לאירוע, כמו פרטי שיחת הוועידה ב-Google Meet. |
capabilities |
נתונים שנוצרו על ידי משתמשים. אובייקט שמתאר את היכולות של התוסף להציג או לעדכן את פרטי האירוע. |
מארגן
| ייצוג ב-JSON |
|---|
{ "email": string } |
| שדות | |
|---|---|
email |
כתובת האימייל של מארגן האירוע. |
משתתפים
אובייקטים של משתתפים מכילים מידע על משתתפים ספציפיים באירועים ביומן Google. המידע הזה מופיע באובייקט מסוג אירוע רק אם הנתונים מופיעים באירוע ביומן, והתוסף מגדיר את שדה addOns.calendar.currentEventAccess במניפסט שלו כ-READ או כ-READ_WRITE.
| ייצוג ב-JSON |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| שדות | |
|---|---|
email |
כתובת האימייל של המשתתף. |
displayName |
השם המוצג של המשתתף. |
organizer |
true אם המשתתף הוא מארגן האירוע. |
self |
true אם המשתתף הזה מייצג את היומן שבו האירוע הזה מופיע, אחרת false. |
resource |
true אם המשתתף מייצג משאב, כמו חדר או ציוד, אחרת false. |
optional |
true אם ההשתתפות של המשתתף הזה מסומנת כרשות, אחרת false. |
responseStatus |
סטטוס התשובה של המשתתף. הערכים האפשריים כוללים:
|
comment |
התגובה של המשתתף, אם יש כזו. |
additionalGuests |
מספר האורחים הנוספים שהמשתתף ציין שהוא מביא איתו. ברירת המחדל היא אפס. |
ConferenceData
אובייקטים של נתוני שיחות ועידה מכילים מידע על שיחות ועידה שמצורפות לאירועים ביומן Google. אלה יכולים להיות פתרונות לשיחות ועידה של Google, כמו Google Meet, או שיחות ועידה של צד שלישי. המידע הזה מופיע באובייקט מסוג אירוע רק אם הנתונים מופיעים באירוע ביומן, והתוסף מגדיר את שדה addOns.calendar.currentEventAccess במניפסט שלו כ-READ או כ-READ_WRITE.
| ייצוג ב-JSON |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| שדות | |
|---|---|
conferenceId |
מזהה הפגישה. המזהה הזה נועד לאפשר לאפליקציות לעקוב אחרי שיחות ועידה, ולא צריך להציג אותו למשתמשים. |
conferenceSolution |
אובייקט שמייצג את הפתרון לשיחות ועידה, כמו Hangouts או Google Meet. |
entryPoints[] |
רשימת נקודות הכניסה לוועידה, כמו כתובות URL או מספרי טלפון. |
notes |
הערות נוספות (כמו הוראות ממנהל הדומיין או הודעות משפטיות) לגבי שיחת הוועידה שיוצגו למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2,048 תווים. |
parameters |
אובייקט שמכיל מפה של נתוני פרמטרים מוגדרים לשימוש בתוסף. |
ConferenceSolution
| ייצוג ב-JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| שדות | |
|---|---|
iconUri |
ה-URI של הסמל שמוצג למשתמשים ומייצג את הפתרון הזה לשיחות ועידה. |
key |
המפתח שמזהה באופן ייחודי את הפתרון לשיחות ועידה באירוע הזה. |
name |
השם של פתרון לשיחות ועידה זה שגלוי למשתמש (לא מותאם לשוק המקומי). |
מפתח
| ייצוג ב-JSON |
|---|
{ "type": string } |
| שדות | |
|---|---|
type |
סוג הפתרון לשיחות ועידה. הערכים האפשריים כוללים:
|
EntryPoint
אובייקטים של נקודות כניסה מכילים מידע על האמצעים שנקבעו לגישה לפגישה מסוימת, כמו בטלפון או בווידאו. המידע הזה מופיע באובייקט מסוג אירוע רק אם הנתונים מופיעים באירוע ביומן, והתוסף מגדיר את שדה addOns.calendar.currentEventAccess במניפסט שלו כ-READ או כ-READ_WRITE.
| ייצוג ב-JSON |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| שדות | |
|---|---|
accessCode |
קוד הגישה ששימש כדי להצטרף לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה. |
entryPointType |
סוג נקודת הכניסה. הערכים האפשריים הם:
|
label |
התווית שגלויה למשתמשים של ה-URI של נקודת הכניסה (לא מותאמת לשוק המקומי). |
meetingCode |
קוד הפגישה ששימש כדי לגשת לוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה. |
passcode |
קוד הגישה שמשמש כדי להצטרף לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה. |
password |
הסיסמה שמשמשת כדי להצטרף לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה. |
pin |
קוד האימות שמשמש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה. |
uri |
ה-URI של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים. הפורמט תלוי בסוג נקודת הכניסה:
|
regionCode |
קוד האזור של מספר הטלפון. המשתמשים צריכים את זה אם ה-URI לא כולל קוד מדינה. הערכים מבוססים על רשימת קודי האזורים הציבורית של CLDR. |
entryPointFeatures[] |
התכונות של נקודת הכניסה. נכון לעכשיו, התכונות האלה חלות רק על נקודות כניסה לטלפון:
|
פרמטרים
| ייצוג ב-JSON |
|---|
{
"addOnParameters": {
object ( |
| שדות | |
|---|---|
addOnParameters |
מפה של מפתחות וערכים של מחרוזות פרמטרים. המפתחות והערכים האלה מוגדרים על ידי מפתח התוסף כדי לצרף מידע לפגישה ספציפית לשימוש בתוסף. |
AddOnParameters
| ייצוג ב-JSON |
|---|
{ "parameters": { string: string, ... } } |
| שדות | |
|---|---|
parameters |
אובייקט שמכיל רשימה של צמדי |
יכולות
| ייצוג ב-JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| שדות | |
|---|---|
canSeeAttendees |
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול לקרוא את רשימת המשתתפים באירוע, אחרת false. |
canAddAttendees |
נתונים שנוצרו על ידי משתמשים. הערך true אם התוסף יכול להוסיף משתתפים חדשים לרשימת המשתתפים באירוע, אחרת הערך הוא false. |
canSeeConferenceData |
נתונים שנוצרו על ידי המשתמש. true אם התוסף יכול לקרוא את נתוני שיחת הוועידה של האירוע, אחרת false. |
canSetConferenceData |
נתונים שנוצרו על ידי המשתמש. true אם התוסף יכול לעדכן את נתוני שיחת הוועידה של האירוע, אחרת false. |
canAddAttachments |
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול להוסיף קבצים חדשים לאירוע, אחרת false. |
DriveEventObject
אובייקט מסוג אירוע ב-Drive הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על Google Drive של המשתמש ועל התוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם האפליקציה המארחת היא Google Drive.
| ייצוג ב-JSON |
|---|
{ "selectedItems": [ { object ( |
| שדות | |
|---|---|
selectedItems[] |
רשימה של פריטים (קבצים או תיקיות) שנבחרו ב-Drive. |
activeCursorItem |
הפריט ב-Drive שפעיל כרגע. |
DriveItemMetadata
אובייקטים של פריטים ב-Drive מכילים מידע על פריטים ספציפיים ב-Drive, כמו קבצים או תיקיות.
| ייצוג ב-JSON |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| שדות | |
|---|---|
id |
המזהה של הפריט שנבחר. |
iconUrl |
כתובת ה-URL של הסמל שמייצג את הפריט שנבחר. |
mimeType |
סוג ה-MIME של הפריט שנבחר. |
title |
השם של הפריט שנבחר. |
addonHasFileScopePermission |
אם הערך הוא true, התוסף ביקש וקיבל הרשאה להיקף https://www.googleapis.com/auth/drive.file לפריט הזה. אחרת, הערך בשדה הזה הוא false. אם התוסף משתמש בהיקף הרשאות רחב יותר, כמו https://www.googleapis.com/auth/drive או https://www.googleapis.com/auth/drive.readonly, השדה הזה לא רלוונטי. כדי להגן על פרטי המשתמשים, תמיד צריך להשתמש בהיקפי ההרשאות המצומצמים ביותר האפשריים כשמתכננים תוספים. |
GmailEventObject
אובייקט מסוג אירוע ב-Gmail הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על ההודעות של המשתמש ב-Gmail. הוא מופיע באובייקט מסוג אירוע רק אם האפליקציה המארחת היא Gmail.
| ייצוג ב-JSON |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| שדות | |
|---|---|
messageId |
המזהה של ההודעה שפתוחה כרגע ב-Gmail. |
threadId |
מזהה השרשור שפתוח כרגע ב-Gmail. |
accessToken |
טוקן הגישה הספציפי ל-Gmail. אתם יכולים להשתמש בטוקן הזה עם השיטה |
toRecipients[] |
מושבתת כברירת מחדל. רשימת כתובות האימייל של הנמענים בשדה "אל:" שכלולות כרגע בטיוטה שהתוסף יוצר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה |
ccRecipients[] |
מושבתת כברירת מחדל. רשימת כתובות האימייל של הנמענים בשדה "עותק:" שכלולות כרגע בטיוטה שהתוסף יוצר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה |
bccRecipients[] |
מושבתת כברירת מחדל. רשימת כתובות האימייל של הנמענים בשדה "עותק מוסתר:" שכלולות כרגע בטיוטה שהתוסף יוצר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה |
SheetsEventObject
אובייקט מסוג אירוע ב-Sheets הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על המסמך של המשתמש והתוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם התוסף מרחיב את Google Sheets.
| ייצוג ב-JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| שדות | |
|---|---|
id |
מוצג רק אם המשתמש אישר את ההיקף |
title |
מוצג רק אם המשתמש אישר את ההיקף |
addonHasFileScopePermission |
אם הערך הוא |
matchedUrl |
השדה הזה מופיע רק אם מתקיימים התנאים הבאים:
כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Sheets. כדי להשתמש בשדה הזה, צריך להגדיר את מטען ייעודי (payload) לדוגמה כשמשתמש צופה בתצוגה מקדימה של הקישור |
MatchedUrl
אובייקט מסוג אירוע שמוחזר עם בקשות לתצוגה מקדימה של קישורים.
| ייצוג ב-JSON |
|---|
{ "url": string } |
| שדות | |
|---|---|
url |
כתובת ה-URL שהותאמה. |
SlidesEventObject
האובייקט מסוג אירוע ב-Slides הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על המסמך של המשתמש ועל התוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם התוסף מרחיב את Google Slides.
| ייצוג ב-JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| שדות | |
|---|---|
id |
מוצג רק אם המשתמש אישר את ההיקף |
title |
מוצג רק אם המשתמש אישר את ההיקף |
addonHasFileScopePermission |
אם הערך הוא |
matchedUrl |
השדה הזה מופיע רק אם מתקיימים התנאים הבאים:
כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Slides. כדי להשתמש בשדה הזה, צריך להגדיר את מטען ייעודי (payload) לדוגמה כשמשתמש צופה בתצוגה מקדימה של הקישור |
DocsEventObject
האובייקט מסוג אירוע ב-Docs הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על המסמך של המשתמש והתוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם התוסף מרחיב את Google Docs.
| ייצוג ב-JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| שדות | |
|---|---|
id |
מוצג רק אם המשתמש אישר את ההיקף |
title |
מוצג רק אם המשתמש אישר את ההיקף |
addonHasFileScopePermission |
אם הערך הוא |
matchedUrl |
השדה הזה מופיע רק אם מתקיימים התנאים הבאים:
כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Docs. כדי להשתמש בשדה הזה, צריך להגדיר את מטען ייעודי (payload) לדוגמה כשמשתמש צופה בתצוגה מקדימה של הקישור |
ChatEventObject
מטען ייעודי (payload) של אובייקט מסוג אירוע באפליקציית Google Chat שנשלח משרת Google לתוספים. אפשר להשתמש במטענים ייעודיים כדי לזהות את סוג האירוע.
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
סוג האירוע, מאוכלס רק באירועים של דף הבית של האפליקציה באפליקציות ל-Chat שהן לא תוספים. |
user |
המשתמש שמקיים אינטראקציה עם אפליקציית הצ'אט. |
space |
המרחב שבו האירוע התרחש. השדה הזה מאוכלס רק באירועים של דף הבית של האפליקציה באפליקציות ל-Chat שהן לא תוספים. |
eventTime |
חותמת הזמן שמציינת מתי מתרחש אובייקט מסוג אירוע. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
| המטען הייעודי (payload) של אובייקט מסוג אירוע. המטענים הייעודיים תלויים בסוג האובייקט של האירוע. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
messagePayload |
משתמש שולח הודעה לאפליקציה ל-Chat או מתייג אותה במרחב באמצעות @. הפעלות של פקודות באפליקציה (כמו פקודות דרך שורת הפקודות ופקודות מהירות) נשלחות במקום זאת ב- |
addedToSpacePayload |
משתמש מוסיף את האפליקציה ל-Chat למרחב ב-Chat, או אדמין ב-Google Workspace מתקין את האפליקציה ל-Chat במרחבים של צ'אטים אישיים בשביל המשתמשים בארגון. |
removedFromSpacePayload |
משתמש מסיר את האפליקציה ל-Chat מהמרחב. |
buttonClickedPayload |
מייצג את נתוני המטען הייעודי (payload) כשמשתמש יוצר אינטראקציה עם רכיב אינטראקטיבי של כרטיס או תיבת דו-שיח שמפעילה קריאה חוזרת (callback) של אם משתמש יוצר אינטראקציה עם תיבת דו-שיח, השדה המטען הייעודי (payload) המלא כולל גם את |
widgetUpdatedPayload |
משתמש מעדכן ווידג'ט בכרטיס בתוך הזרם או בתיבת דו-שיח. המטען הייעודי (payload) המלא כולל גם את |
appCommandPayload |
משתמש מפעיל פקודה לאפליקציה. |
systemCommandPayload |
משתמש מפעיל פקודת מערכת. |
| סוף השדות שמוציאים זה את זה. | |
EventType
סוג האירוע, מאוכלס רק באירועים של דף הבית של האפליקציה באפליקציות ל-Chat שהן לא תוספים.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. לא להשתמש. |
APP_HOME |
משתמש פותח צ'אט ישיר מאפליקציה ל-Chat שמשתמשת בדף הבית של האפליקציה. רק השדות type, user ו-space נכללים באירועים מהסוג הזה. מידע נוסף מופיע במאמר איך יוצרים דף בית לאפליקציה ל-Google Chat. |
SUBMIT_FORM |
משתמש שולח מידע בכרטיס הבית של האפליקציה. רק השדות type, user ו-space נכללים באירועים מהסוג הזה. מידע נוסף מופיע במאמר https://developers.google.com/workspace/chat/send-app-home-card-message). |
MessagePayload
משתמש שולח הודעה לאפליקציה ל-Chat או מתייג אותה במרחב באמצעות @. הפעלות של פקודות לאפליקציות (כמו פקודות דרך שורת הפקודות ופקודות מהירות) משתמשות ב-AppCommandPayload במקום זאת.
| ייצוג ב-JSON |
|---|
{ "space": { object ( |
| שדות | |
|---|---|
space |
חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
message |
ההודעה שמפעילה את אובייקט האירוע. |
configCompleteRedirectUri |
אופציונלי. כתובת ה-URL שאליה האפליקציה ל-Chat צריכה להפנות את המשתמש אחרי שהוא משלים תהליך של הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף מופיע במאמר איך מחברים אפליקציות ל-Chat לשירותים ולכלים אחרים. |
AddedToSpacePayload
משתמש מוסיף את אפליקציית הצ'אט למרחב, או שנוצר צ'אט בין האפליקציה למשתמש.
| ייצוג ב-JSON |
|---|
{
"space": {
object ( |
| שדות | |
|---|---|
space |
חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
interactionAdd |
אם האפליקציה נוספה למרחב באמצעות אינטראקציה של משתמש (לדוגמה, על ידי תיוג של האפליקציה ל-Chat באמצעות @ או הפעלה באמצעות פקודה דרך שורת הפקודות). אם הערך הוא true, אובייקט מסוג אירוע נפרד שמשויך לאינטראקציה עצמה יישלח לאפליקציה ל-Chat. |
configCompleteRedirectUri |
אופציונלי. כתובת ה-URL שאליה האפליקציה ל-Chat צריכה להפנות את המשתמש אחרי שהוא משלים תהליך של הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף מופיע במאמר איך מחברים אפליקציות ל-Chat לשירותים ולכלים אחרים. |
RemovedFromSpacePayload
משתמש מסיר את האפליקציה ל-Chat מהמרחב.
| ייצוג ב-JSON |
|---|
{
"space": {
object ( |
| שדות | |
|---|---|
space |
חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
ButtonClickedPayload
משתמש מבצע פעולה ברכיב אינטראקטיבי של כרטיס או תיבת דו-שיח מתוסף ל-Chat שמפעיל קריאה חוזרת (callback) מסוג Action. למרות השם, המטען הייעודי (payload) הזה מאוכלס לכל הקריאות החוזרות (callbacks) של הכרטיסים ותיבות הדו-שיח של Action, כולל קליקים על לחצנים, טריגרים של onChangeAction, פעולות של onClick, קליקים של CardAction ושליחה או ביטול של תיבת דו-שיח (SUBMIT_DIALOG ו-CANCEL_DIALOG).
אם משתמש יוצר אינטראקציה עם תיבת דו-שיח, השדה isDialogEvent של ButtonClickedPayload מוגדר כ-true וכולל DialogEventType. המטען הייעודי (payload) הזה ממפה לסוגי האירועים SUBMIT_FORM ו-CARD_CLICKED באפליקציות ל-Chat שהן לא תוספים.
המטען הייעודי (payload) המלא כולל גם את CommonEventObject.form_inputs ו-CommonEventObject.parameters.
| ייצוג ב-JSON |
|---|
{ "space": { object ( |
| שדות | |
|---|---|
space |
חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
message |
ההודעה שמפעילה את אובייקט האירוע. |
isDialogEvent |
באובייקטים מסוג אירוע |
dialogEventType |
סוג האובייקט מסוג אירוע של תיבת דו-שיח שהתקבל. |
DialogEventType
לאובייקטים מסוג אירוע שמכילים מטען ייעודי (payload) של אירוע מסוג ButtonClicked או AppCommand, סוגי האינטראקציות עם תיבות דו-שיח.
מידע נוסף על אובייקטים מסוג אירוע באפליקציית Google Chat זמין במאמר קבלת אינטראקציות עם אפליקציית Google Chat ותגובה להן.
| טיפוסים בני מנייה (enum) | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
ערך ברירת המחדל. לא צוין. |
REQUEST_DIALOG |
משתמש פותח תיבת דו-שיח. |
SUBMIT_DIALOG |
משתמש לוחץ על רכיב אינטראקטיבי בתיבת דו-שיח. לדוגמה, משתמש ממלא מידע בתיבת דו-שיח ולוחץ על כפתור כדי לשלוח את המידע. |
CANCEL_DIALOG |
משתמש סוגר תיבת דו-שיח בלי לשלוח מידע, או שתיבת הדו-שיח מבוטלת. |
WidgetUpdatedPayload
משתמש מעדכן ווידג'ט בכרטיס או בתיבת דו-שיח בתוך ה-stream.
המטען הייעודי (payload) המלא כולל גם את CommonEventObject.parameters['autocomplete_widget_query'].
| ייצוג ב-JSON |
|---|
{
"space": {
object ( |
| שדות | |
|---|---|
space |
חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
AppCommandPayload
משתמש מפעיל פקודה לאפליקציה.
| ייצוג ב-JSON |
|---|
{ "appCommandMetadata": { object ( |
| שדות | |
|---|---|
appCommandMetadata |
מאוכלס בפקודות לאפליקציות, כולל פקודות דרך שורת הפקודות ופקודות מהירות. |
space |
אופציונלי. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
thread |
אופציונלי. השרשור שבו מתרחש אובייקט מסוג אירוע, אם רלוונטי. השדה הזה מאוכלס אם אובייקט מסוג אירוע משויך להודעה או לשרשור ספציפיים. |
message |
אופציונלי. ההודעה שמפעילה את אובייקט מסוג אירוע, אם רלוונטי. השדה הזה מאוכלס רק בפקודות דרך שורת הפקודות. |
configCompleteRedirectUri |
אופציונלי. כתובת ה-URL שאליה המשתמש צריך להיות מופנה אחרי שהוא משלים תהליך של הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף מופיע במאמר איך מחברים אפליקציות ל-Chat לשירותים ולכלים אחרים. |
isDialogEvent |
אופציונלי. אם המשתמש יוצר אינטראקציה עם תיבת דו-שיח או עומד ליצור איתה אינטראקציה. |
dialogEventType |
אופציונלי. סוג האובייקט מסוג אירוע של תיבת דו-שיח שהתקבל. השדה הזה רלוונטי רק אם הערך של |
AppCommandMetadata
מטא-נתונים על פקודה באפליקציה ל-Chat.
| ייצוג ב-JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| שדות | |
|---|---|
appCommandId |
המזהה של הפקודה שצוינה בהגדרות של Chat API. |
appCommandType |
סוג הפקודה של אפליקציית הצ'אט. |
AppCommandType
סוג הפקודה של אפליקציית הצ'אט. פרטים נוספים מופיעים במאמר סוגי פקודות לאפליקציות ל-Chat.
| טיפוסים בני מנייה (enum) | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
ערך ברירת המחדל. לא צוין. |
SLASH_COMMAND |
פקודה דרך שורת הפקודות. המשתמש שולח את הפקודה בהודעת צ'אט. |
QUICK_COMMAND |
פקודה מהירה. המשתמש בוחר את הפקודה מהתפריט של Chat באזור התשובה להודעה. |
MESSAGE_ACTION |
פעולה שקשורה להודעה. המשתמש בוחר את הפקודה מתפריט ההקשר של ההודעה ב-Chat. |
SystemCommandPayload
משתמש מפעיל פקודת מערכת.
| ייצוג ב-JSON |
|---|
{ "systemCommandMetadata": { object ( |
| שדות | |
|---|---|
systemCommandMetadata |
מטא-נתונים על פקודת המערכת שהופעלה. |
space |
אופציונלי. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע. |
thread |
אופציונלי. השרשור שבו מתרחש אובייקט מסוג אירוע, אם רלוונטי. השדה הזה מאוכלס אם אובייקט מסוג אירוע משויך להודעה או לשרשור ספציפיים. |
SystemCommandMetadata
מטא-נתונים על פקודת מערכת שהמשתמש מפעיל.
| ייצוג ב-JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| שדות | |
|---|---|
| פקודת המערכת שהופעלה. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
cancelStream |
פקודה לביטול הודעה פעילה בסטרימינג. |
| סוף השדות שמוציאים זה את זה. | |
CancelStream
פקודה לביטול הודעה פעילה בסטרימינג.
| ייצוג ב-JSON |
|---|
{ "streamMessage": string } |
| שדות | |
|---|---|
streamMessage |
חובה. שם המשאב של ההודעה בסטרימינג שעליה בוצעה פקודת הביטול. פורמט: |
WorkflowEventObject
LINT.IfChange אובייקט מסוג אירוע שמועבר לתוספים של תהליכי עבודה.
| ייצוג ב-JSON |
|---|
{ "executionMetadata": { object ( |
| שדות | |
|---|---|
executionMetadata |
מטא-נתונים על הרצת תהליך העבודה. |
triggerEventSource |
המקור של האירועים המפעילים. |
| סוג המטען הייעודי (payload) של אירוע בתהליך העבודה. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
actionInvocation |
הפעלה של פעולה בתהליך עבודה. |
triggerCreation |
יצירת טריגר לתהליך עבודה. |
triggerDeletion |
מחיקת טריגר של תהליך עבודה. |
resourceRetrieval |
אחזור של משאב (משמש להרחבת משתנים). |
elementConfiguration |
הגדרת רכיב של תהליך עבודה. |
resourceFieldsDefinitionRetrieval |
אחזור של הגדרות השדות שנתמכות על ידי משאב. |
elementUiAutocomplete |
הצעות של ההשלמה האוטומטית לכרטיס שמוצג כרגע. |
| סוף השדות שמוציאים זה את זה. | |
ActionInvocation
הפעלה של פעולה בתהליך עבודה.
| ייצוג ב-JSON |
|---|
{ "inputs": { string: { object ( |
| שדות | |
|---|---|
inputs |
מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט. אובייקט שמכיל רשימה של צמדי |
triggerId |
מזהה הטריגר שמשמש לתגובות אסינכרוניות לפעולות. |
flowLevelContext |
אופציונלי. הקשר ברמת התהליך מהשלבים הקודמים. |
VariableData
מייצג נתונים משתנים, שיכולים להכיל כמה ערכים מסוגים שונים.
| ייצוג ב-JSON |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| שדות | |
|---|---|
booleanValues[] |
ערכים בוליאניים. |
integerValues[] |
ערכים של מספרים שלמים. |
floatValues[] |
ערכים מספריים. |
stringValues[] |
ערכי מחרוזת. |
timestampValues[] |
ערכים של חותמות זמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
resourceReferences[] |
הפניות למשאבים (מזהים). |
emailAddressValues[] |
ערכים של כתובות אימייל. |
googleUserValues[] |
ערכי משתמשים של Google בפורמט |
textFormatValues[] |
ערכי פורמט הטקסט של תהליך העבודה. |
ResourceReference
ערך המזהה של משאב ספציפי לאפליקציה.
| ייצוג ב-JSON |
|---|
{
"resourceType": {
object ( |
| שדות | |
|---|---|
resourceType |
סוג המשאב שהמזהה הזה מצביע עליו. |
resourceId |
מזהה המשאב. |
ResourceType
השם של סוג המשאב המותאם אישית.
| ייצוג ב-JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| שדות | |
|---|---|
workflowBundleId |
המזהה של חבילת תהליך העבודה שהמשאב הזה שייך אליה. השדה הזה הוא אופציונלי. אם הוא ריק, המערכת מתייחסת אליו כאילו הוא שייך לאותה חבילה שבה הוא נמצא בשימוש. |
workflowResourceDefinitionId |
המזהה הייחודי של המשאב. המזהה צריך להיות ייחודי רק בתוך אותה חבילה. |
WorkflowTextFormat
בלוק טקסט עם אפשרויות עיצוב עשירות, כולל סגנונות, היפר-קישורים ורכיבים אינטראקטיביים.
| ייצוג ב-JSON |
|---|
{
"textFormatElements": [
{
object ( |
| שדות | |
|---|---|
textFormatElements[] |
אוסף של רכיבים לעיצוב טקסט. |
TextFormatElement
רכיב יחיד בהודעת WorkflowTextFormat, שיכול להיות צ'יפ, טקסט מעוצב, היפר-קישור או מאגר רשימות.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "chip": { object ( |
| שדות | |
|---|---|
| רכיב שמייצג אחד מכמה רכיבים אפשריים של פורמט טקסט. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
text |
טקסט בפורמט טקסט. |
chip |
צ'יפ שאפשר ללחוץ עליו בפורמט של טקסט. |
styledText |
טקסט מעוצב בפורמט טקסט. |
hyperlink |
היפר-קישור בפורמט של טקסט. |
listContainer |
רשימת קונטיינרים בפורמט טקסט. |
| סוף השדות שמוציאים זה את זה. | |
Chip
צ'יפ בפורמט טקסט שאפשר ללחוץ עליו.
| ייצוג ב-JSON |
|---|
{
"icon": {
object ( |
| שדות | |
|---|---|
icon |
הסמל שמוצג בצ'יפ. |
label |
הטקסט שמוצג בצ'יפ. |
url |
כתובת ה-URL שאליה מועברים כשלוחצים על הצ'יפ. |
סמל
סמל בצ'יפ.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "iconUrl": string, "materialIconName": string // End of mutually exclusive fields. } |
| שדות | |
|---|---|
| הסמל שמוצג בצ'יפ. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
iconUrl |
להציג סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS. לדוגמה: סוגי הקבצים הנתמכים כוללים את |
materialIconName |
שם הסמל שמוגדר ב-Google Material Icon, לדוגמה, |
| סוף השדות שמוציאים זה את זה. | |
StyledText
רכיב טקסט עם סגנונות כמו הדגשה, כתב נטוי וצבע.
| ייצוג ב-JSON |
|---|
{ "text": string, "styles": [ enum ( |
| שדות | |
|---|---|
text |
התוכן העיקרי של הטקסט. |
styles[] |
אוסף של סגנונות שחלים על הטקסט. |
fontWeight |
עובי הגופן של הטקסט. |
color |
הצבע של הטקסט. |
wrapStyle |
סגנון הגלישה של הטקסט. |
סגנון
Enum לסגנונות טקסט שונים כמו נטוי, קו תחתון וכו'.
| טיפוסים בני מנייה (enum) | |
|---|---|
STYLE_UNSPECIFIED |
לא הוחל סגנון. לא להשתמש. |
ITALIC |
סגנון נטוי. |
UNDERLINE |
סגנון קו תחתון. |
STRIKETHROUGH |
סגנון קו חוצה. |
LINE_BREAK |
מעבר שורה. |
UPPERCASE |
סגנון אותיות רישיות. |
CODE |
לתכנת. |
CODE_BLOCK |
בלוק קוד. |
FontWeight
Enum לעוביים שונים של גופנים.
| טיפוסים בני מנייה (enum) | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
משקל סטנדרטי עם עובי רגיל. לא להשתמש. |
LIGHT |
קל ודק יותר. |
MEDIUM |
עובי בינוני בין דק למודגש. |
BOLD |
משקל כבד יותר ועובי גדול יותר. |
WrapStyle
Enum לסגנונות שונים של גלישת טקסט.
| טיפוסים בני מנייה (enum) | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
לא צוין סגנון גלישה. |
NO_WRAP |
בלי סגנון גלישה. |
Hyperlink
רכיב היפר-קישור עם טקסט וקישור.
| ייצוג ב-JSON |
|---|
{ "link": string, "text": string } |
| שדות | |
|---|---|
link |
כתובת היעד של ההיפר-קישור. |
text |
הטקסט של ההיפר-קישור. |
ListContainer
קונטיינר לפריטים ברשימה, שכל אחד מהם יכול להכיל כמה רכיבי TextFormatElement.
| ייצוג ב-JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| שדות | |
|---|---|
listNestLevel |
רמת הדירוג של הרשימה. הערך מתחיל מ-0 ברמה העליונה, וגדל ב-1 בכל רשימה בת. |
listType |
סוג הרשימה. |
listItems[] |
אוסף של פריטים ברשימה. |
ListType
Enum for different list types.
| טיפוסים בני מנייה (enum) | |
|---|---|
LIST_TYPE_UNSPECIFIED |
לא צוין סוג רשימה. לא להשתמש. |
ORDERED |
רשימה ממוינת. |
UNORDERED |
רשימה לא ממוינת. |
BLOCKQUOTE |
מייצג רשימה של ציטוטים. |
ListItem
פריט ברשימה.
| ייצוג ב-JSON |
|---|
{
"textFormatElements": [
{
object ( |
| שדות | |
|---|---|
textFormatElements[] |
אוסף של רכיבים לעיצוב טקסט. |
FlowLevelContext
הקשר ברמת התהליך שמכיל פלט משלבים קודמים.
| ייצוג ב-JSON |
|---|
{
"stepContexts": [
{
object ( |
| שדות | |
|---|---|
stepContexts[] |
אופציונלי. רשימת השלבים הקודמים. הסדר חשוב, לכן צריך לוודא שסדר הביצוע נשמר ברשימה הזו. |
StepContext
מטא-נתונים של הקשר השלב ופלטים להקשר ברמת התהליך.
| ייצוג ב-JSON |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| שדות | |
|---|---|
stepId |
אופציונלי. המזהה הייחודי של השלב בתרשים תהליך העבודה. |
outputs |
אופציונלי. מפה של משתני הפלט שנוצרו בשלב הזה, לפי שם המשתנה. אובייקט שמכיל רשימה של צמדי |
TriggerCreation
יצירת טריגר לתהליך עבודה.
| ייצוג ב-JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| שדות | |
|---|---|
triggerId |
המזהה הייחודי של הטריגר שסופק במהלך היצירה. |
triggerType |
סוג הטריגר. |
inputs |
מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט. אובייקט שמכיל רשימה של צמדי |
notifyUri |
נקודת הקצה שאליה תתבצע הקריאה כשהטריגר יופעל. |
TriggerType
סוג הטריגר.
| טיפוסים בני מנייה (enum) | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
ערך ברירת המחדל. לא להשתמש. |
REPEATING |
הטריגר יופעל בכל פעם שתנאי הקלט יתקיימו. |
TriggerDeletion
מחיקת טריגר של תהליך עבודה.
| ייצוג ב-JSON |
|---|
{ "triggerId": string } |
| שדות | |
|---|---|
triggerId |
המזהה הייחודי של הטריגר שסופק במהלך היצירה. |
ResourceRetrieval
אחזור של משאב.
| ייצוג ב-JSON |
|---|
{
"resourceReference": {
object ( |
| שדות | |
|---|---|
resourceReference |
הסוג והמזהה של המשאב שרוצים לאחזר. |
ElementConfiguration
הפעלה כשמגדירים רכיב של תהליך עבודה.
| ייצוג ב-JSON |
|---|
{ "inputs": { string: { object ( |
| שדות | |
|---|---|
inputs |
מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט. יכול להיות שהמפה הזו ריקה. משמש להגדרת רכיב אחד של תהליך עבודה (טריגר או פעולה) בדף הבית של תהליך העבודה. אובייקט שמכיל רשימה של צמדי |
displayDestination |
היעד של כרטיס הגדרת הרכיב. רכיבים יכולים להשתמש בשדה הזה כדי להחזיר פריסות שונות של כרטיסי הגדרות אישיות בהתאם ליעד. |
nodeId |
מזהה הצומת של ההגדרות הפרימיטיביות שמוצגות. |
workflowId |
מזהה תהליך העבודה של ההגדרה הראשונית שעוברת עיבוד. |
availableVariables[] |
המשתנים הזמינים מסודרים לפי מיקום הצומת. |
DisplayDestination
מציין איפה יוצג כרטיס ההגדרות של הרכיב שחוזר.
| טיפוסים בני מנייה (enum) | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
ערך ברירת המחדל. לא להשתמש. |
DISPLAY_DESTINATION_SIDE_PANEL |
כרטיס ההגדרות יוצג בחלונית הצדדית. |
DISPLAY_DESTINATION_FULL_SCREEN |
כרטיס ההגדרות האישיות יוצג באפליקציה במסך מלא. |
VariableReference
הפניה למשתנה בתהליך העבודה.
| ייצוג ב-JSON |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| שדות | |
|---|---|
parentElementId |
המזהה הפרימיטיבי של הרכיב שמפיק את המשתנה. אפשר להרחיב את זה ל-WorkflowElement או לפרוטוקול מטא-נתונים מפורט יותר, אם צריך. |
nodeId |
מזהה ההפניה של הצומת |
path |
חתימת הנתיב של בורר המשתנים |
dataType |
סוג הנתונים של המשתנה |
iconUrl |
כתובת ה-URL של הסמל של הפרימיטיב שמפיק את המשתנה הזה. |
stepNumber |
מספר השלב של הפרימיטיב שמפיק את המשתנה הזה. |
descriptionText |
תיאור המשתנה. |
displayText |
הטקסט שמוצג בצ'יפ המשתנים. |
DataType
סוג המשתנה.
| ייצוג ב-JSON |
|---|
{ "valueMetadata": { object ( |
| שדות | |
|---|---|
valueMetadata |
מטא-נתונים על הערכים הפוטנציאליים של משתנה. |
| סוג הנתונים. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
basicType |
סוג נתונים בסיסי. |
resourceType |
סוג מזהה המשאב של האפליקציה. |
| סוף השדות שמוציאים זה את זה. | |
BasicType
סוגי נתונים גנריים בסיסיים.
| טיפוסים בני מנייה (enum) | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
ערך ברירת המחדל. לא להשתמש. |
STRING |
מחרוזת של תווים. |
INTEGER |
מספר שלם. |
FLOAT |
מספר נקודה צפה. |
TIMESTAMP |
חותמת זמן בפורמט ISO 8601. |
BOOLEAN |
ערך שיכול להיות True או False. |
EMAIL_ADDRESS |
כתובת אימייל, שהיא מחרוזת בפורמט של כתובת אימייל. |
GOOGLE_USER |
משתמש בשירותי Google, בפורמט users/{user}. |
FILE |
הפניה לקובץ. |
FORMATTED_TEXT |
טקסט עם עיצוב עשיר. |
ValueMetadata
מידע על הערכים האפשריים של משתנה.
| ייצוג ב-JSON |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| שדות | |
|---|---|
enumValues[] |
אופציונלי. מציין את הערכים המותרים למחרוזת. אפשר להגדיר את זה רק אם |
dynamicTypes[] |
אופציונלי. מציינת את הסוגים המותרים שאפשר להמיר באופן דינמי למשתנה. אפשר להגדיר את זה רק אם DataType הוא מחרוזת והמשתנה הוא פלט. |
semanticDescriptors[] |
אופציונלי. עוזר לתאר את המשמעות הסמנטית של משתנה. |
dynamicSchema |
אופציונלי. הגדרות לפתרון דינמי של הסכימה של המשתנה הזה. |
defaultValue |
אופציונלי. מחרוזת שמציינת את ערך ברירת המחדל של המשתנה הזה. לדוגמה, עבור ערכים בוליאניים, אפשר להגדיר את |
SemanticDescriptor
מטא-נתונים על המשמעות הסמנטית של משתנה.
| ייצוג ב-JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| שדות | |
|---|---|
resourceAttribute |
מציין שהמשתנה תואם למאפיין ספציפי של משאב. האפשרות הזו שימושית במיוחד למשתנים שמייצגים מזהה של משאב (מזהה, כתובת URL, מפתח וכו'). הפורמט המומלץ הוא: - דוגמאות: - הלקוח ישתמש במידע הזה כדי לרמוז למשתמש אילו משתני פלט תואמים לקלט מסוים. |
disallowedResourceAttributes[] |
אופציונלי. רלוונטי רק לקלט, ולא רלוונטי לפלט. מאפיינים אסורים שתואמים לתיאור הסמנטי הזה. הלקוח ימנע באופן מפורש בחירת משתנים לפלטים שתואמים לאחד ממאפייני המשאבים האסורים האלה. |
DynamicSchema
הגדרת הסכימה של המשתנה הזה באופן דינמי בזמן הריצה.
| ייצוג ב-JSON |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| שדות | |
|---|---|
requiredInputIds[] |
מזהים של משתני קלט אחים שצריך לספק לפני שאפשר יהיה לפתור באופן דינמי את הסכימה של המשתנה הזה. |
strictEnum |
כשהערך הוא True, ערך המשתנה חייב להתאים לאחד מערכי ה-enum שנפתרו באופן דינמי. כשהערך הוא False, ערכים שנקבעים באופן דינמי נחשבים להצעות לא מחייבות. |
ResourceFieldsDefinitionRetrieval
אחזור של הגדרת השדות שנתמכים על ידי משאב.
| ייצוג ב-JSON |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| שדות | |
|---|---|
elementId |
מציין את המזהה של הרכיב שאת סכימת המשאבים הדינמיים שלו רוצים לאחזר. |
inputs |
הוא מורכב מקלט השדות של הצומת שמספק את המשתנה. מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט. אובייקט שמכיל רשימה של צמדי |
ElementUiAutocomplete
הצעות של ההשלמה האוטומטית לכרטיס שמוצג כרגע.
| ייצוג ב-JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| שדות | |
|---|---|
query |
השאילתה להשלמה אוטומטית. |
inputs |
מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט. אובייקט שמכיל רשימה של צמדי |
invokedFunction |
הפונקציה שמופעלת ומשויכת לווידג'ט. |
resourceId |
מזהה המשאב שצריך להשלים אוטומטית. השדה הזה הוא אופציונלי ויכול להיות שהוא לא מוגדר. |
operationId |
מזהה הפעולה שסיפקה את המשאב להשלמה האוטומטית. השדה הזה הוא אופציונלי, ולא חייבים להגדיר אותו. |
ExecutionMetadata
מטא-נתונים על הרצת תהליך העבודה.
| ייצוג ב-JSON |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| שדות | |
|---|---|
versionId |
גרסת הרכיב של תהליך העבודה שמופעל. |
timeZone |
אזור הזמן של תהליך העבודה שנשמר. לדוגמה, "America/Los_Angeles". |
stepNumber |
מייצג את מספר השלב של הפעולה הבסיסית שמופעלת. |
TriggerEventSource
המקור של אירוע הטריגר שהפעיל את הביצוע הזה.
| טיפוסים בני מנייה (enum) | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
ערך ברירת המחדל. לא להשתמש. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
ההפעלה מתבצעת באופן אוטומטי על ידי אירועים. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
ההפעלה מתבצעת באמצעות הרצת בדיקה. |