Home Programming News Create sensible chips for hyperlink previewing in Google Docs

Create sensible chips for hyperlink previewing in Google Docs

Create sensible chips for hyperlink previewing in Google Docs


Posted by Chanel Greco, Developer Advocate

Earlier this yr, we introduced the final availability of third-party sensible chips in Google Docs. This new function enables you to add, view, and have interaction with important info from third celebration apps instantly in Google Docs. A number of companions, together with Asana, Atlassian, Figma, Loom, Miro, Tableau, and Whimsical, have already created sensible chips so customers can begin embedding content material from their apps instantly into Docs. Sourabh Choraria, a Google Developer Skilled for Google Workspace and interest developer, printed a third-party sensible chip resolution known as “Hyperlink Previews” to the Google Workspace Market. This app provides info to Google Docs from a number of generally used SaaS instruments.

On this weblog publish you’ll discover out how you can also create your personal sensible chips for Google Docs.

Example of a smart chip that was created to preview information from an event management system

Instance of a wise chip that was created to preview info from an occasion administration system

Understanding how sensible chips for third-party providers work

Third-party sensible chips are powered by Google Workspace Add-ons and might be printed to the Google Workspace Market. From there, an admin or consumer can set up the add-on and it’ll seem within the sidebar on the precise hand aspect of Google Docs.

The Google Workspace Add-on detects a service’s hyperlinks and prompts Google Docs customers to preview them. This implies you could create sensible chips for any service that has a publicly accessible URL. You possibly can configure an add-on to preview a number of URL patterns, resembling hyperlinks to help instances, gross sales leads, worker profiles, and extra. This configuration is completed within the add-on’s manifest file.

  "timeZone": "America/Los_Angeles",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
  "addOns": {
    "widespread": {
      "title": "Preview Books Add-on",
      "logoUrl": "https://builders.google.com/workspace/add-ons/photographs/library-icon.png",
      "layoutProperties": {
        "primaryColor": "#dd4b39"
    "docs": {
      "linkPreviewTriggers": [
          "runFunction": "bookLinkPreview",
          "patterns": [
              "hostPattern": "*.google.*",
              "pathPrefix": "books"
              "hostPattern": "*.google.*",
              "pathPrefix": "books/edition"
          "labelText": "Ebook",
          "logoUrl": "https://builders.google.com/workspace/add-ons/photographs/book-icon.png",
          "localizedLabelText": {
            "es": "Libros"

The manifest file incorporates the URL sample for the Google Books API

The sensible chip shows an icon and brief title or description of the hyperlink’s content material. When the consumer hovers over the chip, they see a card interface that previews extra details about the file or hyperlink. You possibly can customise the cardboard interface that seems when the consumer hovers over a wise chip. To create the cardboard interface, you employ widgets to show details about the hyperlink. You may as well construct actions that allow customers open the hyperlink or modify its contents. For a checklist of all of the supported elements for preview playing cards verify the developer documentation.

operate getBook(id) {
// Code to fetch the info from the Google Books API

operate bookLinkPreview(occasion) {
 if (occasion.docs.matchedUrl.url) {
// By means of getBook(id) the related knowledge is fetched and used to construct the sensible chip and card

    const previewHeader = CardService.newCardHeader()
      .setSubtitle('By ' + bookAuthors)

    const previewPages = CardService.newDecoratedText()
      .setTopLabel('Web page rely')

    const previewDescription = CardService.newDecoratedText()
      .setTopLabel('About this e book')

    const previewImage = CardService.newImage()
      .setAltText('Picture of e book cowl')

    const buttonBook = CardService.newTextButton()
      .setText('View e book')

    const cardSectionBook = CardService.newCardSection()

    return CardService.newCardBuilder()

That is the Apps Script code to create a wise chip.

A smart chip hovered state.

A sensible chip hovered state. The information displayed is fetched from the Google for Builders weblog publish URL that was pasted by the consumer.

For an in depth walkthrough of the code used on this publish, please checkout the Preview hyperlinks from Google Books with sensible chips pattern tutorial.

How to decide on the expertise to your add-on

When creating sensible chips for hyperlink previewing, you’ll be able to select from two totally different applied sciences to create your add-on: Google Apps Script or alternate runtime.

Apps script is a speedy software improvement platform that’s constructed into Google Workspace. This truth makes Apps Script a good selection for prototyping and validating your sensible chip resolution because it requires no pre-existing improvement setting. However Apps Script isn’t just for prototyping as some builders select to create their Google Workspace Add-on with it and even publish it to the Google Workspace Market for customers to put in.

If you wish to create your sensible chip with Apps Script you’ll be able to try the video beneath by which you discover ways to construct a wise chip for hyperlink previewing in Google Docs from A – Z. Need the code used within the video tutorial? Then take a look on the Preview hyperlinks from Google Books with sensible chips pattern web page.

In the event you want to create your Google Workspace Add-on utilizing your personal improvement setting, programming language, internet hosting, packages, and so forth., then alternate runtime is the precise selection. You possibly can select from totally different programming languages like Node.js, Java, Python, and extra. The internet hosting of the add-on runtime code might be on any cloud or on premise infrastructure so long as runtime code might be uncovered as a public HTTP(S) endpoint. You possibly can study extra about find out how to create sensible chips utilizing alternate runtimes from the developer documentation.

Tips on how to share your add-on with others

You possibly can share your add-on with others via the Google Workspace Market. Let’s say you wish to make your sensible chip resolution accessible to your crew. In that case you’ll be able to publish the add-on to your Google Workspace group, often known as a personal app. Then again, if you wish to share your add-on with anybody who has a Google Account, you’ll be able to publish it as a public app.

To seek out out extra about publishing to the Google Workspace Market, you’ll be able to watch this video that may stroll you thru the method.

Getting began

Study extra about creating sensible chips for hyperlink previewing within the developer documentation. There you’ll discover additional info and code samples you’ll be able to base your resolution of. We are able to’t wait to see what sensible chip options you’ll construct.



Please enter your comment!
Please enter your name here