Class CardHeader
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
عنوان البطاقة
عنوان Card
تتوفّر هذه الميزة لإضافات Google Workspace وتطبيقات Google Chat.
const cardHeader = CardService.newCardHeader()
.setTitle('Card header title')
.setSubtitle('Card header subtitle')
.setImageStyle(CardService.ImageStyle.CIRCLE)
.setImageUrl('https://image.png');
مستندات تفصيلية
setImageAltText(imageAltText)
تُستخدَم لضبط النص البديل لصورة الرأس.
المعلمات
| الاسم | النوع | الوصف |
imageAltText | String | النص البديل لصورة العنوان |
الإرجاع
CardHeader: هذا العنصر، لإنشاء سلسلة.
setImageStyle(imageStyle)
لضبط اقتصاص الرمز في عنوان البطاقة. الإعداد التلقائي هو عدم الاقتصاص. اختيارية:
المعلمات
الإرجاع
CardHeader: هذا العنصر، لإنشاء سلسلة.
setImageUrl(imageUrl)
لضبط الصورة المراد استخدامها في العنوان من خلال تقديم عنوان URL أو سلسلة البيانات
يمكن أن يكون عنوان URL المقدَّم عنوان URL متاحًا للجميع أو سلسلة صورة مُشفَّرة بترميز base64.
للحصول على الرمز الأخير، يمكنك استخدام الرمز التالي لإنشاء سلسلة صور مُشفَّرة من
صورة في Google Drive، ثم تخزين هذه السلسلة لاستخدامها لاحقًا مع setImageUrl(imageUrl). تمنع هذه الطريقة إضافة Chrome من الوصول إلى عنوان 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
// CardHeader.setImageUrl(imageUrl).
المعلمات
| الاسم | النوع | الوصف |
imageUrl | String | عنوان URL لصورة مستضافة لاستخدامها أو سلسلة صورة مُرمّزة |
الإرجاع
CardHeader: هذا العنصر، لإنشاء سلسلة.
setSubtitle(subtitle)
لضبط العنوان الفرعي لعنوان البطاقة اختيارية:
المعلمات
| الاسم | النوع | الوصف |
subtitle | String | نص العنوان الفرعي |
الإرجاع
CardHeader: هذا العنصر، لإنشاء سلسلة.
setTitle(title)
لضبط عنوان عنوان البطاقة. مطلوب.
المعلمات
| الاسم | النوع | الوصف |
title | String | نص العنوان |
الإرجاع
CardHeader: هذا العنصر، لإنشاء سلسلة.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003e\u003ccode\u003eCardHeader\u003c/code\u003e objects allow you to customize the header of a card, including title, subtitle, and image, within Google Workspace Add-ons and Google Chat apps.\u003c/p\u003e\n"],["\u003cp\u003eYou can set an image for the header using \u003ccode\u003esetImageUrl()\u003c/code\u003e by providing a public URL or a base64 encoded image string.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esetTitle()\u003c/code\u003e and \u003ccode\u003esetSubtitle()\u003c/code\u003e allow you to define the main text and supporting text for the header, respectively.\u003c/p\u003e\n"],["\u003cp\u003eCustomize the image display with \u003ccode\u003esetImageStyle()\u003c/code\u003e to control cropping and use \u003ccode\u003esetImageAltText()\u003c/code\u003e to provide alternative text for accessibility.\u003c/p\u003e\n"]]],["The `CardHeader` object allows customization of a card's header in Google Workspace add-ons and Google Chat apps. Key actions include setting the header's title using `setTitle()`, a subtitle with `setSubtitle()`, and an image via `setImageUrl()`. The image's appearance can be modified with `setImageStyle()` for cropping and `setImageAltText()` for alternative text. Image URLs can be direct links or base64 encoded strings. Each method returns the `CardHeader` object, enabling method chaining.\n"],null,["# Class CardHeader\n\nCardHeader\n\nThe header of a [Card](/apps-script/reference/card-service/card).\n\nAvailable for Google Workspace add-ons and Google Chat apps.\n\n```javascript\nconst cardHeader = CardService.newCardHeader()\n .setTitle('Card header title')\n .setSubtitle('Card header subtitle')\n .setImageStyle(CardService.ImageStyle.CIRCLE)\n .setImageUrl('https://image.png');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------|-----------------|--------------------------------------------------------------------------|\n| [setImageAltText(imageAltText)](#setImageAltText(String)) | [CardHeader](#) | Sets the alternative text for the header image. |\n| [setImageStyle(imageStyle)](#setImageStyle(ImageStyle)) | [CardHeader](#) | Sets the cropping of the icon in the card header. |\n| [setImageUrl(imageUrl)](#setImageUrl(String)) | [CardHeader](#) | Sets the image to use in the header by providing its URL or data string. |\n| [setSubtitle(subtitle)](#setSubtitle(String)) | [CardHeader](#) | Sets the subtitle of the card header. |\n| [setTitle(title)](#setTitle(String)) | [CardHeader](#) | Sets the title of the card header. |\n\nDetailed documentation\n----------------------\n\n### `set``Image``Alt``Text(imageAltText)`\n\nSets the alternative text for the header image.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|----------|--------------------------------------------|\n| `image``Alt``Text` | `String` | The alternative text for the header image. |\n\n#### Return\n\n\n[CardHeader](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Image``Style(imageStyle)`\n\nSets the cropping of the icon in the card header. Defaults to no crop. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|---------------------------------------------------------------|--------------------|\n| `image``Style` | [ImageStyle](/apps-script/reference/card-service/image-style) | The style setting. |\n\n#### Return\n\n\n[CardHeader](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Image``Url(imageUrl)`\n\nSets the image to use in the header by providing its URL or data string.\n\nThe provided URL can either be a publicly accessible URL or a base64 encoded image string.\nTo obtain the latter, you can use the following code to create an encoded image string from an\nimage in your Google Drive, then store that string for later use with [setImageUrl(imageUrl)](#setImageUrl(String)). This method prevents the need for your add-on to access a publicly\navailable image URL:\n\n```javascript\n// The following assumes you have the image to use in Google Drive and have its\n// ID.\nconst imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();\nconst encodedImageURL =\n `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;\n\n// You can store encodeImageURL and use it as a parameter to\n// CardHeader.setImageUrl(imageUrl).\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|-----------------------------------------------------------------------|\n| `image``Url` | `String` | The URL address of a hosted image to use, or an encoded image string. |\n\n#### Return\n\n\n[CardHeader](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Subtitle(subtitle)`\n\nSets the subtitle of the card header. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|----------|---------------------------|\n| `subtitle` | `String` | The header subtitle text. |\n\n#### Return\n\n\n[CardHeader](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Title(title)`\n\nSets the title of the card header. Required.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------|\n| `title` | `String` | The header text. |\n\n#### Return\n\n\n[CardHeader](#) --- This object, for chaining."]]
