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)

لضبط النص البديل للصورة لإمكانية الوصول. مطلوبة.

المَعلمات

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

استرجاع الكرة

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


setAuthorizationAction(action)

لضبط إجراء تفويض يفتح عنوان URL لمسار التفويض عند النقر على الكائن. يؤدي هذا الإجراء إلى فتح عنوان URL في نافذة جديدة. عندما ينهي المستخدم تدفق التفويض ويعود إلى التطبيق، تتم إعادة تحميل الإضافة.

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

// ...

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

// ...

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

المَعلمات

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

استرجاع الكرة

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

المَعلمات

الاسمالنوعالوصف
urlStringعنوان 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();
}

المَعلمات

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

استرجاع الكرة

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

المَعلمات

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

استرجاع الكرة

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


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

المَعلمات

الاسمالنوعالوصف
openLinkOpenLinkيشير ذلك المصطلح إلى كائن OpenLink يصف عنوان URL بأنّه سيتم فتحه.

استرجاع الكرة

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