Class Image

صورة

أداة تعرض صورة واحدة. للحصول على معلومات حول اقتصاص الصور، يُرجى الاطّلاع على ImageCropStyle.

متاحة لإضافات Google Workspace وتطبيقات Google Chat 

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

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
addEventAction(eventAction)Widgetتضيف هذه السمة إجراء الحدث الذي يمكن تنفيذه على التطبيق المصغّر.
setAltText(altText)Imageتضبط هذه السمة النص البديل للصورة لتسهيل استخدامها.
setAuthorizationAction(action)Imageيضبط هذا الإعداد إجراء تفويض يفتح عنوان URL لمسار التفويض عند النقر على العنصر.
setComposeAction(action, composedEmailType)Imageتضبط هذه السمة إجراءً ينشئ مسودة رسالة إلكترونية عند النقر على العنصر.
setId(id)Widgetتضبط هذه السمة المعرّف الفريد الذي تمّ تعيينه والمستخدَم لتحديد الأداة التي سيتمّ تعديلها.
setImageUrl(url)Imageتضبط هذه السمة الصورة المطلوب استخدامها من خلال توفير عنوان URL أو سلسلة بيانات.
setOnClickAction(action)Imageتضبط هذه السمة إجراءً يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)Imageتضبط هذه السمة إجراءً يفتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)Imageتضبط هذه السمة عنوان URL ليتم فتحه عند النقر على العنصر.
setVisibility(visibility)Widgetتضبط هذه السمة مستوى ظهور الأداة.

مستندات تفصيلية

addEventAction(eventAction)

تضيف هذه السمة إجراء الحدث الذي يمكن تنفيذه على التطبيق المصغّر.

المعلمات

الاسمالنوعالوصف
eventActionEventActionتمثّل هذه السمة EventAction المطلوب إضافتها.

الإرجاع

Widget — العنصر، للتسلسل.

setAltText(altText)

تضبط هذه السمة النص البديل للصورة لتسهيل استخدامها. الحقل مطلوب.

المعلمات

الاسمالنوعالوصف
altTextStringالنص البديل الذي سيتم تعيينه لهذه الصورة

الإرجاع

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);

المعلمات

الاسمالنوعالوصف
actionAuthorizationActionالعنصر الذي يحدّد إجراء التفويض الذي سيتم اتخاذه عند النقر على هذا العنصر.

الإرجاع

Image: هذا الكائن، للتسلسل

setComposeAction(action, composedEmailType)

تضبط هذه السمة إجراءً ينشئ مسودة رسالة إلكترونية عند النقر على العنصر. يمكن ضبط قيمة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType) لكائن واجهة المستخدم.

يجب أن تحدّد المَعلمة Action دالة ردّ اتصال تعرض عنصر ComposeActionResponse تمّ إعداده باستخدام ComposeActionResponseBuilder.setGmailDraft(draft). 

// ...

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

// ...

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

المعلمات

الاسمالنوعالوصف
actionActionالعنصر الذي يحدّد إجراء الإنشاء الذي سيتم اتخاذه عند النقر على هذا العنصر.
composedEmailTypeComposedEmailTypeقيمة تعداد تحدّد ما إذا كانت المسودة التي تم إنشاؤها مستقلة أو مسودة رد.

الإرجاع

Image: هذا الكائن، للتسلسل

setId(id)

تضبط هذه السمة المعرّف الفريد الذي تمّ تعيينه والمستخدَم لتحديد الأداة التي سيتمّ تعديلها. لا يمكن تعديل التطبيقات المصغّرة إلا في الإضافات.

المعلمات

الاسمالنوعالوصف
idStringمعرّف الأداة، ويجب ألا يتجاوز 64 حرفًا وأن يكون بالتنسيق `[a-zA-Z0-9-]+`.

الإرجاع

Widget: هذا الكائن، للتسلسل

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('123abc').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).

المعلمات

الاسمالنوعالوصف
urlStringتمثّل هذه السمة عنوان 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();
}

المعلمات

الاسمالنوعالوصف
actionActionالإجراء المطلوب اتّخاذه عند النقر على هذا العنصر.

الإرجاع

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();
}

المعلمات

الاسمالنوعالوصف
actionActionالعنصر الذي يحدّد إجراء فتح الرابط الذي سيتم اتخاذه عند النقر على هذا العنصر.

الإرجاع

Image: هذا الكائن، للتسلسل

تضبط هذه السمة عنوان URL ليتم فتحه عند النقر على العنصر. استخدِم هذه الدالة عندما يكون عنوان URL معروفًا ويجب فتحه فقط. يمكن أن يتضمّن عنصر واجهة المستخدم قيمة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

المعلمات

الاسمالنوعالوصف
openLinkOpenLinkتمثّل هذه السمة عنصر OpenLink يصف عنوان URL المطلوب فتحه.

الإرجاع

Image: هذا الكائن، للتسلسل

setVisibility(visibility)

تضبط هذه السمة مستوى ظهور الأداة. القيمة التلقائية هي VISIBLE.

المعلمات

الاسمالنوعالوصف
visibilityVisibilityVisibility الأداة

الإرجاع

Widget — العنصر، للتسلسل.