EventObject

EventObject

אירוע אינטראקציה עם תוסף של Google שמכיל נתונים על האינטראקציה של המשתמש עם תוסף באפליקציה מארחת.

אובייקט האירוע מועבר כ-JSON לפונקציית קריאה חוזרת (callback) או לטריגר של תוסף (ב-AppsScript), או לנקודת קצה (endpoint) של https (ב-HTTP), כשמשתמש יוצר אינטראקציה עם תוסף באפליקציה מארחת. אובייקט האירוע מאחסן אובייקט אירוע של אפליקציה מארחת שמוגדר על ידי כל אפליקציה מארחת, וגם אובייקט אירוע נפוץ שמכיל כמה שדות נפוצים שקשורים לאירוע.

מידע נוסף זמין במאמר אובייקטים מסוג אירוע.

ייצוג ב-JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
שדות
commonEventObject

object (CommonEventObject)

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

authorizationEventObject

object (AuthorizationEventObject)

מוגדר רק לבקשות לנקודות קצה (endpoint) של HTTP

ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
calendar

object (CalendarEventObject)

מוצג רק אם המארח המזמין הוא יומן Google. אובייקט שמכיל מידע על היומן ועל האירוע.

drive

object (DriveEventObject)

מוצג רק אם המארח שמבצע את הקריאה הוא Google Drive. אובייקט שמכיל מידע על Drive.

gmail

object (GmailEventObject)

מוצג רק אם המארח שמבצע את השיחה הוא Gmail. אובייקט שמכיל מידע מ-Gmail.

sheets

object (SheetsEventObject)

מוצג רק אם המארח שמתקשר הוא Google Sheets. אובייקט שמכיל מידע על Sheets.

slides

object (SlidesEventObject)

מוצג רק אם המארח שמתקשר הוא Google Slides. אובייקט שמכיל מידע על Slides.

docs

object (DocsEventObject)

מוצג רק אם המארח המזמין הוא Google Docs. אובייקט שמכיל מידע על Docs.

chat

object (ChatEventObject)

מוצג רק אם המארח של השיחה הוא Google Chat. אובייקט שמכיל מידע על הצ'אט.

workflow

object (WorkflowEventObject)

מופיע רק אם המארח שמתקשר הוא Google Workspace Studio. אובייקט שמכיל מידע על תהליך העבודה.

סוף השדות שמוציאים זה את זה.

CommonEventObject

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

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

באפליקציות ל-Chat, שם הפונקציה שהמשתמש הפעיל כשהייתה לו אינטראקציה עם ווידג'ט.

ייצוג ב-JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
שדות
userLocale

string

מושבתת כברירת מחדל. מזהה השפה והמדינה או האזור של המשתמש בפורמט של קוד שפה לפי תקן ISO 639 וקוד מדינה או אזור לפי תקן ISO 3166. לדוגמה, en-US.

כדי להפעיל את השדה הזה, צריך להגדיר את addOns.common.useLocaleFromApp ל-true במניפסט של התוסף. רשימת ההיקפים של התוסף צריכה לכלול גם את https://www.googleapis.com/auth/script.locale. פרטים נוספים זמינים במאמר גישה למיקום ולאזור הזמן של המשתמש.

hostApp

enum (HostApp)

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

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

טיפוס הנתונים המנייתי של הפלטפורמה שמציין את הפלטפורמה שבה האירוע נוצר (WEB, ‏IOS או ANDROID). לא נתמך באפליקציות ל-Chat.

timeZone

object (TimeZone)

מושבתת כברירת מחדל. מזהה אזור הזמן וההפרש מהזמן האוניברסלי המתואם (UTC). כדי להפעיל את השדה הזה, צריך להגדיר את addOns.common.useLocaleFromApp ל-true במניפסט של התוסף. רשימת ההיקפים של התוסף צריכה לכלול גם את https://www.googleapis.com/auth/script.locale. פרטים נוספים זמינים במאמר גישה למיקום ולאזור הזמן של המשתמש.

נתמך רק בסוגי האירועים CARD_CLICKED ו-SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

מפה שמכילה את הערכים הנוכחיים של הווידג'טים בכרטיס שמוצג. המפתחות של המפה הם ערכי המחרוזת name שמוקצים לכל ווידג'ט קלט (כמו TextInput.name,‏ SelectionInput.name,‏ DateTimePicker.name או DecoratedText.SwitchControl.name).

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

הערה: הדוגמאות הבאות מותאמות לסביבת ההרצה של V8 ב-Apps Script. אם משתמשים בסביבת זמן הריצה Rhino, צריך להוסיף [""] אחרי הערך. לדוגמה, במקום e.commonEventObject.formInputs.employeeName.stringInputs.value[0], צריך להגדיר את הפורמט של אובייקט האירוע בתור e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. מידע נוסף על סביבות הרצה ב-Apps Script זמין בסקירה הכללית על סביבת ההרצה של V8.

  • ווידג'טים עם ערך יחיד (לדוגמה, ווידג'ט TextInput או ווידג'ט SelectionInput מסוג DROPDOWN או RADIO_BUTTON): אובייקט StringInputs שמכיל רשימה עם רכיב אחד (או רשימה ריקה אם לא נבחרה אפשרות).

דוגמה: לווידג'ט של קלט טקסט עם employeeName בתור name, אפשר לגשת לערך של קלט הטקסט באמצעות: e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • ווידג'טים עם כמה ערכים (לדוגמה, ווידג'ט SelectionInput מסוג CHECK_BOX, SWITCH או MULTI_SELECT): אובייקט StringInputs שמכיל את רשימת המחרוזות value של הפריטים שנבחרו.

דוגמה: בווידג'ט עם כמה ערכים שבו participants הוא name, ניגשים למערך הערכים באמצעות: e.commonEventObject.formInputs.participants.stringInputs.value.

  • ווידג'ט DecoratedText.SwitchControl: אובייקט מסוג StringInputs. כאשר selected הוא true, stringInputs.value מכיל את השדה value של המתג (או "" אם value לא צוין; אם מספר מתגים חולקים את אותו name, ה-value של כל מתג שנבחר נכלל ברשימה). כשהערך של selected הוא false, המערכת משמיטה את value של המתג מ-stringInputs.value.

  • בורר תאריך ושעה (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

דוגמה: בבורר עם name של myDTPicker, ניגשים לאובייקט DateTimeInput באמצעות e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • בורר תאריכים בלבד (DateTimePickerType.DATE_ONLY): DateInput object.

דוגמה: בבורר עם name של myDatePicker, ניגשים לאובייקט DateInput באמצעות e.commonEventObject.formInputs.myDatePicker.dateInput.

דוגמה: בבורר עם name של myTimePicker, ניגשים לאובייקט TimeInput באמצעות e.commonEventObject.formInputs.myTimePicker.timeInput.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

כל פרמטר נוסף שאתם מספקים לפעולה באמצעות actionParameters או Action.setParameters().

תצוגה מקדימה למפתחים: בתוספים שמרחיבים את Google Chat, כדי להציע פריטים על סמך מה שהמשתמשים מקלידים בתפריטים לבחירה מרובה, צריך להשתמש בערך של המפתח "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). אפשר להשתמש בערך הזה כדי לשלוח שאילתה למסד נתונים ולהציע למשתמשים פריטים לבחירה בזמן שהם מקלידים. פרטים נוספים זמינים במאמר איסוף ועיבוד מידע ממשתמשי Google Chat.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

שם הפונקציה שרוצים להפעיל.

השדה הזה לא מאוכלס בתוספים ל-Google Workspace שמרחיבים את Google Chat. במקום זאת, כדי לקבל נתוני פונקציות כמו מזהים, תוספים שמרחיבים את Chat צריכים להשתמש בשדה parameters. איך יוצרים ממשקים אינטראקטיביים לאפליקציות ל-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

string

קוד מסד הנתונים של אזור הזמן IANA TZ, כמו "America/Toronto".

offset

integer

ההפרש בין אזור הזמן של המשתמש לבין זמן אוניברסלי מתואם (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": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
שדות
ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
stringInputs

object (StringInputs)

רשימה של מחרוזות שמייצגות את הערכים שהמשתמש מזין בווידג'ט.

אם הווידג'ט מקבל רק ערך אחד, כמו ווידג'ט TextInput, הרשימה מכילה אובייקט מחרוזת אחד. אם הווידג'ט מקבל כמה ערכים, כמו ווידג'ט SelectionInput של תיבות סימון, הרשימה מכילה אובייקט מחרוזת לכל ערך שהמשתמש מזין או בוחר.

dateTimeInput

object (DateTimeInput)

ערכי קלט של תאריך ושעה מווידג'ט DateTimePicker שמקבל גם תאריך וגם שעה.

dateInput

object (DateInput)

ערכי קלט של תאריכים מווידג'ט DateTimePicker שמקבל רק ערכי תאריכים.

timeInput

object (TimeInput)

ערכי קלט של זמן מווידג'ט DateTimePicker שמקבל רק ערכי זמן.

סוף השדות שמוציאים זה את זה.

StringInputs

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

ייצוג ב-JSON
{
  "value": [
    string
  ]
}
שדות
value[]

string

רשימה של מחרוזות שהמשתמש הזין.

DateTimeInput

ערכי קלט של תאריך ושעה.

ייצוג ב-JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
שדות
msSinceEpoch

string (int64 format)

הזמן שחלף מאז ראשית זמן יוניקס (Unix epoch), באלפיות השנייה.

hasDate

boolean

אם הקלט של datetime כולל תאריך ביומן.

hasTime

boolean

אם הקלט של datetime כולל חותמת זמן.

DateInput

ערכי קלט של תאריכים.

ייצוג ב-JSON
{
  "msSinceEpoch": string
}
שדות
msSinceEpoch

string (int64 format)

הזמן שחלף מאז ראשית זמן יוניקס (Unix epoch), באלפיות השנייה.

TimeInput

ערכי קלט של זמן.

ייצוג ב-JSON
{
  "hours": integer,
  "minutes": integer
}
שדות
hours

integer

השעה בשעון של 24 שעות.

minutes

integer

מספר הדקות אחרי השעה העגולה. הערכים התקינים הם 0 עד 59.

AuthorizationEventObject

מכיל את פרטי ההרשאה לבקשת התוסף

ייצוג ב-JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
שדות
userOAuthToken

string

טוקן הגישה ל-OAuth של משתמש הקצה, שאושר עם ההיקפים המבוקשים. (אחרי ביטול החבילה של הסכמת OAuth, ההרשאה תתבצע באמצעות היקפי הרשאות שמשתמשי הקצה אישרו)

userIdToken

string

טוקן של מזהה של משתמש קצה, אם נשלחה בקשה להיקפי מזהה מתאימים

systemIdToken

string

טוקן של מזהה לחשבון השירות של התוספים ל-G Suite לפריסה הזו

authorizedScopes[]

string

רשימה של היקפי הרשאות OAuth שהמשתמש אישר.

CalendarEventObject

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

בטבלה הבאה מפורטים השדות שמופיעים בשדה calendar של אובייקט מסוג אירוע. שדות שמסומנים כנתונים שנוצרו על ידי משתמשים קיימים באובייקט מסוג אירוע רק אם הנתונים קיימים באירוע ביומן והתוסף מגדיר את שדה addOns.calendar.currentEventAccess במניפסט שלו כ-READ או כ-READ_WRITE.

ייצוג ב-JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
שדות
id

string

מזהה האירוע.

recurringEventId

string

המזהה של אירוע חוזר.

calendarId

string

מזהה היומן.

organizer

object (Organizer)

אובייקט שמייצג את מארגן האירוע.

attendees[]

object (Attendee)

נתונים שנוצרו על ידי משתמשים. רשימת המשתתפים באירוע ביומן.

conferenceData

object (ConferenceData)

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

capabilities

object (Capabilities)

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

מארגן

ייצוג ב-JSON
{
  "email": string
}
שדות
email

string

כתובת האימייל של מארגן האירוע.

משתתפים

אובייקטים של משתתפים מכילים מידע על משתתפים ספציפיים באירועים ביומן 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

string

כתובת האימייל של המשתתף.

displayName

string

השם המוצג של המשתתף.

organizer

boolean

true אם המשתתף הוא מארגן האירוע.

self

boolean

true אם המשתתף הזה מייצג את היומן שבו האירוע הזה מופיע, אחרת false.

resource

boolean

true אם המשתתף מייצג משאב, כמו חדר או ציוד, אחרת false.

optional

boolean

true אם ההשתתפות של המשתתף הזה מסומנת כרשות, אחרת false.

responseStatus

string

סטטוס התשובה של המשתתף. הערכים האפשריים כוללים:

  • accepted: המשתתף אישר את ההזמנה לאירוע.
  • declined: המשתתף דחה את ההזמנה לאירוע.
  • ‫needsAction: המשתתף לא הגיב להזמנה לאירוע.
  • tentative: המשתתף אישר את ההזמנה לאירוע באופן טנטטיבי.
comment

string

התגובה של המשתתף, אם יש כזו.

additionalGuests

integer

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

ConferenceData

אובייקטים של נתוני שיחות ועידה מכילים מידע על שיחות ועידה שמצורפות לאירועים ביומן Google. אלה יכולים להיות פתרונות לשיחות ועידה של Google, כמו Google Meet, או שיחות ועידה של צד שלישי. המידע הזה מופיע באובייקט מסוג אירוע רק אם הנתונים מופיעים באירוע ביומן, והתוסף מגדיר את שדה addOns.calendar.currentEventAccess במניפסט שלו כ-READ או כ-READ_WRITE.

ייצוג ב-JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
שדות
conferenceId

string

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

conferenceSolution

object (ConferenceSolution)

אובייקט שמייצג את הפתרון לשיחות ועידה, כמו Hangouts או Google Meet.

entryPoints[]

object (EntryPoint)

רשימת נקודות הכניסה לוועידה, כמו כתובות URL או מספרי טלפון.

notes

string

הערות נוספות (כמו הוראות ממנהל הדומיין או הודעות משפטיות) לגבי שיחת הוועידה שיוצגו למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2,048 תווים.

parameters

object (Parameters)

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

ConferenceSolution

ייצוג ב-JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
שדות
iconUri

string

ה-URI של הסמל שמוצג למשתמשים ומייצג את הפתרון הזה לשיחות ועידה.

key

object (Key)

המפתח שמזהה באופן ייחודי את הפתרון לשיחות ועידה באירוע הזה.

name

string

השם של פתרון לשיחות ועידה זה שגלוי למשתמש (לא מותאם לשוק המקומי).

מפתח

ייצוג ב-JSON
{
  "type": string
}
שדות
type

string

סוג הפתרון לשיחות ועידה. הערכים האפשריים כוללים:

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

string

קוד הגישה ששימש כדי להצטרף לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה.

entryPointType

string

סוג נקודת הכניסה. הערכים האפשריים הם:

  • more: הוראות נוספות להצטרפות לוועידה, כמו מספרי טלפון חלופיים. לשיחת ועידה יכולה להיות רק נקודת כניסה אחת מסוג more. אם היא קיימת, צריך גם לפחות נקודת כניסה אחת מסוג אחר.
  • phone: הצטרפות לשיחת הוועידה באמצעות מספר טלפון. לשיחת ועידה יכולות להיות אפס או יותר נקודות כניסה טלפוניות. ביומן Google מוצגות רק שתי נקודות הכניסה הראשונות לשיחה טלפונית, אחרי עיצוב ומיון בסדר אלפביתי.
  • ‫sip: הצטרפות לשיחת הוועידה באמצעות SIP. לכל פגישה יכולה להיות נקודת כניסה אחת לכל היותר באמצעות SIP.
  • video: הצטרפות לוועידה באמצעות HTTP. לכל שיחת ועידה יכולה להיות נקודת כניסה אחת לכל היותר לוידאו.
label

string

התווית שגלויה למשתמשים של ה-URI של נקודת הכניסה (לא מותאמת לשוק המקומי).

meetingCode

string

קוד הפגישה ששימש כדי לגשת לוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה.

passcode

string

קוד הגישה שמשמש כדי להצטרף לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה.

password

string

הסיסמה שמשמשת כדי להצטרף לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה.

pin

string

קוד האימות שמשמש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל, ספקי ועידות משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לספק גישה לוועידות. להתאים ולהציג רק את השדות שבהם משתמש ספק שיחות הוועידה.

uri

string

ה-URI של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים. הפורמט תלוי בסוג נקודת הכניסה:

  • more: נדרשת סכימה של http:‎ או https:‎.
  • phone: נדרשת סכימה של tel:‎. ה-URI צריך לכלול את כל רצף החיוג (לדוגמה, "tel:+12345678900,,,12345678;1234").
  • ‫sip: נדרשת סכימה של sip:‎ או sips:‎. לדוגמה, "sip:12345678@myprovider.com".
  • סרטון: נדרשת סכימה מסוג http:‎ או https:‎.
regionCode

string

קוד האזור של מספר הטלפון. המשתמשים צריכים את זה אם ה-URI לא כולל קוד מדינה. הערכים מבוססים על רשימת קודי האזורים הציבורית של CLDR.

entryPointFeatures[]

string

התכונות של נקודת הכניסה. נכון לעכשיו, התכונות האלה חלות רק על נקודות כניסה לטלפון:

  • toll: נקודת הכניסה היא שיחת טלפון בתשלום.
  • ‫toll_free: נקודת הכניסה היא שיחת חינם.

פרמטרים

ייצוג ב-JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
שדות
addOnParameters

object (AddOnParameters)

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

AddOnParameters

ייצוג ב-JSON
{
  "parameters": {
    string: string,
    ...
  }
}
שדות
parameters

map (key: string, value: string)

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

יכולות

ייצוג ב-JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
שדות
canSeeAttendees

boolean

נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול לקרוא את רשימת המשתתפים באירוע, אחרת false.

canAddAttendees

boolean

נתונים שנוצרו על ידי משתמשים. הערך true אם התוסף יכול להוסיף משתתפים חדשים לרשימת המשתתפים באירוע, אחרת הערך הוא false.

canSeeConferenceData

boolean

נתונים שנוצרו על ידי המשתמש. true אם התוסף יכול לקרוא את נתוני שיחת הוועידה של האירוע, אחרת false.

canSetConferenceData

boolean

נתונים שנוצרו על ידי המשתמש. true אם התוסף יכול לעדכן את נתוני שיחת הוועידה של האירוע, אחרת false.

canAddAttachments

boolean

נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול להוסיף קבצים חדשים לאירוע, אחרת false.

DriveEventObject

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

ייצוג ב-JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
שדות
selectedItems[]

object (DriveItemMetadata)

רשימה של פריטים (קבצים או תיקיות) שנבחרו ב-Drive.

activeCursorItem

object (DriveItemMetadata)

הפריט ב-Drive שפעיל כרגע.

DriveItemMetadata

אובייקטים של פריטים ב-Drive מכילים מידע על פריטים ספציפיים ב-Drive, כמו קבצים או תיקיות.

ייצוג ב-JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
שדות
id

string

המזהה של הפריט שנבחר.

iconUrl

string

כתובת ה-URL של הסמל שמייצג את הפריט שנבחר.

mimeType

string

סוג ה-MIME של הפריט שנבחר.

title

string

השם של הפריט שנבחר.

addonHasFileScopePermission

boolean

אם הערך הוא 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

string

המזהה של ההודעה שפתוחה כרגע ב-Gmail.

threadId

string

מזהה השרשור שפתוח כרגע ב-Gmail.

accessToken

string

טוקן הגישה הספציפי ל-Gmail. אתם יכולים להשתמש בטוקן הזה עם השיטה GmailApp.setCurrentMessageAccessToken(accessToken) כדי לתת לתוסף גישה זמנית להודעת Gmail של המשתמש שפתוחה כרגע, או לאפשר לתוסף לכתוב טיוטות חדשות.

toRecipients[]

string

מושבתת כברירת מחדל. רשימת כתובות האימייל של הנמענים בשדה "אל:" שכלולות כרגע בטיוטה שהתוסף יוצר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה addOns.gmail.composeTrigger.draftAccess במניפסט ל-METADATA.

ccRecipients[]

string

מושבתת כברירת מחדל. רשימת כתובות האימייל של הנמענים בשדה "עותק:" שכלולות כרגע בטיוטה שהתוסף יוצר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה addOns.gmail.composeTrigger.draftAccess במניפסט ל-METADATA.

bccRecipients[]

string

מושבתת כברירת מחדל. רשימת כתובות האימייל של הנמענים בשדה "עותק מוסתר:" שכלולות כרגע בטיוטה שהתוסף יוצר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה addOns.gmail.composeTrigger.draftAccess במניפסט ל-METADATA.

SheetsEventObject

אובייקט מסוג אירוע ב-Sheets הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על המסמך של המשתמש והתוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם התוסף מרחיב את Google Sheets.

ייצוג ב-JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
שדות
id

string

מוצג רק אם המשתמש אישר את ההיקף https://www.googleapis.com/auth/drive.file. המזהה של הגיליון האלקטרוני שפתוח בממשק המשתמש של Sheets.

title

string

מוצג רק אם המשתמש אישר את ההיקף https://www.googleapis.com/auth/drive.file. השם של הגיליון האלקטרוני שפתוח בממשק המשתמש של Sheets.

addonHasFileScopePermission

boolean

אם הערך הוא true, התוסף ביקש וקיבל הרשאה להיקף https://www.googleapis.com/auth/drive.file לגיליון האלקטרוני שפתוח בממשק המשתמש של Sheets. אחרת, הערך בשדה הזה הוא false.

matchedUrl

object (MatchedUrl)

השדה הזה מופיע רק אם מתקיימים התנאים הבאים:

  • המשתמש נתן הרשאה ל-https://www.googleapis.com/auth/workspace.linkpreview.
  • כתובת ה-URL תואמת לתבנית המארח שצוינה בטריגר LinkPreviewTriggers.

כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Sheets. כדי להשתמש בשדה הזה, צריך להגדיר את LinkPreviewTriggers במניפסט של התוסף. פרטים נוספים זמינים במאמר תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.

מטען ייעודי (payload) לדוגמה כשמשתמש צופה בתצוגה מקדימה של הקישור https://www.example.com/12345:

"sheets" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

MatchedUrl

אובייקט מסוג אירוע שמוחזר עם בקשות לתצוגה מקדימה של קישורים.

ייצוג ב-JSON
{
  "url": string
}
שדות
url

string

כתובת ה-URL שהותאמה.

SlidesEventObject

האובייקט מסוג אירוע ב-Slides הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על המסמך של המשתמש ועל התוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם התוסף מרחיב את Google Slides.

ייצוג ב-JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
שדות
id

string

מוצג רק אם המשתמש אישר את ההיקף https://www.googleapis.com/auth/drive.file. המזהה של המצגת שפתוחה בממשק המשתמש של Slides.

title

string

מוצג רק אם המשתמש אישר את ההיקף https://www.googleapis.com/auth/drive.file. שם המצגת שפתוחה בממשק המשתמש של Slides.

addonHasFileScopePermission

boolean

אם הערך הוא true, התוסף ביקש וקיבל הרשאה להיקף https://www.googleapis.com/auth/drive.file עבור המצגת שפתוחה בממשק המשתמש של Slides. אחרת, הערך בשדה הזה הוא false.

matchedUrl

object (MatchedUrl)

השדה הזה מופיע רק אם מתקיימים התנאים הבאים:

  • המשתמש נתן הרשאה ל-https://www.googleapis.com/auth/workspace.linkpreview.
  • כתובת ה-URL תואמת לתבנית המארח שצוינה בטריגר LinkPreviewTriggers.

כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Slides. כדי להשתמש בשדה הזה, צריך להגדיר את LinkPreviewTriggers במניפסט של התוסף. פרטים נוספים זמינים במאמר תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.

מטען ייעודי (payload) לדוגמה כשמשתמש צופה בתצוגה מקדימה של הקישור https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

DocsEventObject

האובייקט מסוג אירוע ב-Docs הוא החלק באובייקט מסוג אירוע הכולל שנושא מידע על המסמך של המשתמש והתוכן שלו. הוא מופיע באובייקט מסוג אירוע רק אם התוסף מרחיב את Google Docs.

ייצוג ב-JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
שדות
id

string

מוצג רק אם המשתמש אישר את ההיקף https://www.googleapis.com/auth/drive.file. המזהה של המסמך שפתוח בממשק המשתמש של Docs.

title

string

מוצג רק אם המשתמש אישר את ההיקף https://www.googleapis.com/auth/drive.file. שם המסמך שפתוח בממשק המשתמש של Docs.

addonHasFileScopePermission

boolean

אם הערך הוא true, התוסף ביקש וקיבל הרשאה להיקף https://www.googleapis.com/auth/drive.file עבור המסמך שפתוח בממשק המשתמש של Docs. אחרת, הערך בשדה הזה הוא false.

matchedUrl

object (MatchedUrl)

השדה הזה מופיע רק אם מתקיימים התנאים הבאים:

  • המשתמש נתן הרשאה ל-https://www.googleapis.com/auth/workspace.linkpreview.
  • כתובת ה-URL תואמת לתבנית המארח שצוינה בטריגר LinkPreviewTriggers.

כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Docs. כדי להשתמש בשדה הזה, צריך להגדיר את LinkPreviewTriggers במניפסט של התוסף. פרטים נוספים זמינים במאמר תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.

מטען ייעודי (payload) לדוגמה כשמשתמש צופה בתצוגה מקדימה של הקישור https://www.example.com/12345:

"docs" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

ChatEventObject

מטען ייעודי (payload) של אובייקט מסוג אירוע באפליקציית Google Chat שנשלח משרת Google לתוספים. אפשר להשתמש במטענים ייעודיים כדי לזהות את סוג האירוע.

ייצוג ב-JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
שדות
type

enum (EventType)

סוג האירוע, מאוכלס רק באירועים של דף הבית של האפליקציה באפליקציות ל-Chat שהן לא תוספים.

user

object (User)

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

space

object (Space)

המרחב שבו האירוע התרחש. השדה הזה מאוכלס רק באירועים של דף הבית של האפליקציה באפליקציות ל-Chat שהן לא תוספים.

eventTime

string (Timestamp format)

חותמת הזמן שמציינת מתי מתרחש אובייקט מסוג אירוע.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

המטען הייעודי (payload) של אובייקט מסוג אירוע. המטענים הייעודיים תלויים בסוג האובייקט של האירוע. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
messagePayload

object (MessagePayload)

משתמש שולח הודעה לאפליקציה ל-Chat או מתייג אותה במרחב באמצעות @. הפעלות של פקודות באפליקציה (כמו פקודות דרך שורת הפקודות ופקודות מהירות) נשלחות במקום זאת ב-appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

משתמש מוסיף את האפליקציה ל-Chat למרחב ב-Chat, או אדמין ב-Google Workspace מתקין את האפליקציה ל-Chat במרחבים של צ'אטים אישיים בשביל המשתמשים בארגון.

removedFromSpacePayload

object (RemovedFromSpacePayload)

משתמש מסיר את האפליקציה ל-Chat מהמרחב.

buttonClickedPayload

object (ButtonClickedPayload)

מייצג את נתוני המטען הייעודי (payload) כשמשתמש יוצר אינטראקציה עם רכיב אינטראקטיבי של כרטיס או תיבת דו-שיח שמפעילה קריאה חוזרת (callback) של Action. למרות השם, המטען הייעודי (payload) הזה מאוכלס לכל הקריאות החוזרות (callbacks) של הכרטיסים ותיבות הדו-שיח של Action – לא רק קליקים על לחצנים, אלא גם טריגרים של onChangeAction, פעולות של onClick, קליקים על CardAction ושליחה או ביטול של תיבת דו-שיח (SUBMIT_DIALOG ו-CANCEL_DIALOG).

אם משתמש יוצר אינטראקציה עם תיבת דו-שיח, השדה isDialogEvent של ButtonClickedPayload מוגדר כ-true וכולל DialogEventType.

המטען הייעודי (payload) המלא כולל גם את commonEventObject.formInputs ו-commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

משתמש מעדכן ווידג'ט בכרטיס בתוך הזרם או בתיבת דו-שיח.

המטען הייעודי (payload) המלא כולל גם את CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

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

systemCommandPayload

object (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)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
שדות
space

object (Space)

חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע.

message

object (Message)

ההודעה שמפעילה את אובייקט האירוע.

configCompleteRedirectUri

string

אופציונלי. כתובת ה-URL שאליה האפליקציה ל-Chat צריכה להפנות את המשתמש אחרי שהוא משלים תהליך של הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף מופיע במאמר איך מחברים אפליקציות ל-Chat לשירותים ולכלים אחרים.

AddedToSpacePayload

משתמש מוסיף את אפליקציית הצ'אט למרחב, או שנוצר צ'אט בין האפליקציה למשתמש.

ייצוג ב-JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
שדות
space

object (Space)

חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע.

interactionAdd

boolean

אם האפליקציה נוספה למרחב באמצעות אינטראקציה של משתמש (לדוגמה, על ידי תיוג של האפליקציה ל-Chat באמצעות @ או הפעלה באמצעות פקודה דרך שורת הפקודות). אם הערך הוא true, אובייקט מסוג אירוע נפרד שמשויך לאינטראקציה עצמה יישלח לאפליקציה ל-Chat.

configCompleteRedirectUri

string

אופציונלי. כתובת ה-URL שאליה האפליקציה ל-Chat צריכה להפנות את המשתמש אחרי שהוא משלים תהליך של הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף מופיע במאמר איך מחברים אפליקציות ל-Chat לשירותים ולכלים אחרים.

RemovedFromSpacePayload

משתמש מסיר את האפליקציה ל-Chat מהמרחב.

ייצוג ב-JSON
{
  "space": {
    object (Space)
  }
}
שדות
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)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
שדות
space

object (Space)

חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע.

message

object (Message)

ההודעה שמפעילה את אובייקט האירוע.

isDialogEvent

boolean

באובייקטים מסוג אירוע ButtonClicked ו-Message, אם המשתמש יוצר אינטראקציה עם תיבת דו-שיח או עומד ליצור איתה אינטראקציה.

dialogEventType

enum (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)
  }
}
שדות
space

object (Space)

חובה. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע.

AppCommandPayload

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

ייצוג ב-JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
שדות
appCommandMetadata

object (AppCommandMetadata)

מאוכלס בפקודות לאפליקציות, כולל פקודות דרך שורת הפקודות ופקודות מהירות.

space

object (Space)

אופציונלי. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע.

thread

object (Thread)

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

message

object (Message)

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

configCompleteRedirectUri

string

אופציונלי. כתובת ה-URL שאליה המשתמש צריך להיות מופנה אחרי שהוא משלים תהליך של הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף מופיע במאמר איך מחברים אפליקציות ל-Chat לשירותים ולכלים אחרים.

isDialogEvent

boolean

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

dialogEventType

enum (DialogEventType)

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

AppCommandMetadata

מטא-נתונים על פקודה באפליקציה ל-Chat.

ייצוג ב-JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
שדות
appCommandId

integer

המזהה של הפקודה שצוינה בהגדרות של Chat API.

appCommandType

enum (AppCommandType)

סוג הפקודה של אפליקציית הצ'אט.

AppCommandType

סוג הפקודה של אפליקציית הצ'אט. פרטים נוספים מופיעים במאמר סוגי פקודות לאפליקציות ל-Chat.

טיפוסים בני מנייה (enum)
APP_COMMAND_TYPE_UNSPECIFIED ערך ברירת המחדל. לא צוין.
SLASH_COMMAND פקודה דרך שורת הפקודות. המשתמש שולח את הפקודה בהודעת צ'אט.
QUICK_COMMAND פקודה מהירה. המשתמש בוחר את הפקודה מהתפריט של Chat באזור התשובה להודעה.
MESSAGE_ACTION פעולה שקשורה להודעה. המשתמש בוחר את הפקודה מתפריט ההקשר של ההודעה ב-Chat.

SystemCommandPayload

משתמש מפעיל פקודת מערכת.

ייצוג ב-JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
שדות
systemCommandMetadata

object (SystemCommandMetadata)

מטא-נתונים על פקודת המערכת שהופעלה.

space

string

אופציונלי. מרחב ב-Chat שבו מתרחש אובייקט מסוג אירוע.

thread

object (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)
  }
  // End of mutually exclusive fields.
}
שדות
פקודת המערכת שהופעלה. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
cancelStream

object (CancelStream)

פקודה לביטול הודעה פעילה בסטרימינג.

סוף השדות שמוציאים זה את זה.

CancelStream

פקודה לביטול הודעה פעילה בסטרימינג.

ייצוג ב-JSON
{
  "streamMessage": string
}
שדות
streamMessage

string

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

פורמט: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange אובייקט מסוג אירוע שמועבר לתוספים של תהליכי עבודה.

ייצוג ב-JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
שדות
executionMetadata

object (ExecutionMetadata)

מטא-נתונים על הרצת תהליך העבודה.

triggerEventSource

enum (TriggerEventSource)

המקור של האירועים המפעילים.

סוג המטען הייעודי (payload) של אירוע בתהליך העבודה. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
actionInvocation

object (ActionInvocation)

הפעלה של פעולה בתהליך עבודה.

triggerCreation

object (TriggerCreation)

יצירת טריגר לתהליך עבודה.

triggerDeletion

object (TriggerDeletion)

מחיקת טריגר של תהליך עבודה.

resourceRetrieval

object (ResourceRetrieval)

אחזור של משאב (משמש להרחבת משתנים).

elementConfiguration

object (ElementConfiguration)

הגדרת רכיב של תהליך עבודה.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

אחזור של הגדרות השדות שנתמכות על ידי משאב.

elementUiAutocomplete

object (ElementUiAutocomplete)

הצעות של ההשלמה האוטומטית לכרטיס שמוצג כרגע.

סוף השדות שמוציאים זה את זה.

ActionInvocation

הפעלה של פעולה בתהליך עבודה.

ייצוג ב-JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
שדות
inputs

map (key: string, value: object (VariableData))

מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

מזהה הטריגר שמשמש לתגובות אסינכרוניות לפעולות.

flowLevelContext

object (FlowLevelContext)

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

VariableData

מייצג נתונים משתנים, שיכולים להכיל כמה ערכים מסוגים שונים.

ייצוג ב-JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
שדות
booleanValues[]

boolean

ערכים בוליאניים.

integerValues[]

string (int64 format)

ערכים של מספרים שלמים.

floatValues[]

number

ערכים מספריים.

stringValues[]

string

ערכי מחרוזת.

timestampValues[]

string (Timestamp format)

ערכים של חותמות זמן.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

הפניות למשאבים (מזהים).

emailAddressValues[]

string

ערכים של כתובות אימייל.

googleUserValues[]

string

ערכי משתמשים של Google בפורמט users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

ערכי פורמט הטקסט של תהליך העבודה.

ResourceReference

ערך המזהה של משאב ספציפי לאפליקציה.

ייצוג ב-JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
שדות
resourceType

object (ResourceType)

סוג המשאב שהמזהה הזה מצביע עליו.

resourceId

string

מזהה המשאב.

ResourceType

השם של סוג המשאב המותאם אישית.

ייצוג ב-JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
שדות
workflowBundleId

string

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

workflowResourceDefinitionId

string

המזהה הייחודי של המשאב. המזהה צריך להיות ייחודי רק בתוך אותה חבילה.

WorkflowTextFormat

בלוק טקסט עם אפשרויות עיצוב עשירות, כולל סגנונות, היפר-קישורים ורכיבים אינטראקטיביים.

ייצוג ב-JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
שדות
textFormatElements[]

object (TextFormatElement)

אוסף של רכיבים לעיצוב טקסט.

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 (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
שדות
רכיב שמייצג אחד מכמה רכיבים אפשריים של פורמט טקסט. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
text

string

טקסט בפורמט טקסט.

chip

object (Chip)

צ'יפ שאפשר ללחוץ עליו בפורמט של טקסט.

styledText

object (StyledText)

טקסט מעוצב בפורמט טקסט.

listContainer

object (ListContainer)

רשימת קונטיינרים בפורמט טקסט.

סוף השדות שמוציאים זה את זה.

Chip

צ'יפ בפורמט טקסט שאפשר ללחוץ עליו.

ייצוג ב-JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
שדות
icon

object (Icon)

הסמל שמוצג בצ'יפ.

label

string

הטקסט שמוצג בצ'יפ.

url

string

כתובת ה-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

string

להציג סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS.

לדוגמה:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

סוגי הקבצים הנתמכים כוללים את .png ו-.jpg.

materialIconName

string

שם הסמל שמוגדר ב-Google Material Icon, לדוגמה, check_box. שמות לא חוקיים נמחקים ומוחלפים במחרוזת ריקה, והסמל לא מוצג.

סוף השדות שמוציאים זה את זה.

StyledText

רכיב טקסט עם סגנונות כמו הדגשה, כתב נטוי וצבע.

ייצוג ב-JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
שדות
text

string

התוכן העיקרי של הטקסט.

styles[]

enum (Style)

אוסף של סגנונות שחלים על הטקסט.

fontWeight

enum (FontWeight)

עובי הגופן של הטקסט.

color

object (Color)

הצבע של הטקסט.

wrapStyle

enum (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 בלי סגנון גלישה.

ListContainer

קונטיינר לפריטים ברשימה, שכל אחד מהם יכול להכיל כמה רכיבי TextFormatElement.

ייצוג ב-JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
שדות
listNestLevel

string (int64 format)

רמת הדירוג של הרשימה. הערך מתחיל מ-0 ברמה העליונה, וגדל ב-1 בכל רשימה בת.

listType

enum (ListType)

סוג הרשימה.

listItems[]

object (ListItem)

אוסף של פריטים ברשימה.

ListType

Enum for different list types.

טיפוסים בני מנייה (enum)
LIST_TYPE_UNSPECIFIED לא צוין סוג רשימה. לא להשתמש.
ORDERED רשימה ממוינת.
UNORDERED רשימה לא ממוינת.
BLOCKQUOTE מייצג רשימה של ציטוטים.

ListItem

פריט ברשימה.

ייצוג ב-JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
שדות
textFormatElements[]

object (TextFormatElement)

אוסף של רכיבים לעיצוב טקסט.

FlowLevelContext

הקשר ברמת התהליך שמכיל פלט משלבים קודמים.

ייצוג ב-JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
שדות
stepContexts[]

object (StepContext)

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

StepContext

מטא-נתונים של הקשר השלב ופלטים להקשר ברמת התהליך.

ייצוג ב-JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
שדות
stepId

string

אופציונלי. המזהה הייחודי של השלב בתרשים תהליך העבודה.

outputs

map (key: string, value: object (VariableData))

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

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

יצירת טריגר לתהליך עבודה.

ייצוג ב-JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
שדות
triggerId

string

המזהה הייחודי של הטריגר שסופק במהלך היצירה.

triggerType

enum (TriggerType)

סוג הטריגר.

inputs

map (key: string, value: object (VariableData))

מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

נקודת הקצה שאליה תתבצע הקריאה כשהטריגר יופעל.

TriggerType

סוג הטריגר.

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

TriggerDeletion

מחיקת טריגר של תהליך עבודה.

ייצוג ב-JSON
{
  "triggerId": string
}
שדות
triggerId

string

המזהה הייחודי של הטריגר שסופק במהלך היצירה.

ResourceRetrieval

אחזור של משאב.

ייצוג ב-JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
שדות
resourceReference

object (ResourceReference)

הסוג והמזהה של המשאב שרוצים לאחזר.

ElementConfiguration

הפעלה כשמגדירים רכיב של תהליך עבודה.

ייצוג ב-JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
שדות
inputs

map (key: string, value: object (VariableData))

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

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

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

nodeId

string

מזהה הצומת של ההגדרות הפרימיטיביות שמוצגות.

workflowId

string

מזהה תהליך העבודה של ההגדרה הראשונית שעוברת עיבוד.

availableVariables[]

object (VariableReference)

המשתנים הזמינים מסודרים לפי מיקום הצומת.

DisplayDestination

מציין איפה יוצג כרטיס ההגדרות של הרכיב שחוזר.

טיפוסים בני מנייה (enum)
DISPLAY_DESTINATION_UNSPECIFIED ערך ברירת המחדל. לא להשתמש.
DISPLAY_DESTINATION_SIDE_PANEL כרטיס ההגדרות יוצג בחלונית הצדדית.
DISPLAY_DESTINATION_FULL_SCREEN כרטיס ההגדרות האישיות יוצג באפליקציה במסך מלא.

VariableReference

הפניה למשתנה בתהליך העבודה.

ייצוג ב-JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
שדות
parentElementId

string

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

nodeId

string

מזהה ההפניה של הצומת

path

string

חתימת הנתיב של בורר המשתנים

dataType

object (DataType)

סוג הנתונים של המשתנה

iconUrl

string

כתובת ה-URL של הסמל של הפרימיטיב שמפיק את המשתנה הזה.

stepNumber

integer

מספר השלב של הפרימיטיב שמפיק את המשתנה הזה.

descriptionText

string

תיאור המשתנה.

displayText

string

הטקסט שמוצג בצ'יפ המשתנים.

DataType

סוג המשתנה.

ייצוג ב-JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
שדות
valueMetadata

object (ValueMetadata)

מטא-נתונים על הערכים הפוטנציאליים של משתנה.

סוג הנתונים. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
basicType

enum (BasicType)

סוג נתונים בסיסי.

resourceType

object (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 (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
שדות
enumValues[]

string

אופציונלי. מציין את הערכים המותרים למחרוזת. אפשר להגדיר את זה רק אם DataType הוא STRING.

dynamicTypes[]

enum (BasicType)

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

semanticDescriptors[]

object (SemanticDescriptor)

אופציונלי. עוזר לתאר את המשמעות הסמנטית של משתנה.

dynamicSchema

object (DynamicSchema)

אופציונלי. הגדרות לפתרון דינמי של הסכימה של המשתנה הזה.

defaultValue

string

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

SemanticDescriptor

מטא-נתונים על המשמעות הסמנטית של משתנה.

ייצוג ב-JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
שדות
resourceAttribute

string

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

הפורמט המומלץ הוא: - "{brand}/{appName}/{resource}:{attribute}" {brand} הוא אופציונלי וצריך להשמיט אותו אם הוא זהה ל-{appName}.

דוגמאות: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" וכו'.

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

disallowedResourceAttributes[]

string

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

DynamicSchema

הגדרת הסכימה של המשתנה הזה באופן דינמי בזמן הריצה.

ייצוג ב-JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
שדות
requiredInputIds[]

string

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

strictEnum

boolean

כשהערך הוא True, ערך המשתנה חייב להתאים לאחד מערכי ה-enum שנפתרו באופן דינמי. כשהערך הוא False, ערכים שנקבעים באופן דינמי נחשבים להצעות לא מחייבות.

ResourceFieldsDefinitionRetrieval

אחזור של הגדרת השדות שנתמכים על ידי משאב.

ייצוג ב-JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
שדות
elementId

string

מציין את המזהה של הרכיב שאת סכימת המשאבים הדינמיים שלו רוצים לאחזר.

inputs

map (key: string, value: object (VariableData))

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

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

הצעות של ההשלמה האוטומטית לכרטיס שמוצג כרגע.

ייצוג ב-JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
שדות
query

string

השאילתה להשלמה אוטומטית.

inputs

map (key: string, value: object (VariableData))

מפה של משתני הקלט, עם מפתח לפי שם משתנה הקלט.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

הפונקציה שמופעלת ומשויכת לווידג'ט.

resourceId

string

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

operationId

string

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

ExecutionMetadata

מטא-נתונים על הרצת תהליך העבודה.

ייצוג ב-JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
שדות
versionId

integer

גרסת הרכיב של תהליך העבודה שמופעל.

timeZone

string

אזור הזמן של תהליך העבודה שנשמר. לדוגמה, "America/Los_Angeles".

stepNumber

integer

מייצג את מספר השלב של הפעולה הבסיסית שמופעלת.

TriggerEventSource

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

טיפוסים בני מנייה (enum)
TRIGGER_EVENT_SOURCE_UNSPECIFIED ערך ברירת המחדל. לא להשתמש.
TRIGGER_EVENT_SOURCE_AUTOMATED ההפעלה מתבצעת באופן אוטומטי על ידי אירועים.
TRIGGER_EVENT_SOURCE_TEST_RUN ההפעלה מתבצעת באמצעות הרצת בדיקה.