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

Class Image

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

התכונה זמינה בתוספים של Google Workspace ובאפליקציות של Google Chat.

const 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 לתהליך ההרשאה כשמקישים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.

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

// ...

const 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 כשהפעולה מסתיימת.

// ...

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

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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.
const imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
const 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.

// ...

const 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).

// ...

const 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 – האובייקט הזה, לשרשור.