Class LinkPreview
Stay organized with collections
Save and categorize content based on your preferences.
LinkPreview
Card action that displays a link preview card and smart chip in the host app. For more
information, refer to Preview links
with smart chips.
const decoratedText =
CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!');
const cardSection = CardService.newCardSection().addWidget(decoratedText);
const card = CardService.newCardBuilder().addSection(cardSection).build();
const linkPreview = CardService.newLinkPreview().setPreviewCard(card).setTitle(
'Smart chip title');
Detailed documentation
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setLinkPreviewTitle(title)
Sets the title that displays in the link preview above the preview card. If unset, the link
preview displays the header of the PreviewCard.
const linkPreview =
CardService.newLinkPreview().setLinkPreviewTitle('Link preview title');
Parameters
| Name | Type | Description |
title | String | The title of the link preview. |
Return
LinkPreview — This object, for chaining.
setPreviewCard(previewCard)
Sets the card that displays information about a link from a third-party or non-Google service.
const decoratedText =
CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!');
const cardSection = CardService.newCardSection().addWidget(decoratedText);
const card = CardService.newCardBuilder().addSection(cardSection).build();
const linkPreview = CardService.newLinkPreview().setPreviewCard(card).setTitle(
'Smart chip title');
Parameters
| Name | Type | Description |
previewCard | Card | The preview card. |
Return
LinkPreview — This object, for chaining.
setTitle(title)
Sets the title that displays in the smart chip for the link preview. If unset, the smart chip
displays the header of the PreviewCard.
const linkPreview = CardService.newLinkPreview().setTitle('Smart chip title');
Parameters
| Name | Type | Description |
title | String | The title of the smart chip. |
Return
LinkPreview — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eLinkPreview\u003c/code\u003e is a card action that displays a preview card and smart chip within a host application.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can customize the title shown in the link preview and smart chip using \u003ccode\u003esetLinkPreviewTitle()\u003c/code\u003e and \u003ccode\u003esetTitle()\u003c/code\u003e, respectively.\u003c/p\u003e\n"],["\u003cp\u003eA preview card, created using \u003ccode\u003eCardService\u003c/code\u003e, provides detailed information about the linked content within the \u003ccode\u003eLinkPreview\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esetPreviewCard()\u003c/code\u003e is used to attach this custom preview card to the \u003ccode\u003eLinkPreview\u003c/code\u003e action.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprintJson()\u003c/code\u003e method is available for debugging purposes to inspect the JSON representation of the \u003ccode\u003eLinkPreview\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,["# Class LinkPreview\n\nLinkPreview\n\nCard action that displays a link preview card and smart chip in the host app. For more\ninformation, refer to [Preview links\nwith smart chips](https://developers.google.com/apps-script/add-ons/editors/gsao/preview-links).\n\n```javascript\nconst decoratedText =\n CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!');\n\nconst cardSection = CardService.newCardSection().addWidget(decoratedText);\n\nconst card = CardService.newCardBuilder().addSection(cardSection).build();\n\nconst linkPreview = CardService.newLinkPreview().setPreviewCard(card).setTitle(\n 'Smart chip title');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------|------------------|------------------------------------------------------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setLinkPreviewTitle(title)](#setLinkPreviewTitle(String)) | [LinkPreview](#) | Sets the title that displays in the link preview above the preview card. |\n| [setPreviewCard(previewCard)](#setPreviewCard(Card)) | [LinkPreview](#) | Sets the card that displays information about a link from a third-party or non-Google service. |\n| [setTitle(title)](#setTitle(String)) | [LinkPreview](#) | Sets the title that displays in the smart chip for the link preview. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Link``Preview``Title(title)`\n\nSets the title that displays in the link preview above the preview card. If unset, the link\npreview displays the header of the `Preview``Card`.\n\n```javascript\nconst linkPreview =\n CardService.newLinkPreview().setLinkPreviewTitle('Link preview title');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|--------------------------------|\n| `title` | `String` | The title of the link preview. |\n\n#### Return\n\n\n[LinkPreview](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Preview``Card(previewCard)`\n\nSets the card that displays information about a link from a third-party or non-Google service.\n\n```javascript\nconst decoratedText =\n CardService.newDecoratedText().setTopLabel('Hello').setText('Hi!');\n\nconst cardSection = CardService.newCardSection().addWidget(decoratedText);\n\nconst card = CardService.newCardBuilder().addSection(cardSection).build();\n\nconst linkPreview = CardService.newLinkPreview().setPreviewCard(card).setTitle(\n 'Smart chip title');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|--------------------------------------------------|-------------------|\n| `preview``Card` | [Card](/apps-script/reference/card-service/card) | The preview card. |\n\n#### Return\n\n\n[LinkPreview](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Title(title)`\n\nSets the title that displays in the smart chip for the link preview. If unset, the smart chip\ndisplays the header of the `Preview``Card`.\n\n```javascript\nconst linkPreview = CardService.newLinkPreview().setTitle('Smart chip title');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------------------|\n| `title` | `String` | The title of the smart chip. |\n\n#### Return\n\n\n[LinkPreview](#) --- This object, for chaining."]]
