דף זה תורגם על ידי Cloud Translation API.

Class Image

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

אפשר להשתמש בתוספים ל-Google Workspace ובאפליקציות של Google Chat.

var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`setAltText(altText)`	`Image`	מגדיר את הטקסט החלופי של התמונה לנגישות.
`setAuthorizationAction(action)`	`Image`	מגדירה פעולת הרשאה שפותחת כתובת URL לזרימת ההרשאה כשלוחצים על האובייקט.
`setComposeAction(action, composedEmailType)`	`Image`	מגדירה פעולה שכותבת טיוטת אימייל כשלוחצים על האובייקט.
`setImageUrl(url)`	`Image`	מגדיר את התמונה לשימוש על ידי ציון כתובת ה-URL או מחרוזת הנתונים שלה.
`setOnClickAction(action)`	`Image`	מגדירה פעולה שמופעלת כשלוחצים על האובייקט.
`setOnClickOpenLinkAction(action)`	`Image`	מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
`setOpenLink(openLink)`	`Image`	מגדיר כתובת URL שתיפתח בעקבות לחיצה על האובייקט.

תיעוד מפורט

`setAltText(altText)`

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

פרמטרים

שם	סוג	תיאור
`altText`	`String`	הטקסט החלופי שצריך להקצות לתמונה הזו.

החזרות

Image – האובייקט הזה, לשרשור.

`setAuthorizationAction(action)`

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

באובייקט של ממשק משתמש אפשר להגדיר רק אחד מהערכים setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

פרמטרים

שם	סוג	תיאור
`action`	`AuthorizationAction`	האובייקט שמציין את פעולת ההרשאה שיש לבצע כשלוחצים על הרכיב הזה.

החזרות

Image – האובייקט הזה, לשרשור.

`setComposeAction(action, composedEmailType)`

מגדירה פעולה שכותבת טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק משתמש רק אחד מהערכים setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse שהוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft).

הערה: השיטה הזו לא מגדירה פעולת כתיבה שמשמשת להרחבה של ממשק המשתמש של הכתיבה. במקום זאת, השיטה הזו מקשרת את הרכיב בממשק המשתמש אל Action שכותב טיוטות של הודעות ב-Apps Script, שנפתח ב-Gmail כשהפעולה מסתיימת.

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

פרמטרים

שם	סוג	תיאור
`action`	`Action`	האובייקט שמציין את פעולת הכתיבה שצריך לבצע כשלוחצים על הרכיב הזה.
`composedEmailType`	`ComposedEmailType`	ערך 'טיפוסים בני מנייה (enum)' שמציין אם הטיוטה המורכבת היא טיוטה עצמאית או טיוטה של תשובה.

החזרות

Image – האובייקט הזה, לשרשור.

`setImageUrl(url)`

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

כתובת ה-URL שצוינה יכולה להיות כתובת URL נגישה לכולם או מחרוזת תמונה בקידוד base64. כדי להשיג את השני, אפשר להשתמש בקוד הבא כדי ליצור מחרוזת תמונה מקודדת מתמונה ב-Google Drive, ואז לאחסן את המחרוזת לשימוש במועד מאוחר יותר עם setImageUrl(url). השיטה הזו מונעת מהתוסף גישה לכתובת URL של תמונה שזמינה לכולם:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

// You can store encodeImageURL and use it as a parameter to Image.setImageUrl(url).

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL של תמונה מתארחת לשימוש או של מחרוזת תמונה מקודדת.

החזרות

Image – האובייקט הזה, לשרשור.

`setOnClickAction(action)`

מגדירה פעולה שמופעלת כשלוחצים על האובייקט. אובייקט של ממשק משתמש יכול להגדיר רק אחד מהערכים setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse.

// ...

var action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton().setText('Create notification').setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(CardService.newNotification()
          .setText("Some info to display to user"))
      .build();
}

פרמטרים

שם	סוג	תיאור
`action`	`Action`	הפעולה שצריך לבצע כשמשתמש לוחץ על הרכיב הזה.

החזרות

Image – האובייקט הזה, לשרשור.

`setOnClickOpenLinkAction(action)`

מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. תוכלו להשתמש בפונקציה הזו כשצריך ליצור את כתובת ה-URL או לבצע פעולות אחרות בתוסף ליצירת האובייקט OpenLink. באובייקט של ממשק משתמש אפשר להגדיר רק אחד מהערכים setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse שהוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink).

// ...

var action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl('https://www.google.com'))
      .build();
}

פרמטרים

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

החזרות

Image – האובייקט הזה, לשרשור.

`setOpenLink(openLink)`

מגדיר כתובת URL שתיפתח בעקבות לחיצה על האובייקט. השתמשו בפונקציה הזו כאשר כתובת ה-URL כבר ידועה וצריך לפתוח אותה רק. אובייקט של ממשק משתמש יכול להגדיר רק אחד מהערכים setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

פרמטרים

שם	סוג	תיאור
`openLink`	`OpenLink`	אובייקט `OpenLink` שמתאר את כתובת ה-URL לפתיחה.

החזרות

Image – האובייקט הזה, לשרשור.