Package google.apps.studio.v1

אינדקס

WorkspaceStudioService

שירות Workspace Studio.

FireTrigger

rpc FireTrigger(FireTriggerRequest) returns (FireTriggerResponse)

הודעה ל-Google על התרחשות של אירוע הפעלה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/workspace.studio.trigger

מידע נוסף זמין במדריך ההרשאות.

FireTriggerRequest

הודעת הבקשה לשיטת FireTrigger.

שדות
name

string

חובה. שם המשאב של הטריגר. פורמט: triggers/{trigger_id}

outputs

map<string, VariableData>

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

log

TextFormat

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

request_id

string

אופציונלי. מזהה ייחודי של הבקשה. מוגבל ל-36 תווים מסוג ASCII. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. הבקשה הזו היא אידמפוטנטית רק אם מצורף request_id.

FireTriggerResponse

בסוג הזה אין שדות.

הודעת התגובה לשיטת FireTrigger.

ResourceData

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

שדות
fields

map<string, VariableData>

מיפוי של שדות המשאבים, עם שם השדה כמפתח.

TextFormat

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

שדות
text_format_elements[]

TextFormatElement

אופציונלי. אוסף של אלמנטים בפורמט טקסט.

Chip

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

שדות
icon

Icon

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

label

string

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

url

string

אופציונלי. כתובת ה-URL שאליה מובילה הלחיצה על הצ'יפ.

סמל

סמל בצ'יפ.

שדות
שדה איחוד icons. הסמל שמוצג בצ'יפ. הערך icons יכול להיות רק אחד מהבאים:
icon_url

string

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

לדוגמה:

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

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

material_icon

string

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

TextFormatElement

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

שדות
שדה איחוד element. רכיב שמייצג אחד מכמה רכיבים אפשריים של פורמט טקסט. הערך element יכול להיות רק אחד מהבאים:
text

string

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

chip

Chip

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

styled_text

StyledText

טקסט עם סגנון בפורמט טקסט.

list_container

ListContainer

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

ListContainer

קונטיינר של פריטים ברשימה, שכל פריט ברשימה יכול להכיל כמה רכיבים מסוג TextFormatElement.

שדות
list_nest_level

int64

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

list_type

ListType

אופציונלי. סוג הרשימה.

list_items[]

ListItem

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

ListItem

פריט ברשימה.

שדות
text_format_elements[]

TextFormatElement

אופציונלי. אוסף של אלמנטים בפורמט טקסט.

ListType

סוג Enum לסוגים שונים של רשימות.

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

StyledText

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

שדות
text

string

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

styles[]

Style

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

font_weight

FontWeight

אופציונלי. משקל הגופן של הטקסט.

color

Color

אופציונלי. הצבע של הטקסט.

wrap_style

WrapStyle

אופציונלי. סגנון הגלישה של הטקסט.

FontWeight

סוג Enum למשקלים שונים של גופנים.

טיפוסים בני מנייה (enum)
FONT_WEIGHT_UNSPECIFIED משקל רגיל עם עובי רגיל.
LIGHT משקל קל יותר ועובי מופחת.
MEDIUM משקל ביניים בין light ל-bold.
BOLD משקל כבד יותר עם עובי מוגדל.

סגנון

סוג Enum לסגנונות טקסט שונים, כמו נטוי, קו תחתון וכו'.

טיפוסים בני מנייה (enum)
STYLE_UNSPECIFIED לא הוחל סגנון.
ITALIC סגנון נטוי.
UNDERLINE סגנון קו תחתון.
STRIKETHROUGH סגנון קו חוצה.
LINE_BREAK מעבר שורה.
UPPERCASE סגנון אותיות רישיות.
CODE לתכנת.
CODE_BLOCK בלוק קוד.

WrapStyle

סוג Enum לסגנונות שונים של גלישת טקסט.

טיפוסים בני מנייה (enum)
WRAP_STYLE_UNSPECIFIED לא צוין סגנון גלישה.
NO_WRAP ללא סגנון גלישה.

VariableData

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

שדות
boolean_values[]

bool

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

integer_values[]

int64

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

string_values[]

string

ערכי מחרוזת.

timestamp_values[]

Timestamp

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

resource_references[]

string

רשימה של מזהי משאבים (למשל, spaces/123).

resource_data_values[]

ResourceData

רשימה של נתוני משאבים.

email_address_values[]

string

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

users[]

string

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