This series of articles will work through how to create a connector for Data Studio in Apps Script. For an introduction into the structure I’ll be following see Creating a connector for Data Studio and for a walkthrough of the code see Coding a connector for Data Studio (without using data studio)

The source data will be the github apps script project catalog from Every Google Apps Script project on Github visualized. We’ll be using the Apps Script library that knows how to get the data from Apps Script projects on github. The live scrviz app can be found here. Now it’s finally time to get the connector wired up to Google Data Studio.

Page Content hide

2 The manifest

3.5 Sharing the report

4 Summary

5 Links

Attaching the connector

By this time, we’ll have a working connector and checked what getData() is returning by using the connector as a library as described in Creating a connector for Data Studio so we won’t be wasting a lot of time trying to debug it from within Data Studio.

The manifest

AppsScript.json needs to know things about your connector – here’s mine. Note the dataStudio section.

{
  "runtimeVersion": "V8",
  "dependencies": {
    "libraries": [
      {
        "userSymbol": "bmVizzyCache",
        "libraryId": "1SohIo0pSlXSt2SKNf3iX2ZcbzE_N0F4BocnKpGuaXgyxx1X6s1nDhjZK",
        "version": "6",
        "developmentMode": false
      }
    ]
  },
  "dataStudio": {
    "name": "scrviz",
    "logoUrl": "https://raw.githubusercontent.com/brucemcpherson/gitvizzy/master/public/favicon-32x32.png",
    "company": "Bruce Mcpherson",
    "companyUrl": "https://mcpher.com/",
    "addonUrl": "https://ramblings.mcpher.com/vizzy-scrviz/",
    "supportUrl": "https://github.com/brucemcpherson/desktopliberation/issues",
    "description": "Get Scrviz stats",
    "authType": [
      "NONE"
    ]
  }
}

appsscript.json

Deployment

The new IDE is actually less intuitive and useful than the old one in this respect – in the old IDE you just take the ‘deploy from manifest’ option and it tells you everything you need including a prebuilt Url to go straight to Data Studio.

New deployment

In the new IDE, pick Deploy, New Deployment and you’ll get this

Deploy, and you’ll get this

Connector URL

You’re going to need that deployment ID to construct a URL like this

https://datastudio.google.com/u/0/datasources/create?connectorId=AKfycbw8Ijgu0xKe0xShUzQWXRmwJqFvhLyZ5NK3jXYnMURg46wmel-ZRd862mutgsbzTT8

And you’ll end up here

Notice that the checkboxes from your getConfig() function are rendered.

The fields

Next we get to all the fields that were built in the getSchema() function

Create report

Next we need to add charts to the canvas and assign the dimensions and metrics to them, selected from the fields returned by getSchema().

My simple report is just going to be a table and a collection of scorecards, so after a litle bit of theme tweaking, here it is.

Sharing the report

Open the view mode, and use share to get a link with the appropriate target. I’m making mine completely public

And here’s the link! – https://datastudio.google.com/reporting/a0f4a5d3-92f5-4411-b56b-e295a4796081

Summary

That’s a wrap on my first Data Studio connector.

Here’s what I’ve learned

Caching wherever you can is very important if you have a large data set to handle. See the Digestive namespace in Coding a connector for Data Studio (without using data studio) for how to squeeze more into the Apps Script Cache Service
It’s a lot simpler if you forget all about data studio while developing the connector. Making it a library, and creating a test suite using the library for your getData() and getSchema() is a real timesaver
The new Ide deployment UX is pretty confusing, but stick with it. There’s no point in switching back and forwards (as I initially did)

I haven’t dug into Data Studio reports yet, as that’s a whole other topic for a different series of posts, so that’s all for this series.

Links

Link to this report

https://datastudio.google.com/reporting/a0f4a5d3-92f5-4411-b56b-e295a4796081

Link to the datasource

https://datastudio.google.com/u/0/datasources/create?connectorId=AKfycbw8Ijgu0xKe0xShUzQWXRmwJqFvhLyZ5NK3jXYnMURg46wmel-ZRd862mutgsbzTT8

bmScrvizConnector

github: https://github.com/brucemcpherson/bmScrvizConnector

library key: 1sEEcPeh7GZ6QoGIRFP6rbbFU89SIM9DxPTO_bKbDIYWNFD1cZ5n6T3tK

consumeScrvizconnector

github: https://github.com/brucemcpherson/consumeScrvizconnector

Every Google Apps Script project on Github visualized

Data Studio connector for scrviz – finally connecting it up

This series of articles will work through how to create a connector for Data Studio in Apps Script. For an ...

Coding a connector for Data Studio (without using data studio)

This series of articles will work through how to create a connector for Data Studio in Apps Script. For an ...

Creating a connector for Data Studio

This series of articles will work through how to create a connector for Data Studio in Apps Script. The source ...

12 Years and 1000 pages in Office,Google (Docs,Gsuite) Workspace, and other stuff

1000 pages and counting Most years I do a post on 'a year in Apps Script', looking back over the ...

Apps Script Vizzy – new views, searches and filtering examples

Apps Script Vizzy update Every Google Apps Script project on Github visualized introduces a way of visualizing public Apps Script ...

Gassypedia – public Google Apps Script on Github

A few years ago I released a visualizer of all the scripts that Google Apps Script developers have shared on ...

Finding the scriptId from Apps Script projects on github

In Every Google Apps Script project on Github visualized I demonstrated an app that could be used to explore what every ...

Every Google Apps Script project on Github visualized

Motivation There are so many Apps Script projects out there where the source code is published on Github, but it's ...

Apps for Office – binding example comparison

This page is still being written. In Pseudo binding in HTML service I showed how to simulate Sheets cell binding in an ...

Add-ons versus add-ins

Both Apps and Office offer the capability of adding extra functionality by bringing up some client side JavaScript which can ...

Data Studio connector for scrviz – finally connecting it up

This series of articles will work through how to create a connector for Data Studio in Apps Script. For an ...

4 ways to customize scrviz info card behavior

Info Card customization By default the info card appears when you hover over a node in the scrviz visualization. Although ...

Find an Apps Script library id in 10 seconds with scrviz

You want to include an Apps Script library, and you know it's name, but not its id. A pain right? ...

More scrviz updates to help you enrich your profile and repos

A few scrviz updates today, with more flexibility around the depth of the repo visualization and more options to enrich ...

Enrich your scrviz repo profiles and drive traffic to your website or blog

In Enrich your developer profile on scrviz I showed how scrviz could be used to show off your Apps Script ...

Enrich your developer profile on scrviz

In Showcase your Apps Script work and get hired via vizzy I showed how scrviz could be used to show ...

Direct scrviz link to your Apps Script github repo, project or owner

Motivation You'll know from Every Google Apps Script project on Github visualized that you can get a very large diagram of ...

Find and clone Apps Script projects from github directly into the IDE with scrviz

Motivation Every Google Apps Script project on Github visualized describes how to use https://scrviz.web.app to find and visualize public Apps Script ...

Gassypedia – public Google Apps Script on Github

A few years ago I released a visualizer of all the scripts that Google Apps Script developers have shared on ...

Inline libraries in an Apps Script project

This piece of work to create inline libraries was both challenging and a lot of fun to produce, and it's ...

12 Years and 1000 pages in Office,Google (Docs,Gsuite) Workspace, and other stuff

1000 pages and counting Most years I do a post on 'a year in Apps Script', looking back over the ...

Coding a connector for Data Studio (without using data studio)

This series of articles will work through how to create a connector for Data Studio in Apps Script. For an ...

Creating a connector for Data Studio

This series of articles will work through how to create a connector for Data Studio in Apps Script. The source ...

Finding the scriptId from Apps Script projects on github

In Every Google Apps Script project on Github visualized I demonstrated an app that could be used to explore what every ...

Sheets Workbook functions in Apps Script – Filter functions

This article will cover the translation of the Sheets workbook filter type functions for Apps Script. All of them will ...

Sheets Workbook functions in Apps Script – Database functions

This article will cover the translation of the Sheets workbook database type functions for Apps Script. All of them will ...

Sheets Workbook functions in Apps Script – Array functions

This article will cover the translation of the Sheets workbook Array type functions for Apps Script. Most of them will ...

Getting ‘a pile of files’ from Google Drive with Apps Script

The method for doing this is actually part of the bmFolderFun library documented in A handier way of accessing Google ...

Supercharging copying files between Drive and Cloud Storage from Apps Script with Cloud Run

In Blistering fast file streaming between Drive and Cloud Storage using Cloud Run I showed how you could use Cloud ...

Random and fake test data in Sheets with Google Apps Script

Sometimes you need to generate some fake data for a spreadsheet. In this post I'll cover a few utilities in ...

Apps Script – How to track library and script usage

Motivation You've written a great Apps Script library and you want to know how many people are using it, and ...

Sharing data between Apps Script and Node using Google Drive back end – 5 minute example

Another quick demo of data sharing Here's a challenge that shares the data in a spreadsheet with node, set up ...

The nodejs Drive API, service account impersonation and async iterators

This is part of the series on sharing data between Apps Script and Node on various backends, Apps script library ...

Sharing data between Apps Script and Node using Google Cloud Storage (GCS) back end – 5 minute example

Another quick demo of data sharing There are many ways to accomplish this of course, but using Caching across multiple ...

Sharing data between Apps Script and Node using Github back end – 5 minute example

Quick demo of data sharing There are many ways to accomplish this of course, but using Caching across multiple Apps ...

Sharing data with Upstash between Node and Apps Script – end to example in 5 minutes

Quick demo of data sharing There are many ways to accomplish this of course, but using Caching across multiple Apps ...

Github as an Apps Script cache platform

Github as an Apps Script cache platform Another plugin available for Apps script library with plugins for multiple backend cache ...

Upstash as an Apps Script cache platform

Upstash as an Apps Script cache platform Upstash is a brand new service offering a serverless redis over https via ...

3 Favourite things in one article – redis, apps script and graphQl

Apps Script, Redis and GraphQL - together I'm a great fan of both Redis and GraphQL. You'll find plenty of ...

Microsoft OneDrive plugin as a cache for Google Apps Script

OneDrive as Cache platform In Apps script library with plugins for multiple backend cache platforms I covered a way to ...

Google Cloud Storage platform cache plugin for Apps Script crusher

Google Cloud Storage as Cache platform In Apps script library with plugins for multiple backend cache platforms I covered a ...

Apps script library with plugins for multiple backend cache platforms

Motivation This library used to be part of my cUseful collection, but I've decided to pull out into a library ...

Google gapi, Vue and Vuex together

Motivation JavaScript authentication with Gapi is both impressive and frustrating. Frustrating because in most of the examples you come across, ...

Apps Script Vizzy – new views, searches and filtering examples

Apps Script Vizzy update Every Google Apps Script project on Github visualized introduces a way of visualizing public Apps Script ...

Showcase your Apps Script work and get hired via vizzy

Get yourself found as an Apps Script consultant Every Google Apps Script project on Github visualized introduced this vizzy app ...

Vizzy github data open access – how to build something with Apps Script

In Every Google Apps Script project on Github visualized I introduced Vizzy which uses GitHub data as its source. That ...

Searching and cataloging Apps Script projects on Github

In Every Google Apps Script project on Github visualized I demonstrated an app that could be used to explore what ...

Every Google Apps Script project on Github visualized

Motivation There are so many Apps Script projects out there where the source code is published on Github, but it's ...

Desktop Liberation

The definitive resource for Google Apps Script and Microsoft Office automation

Data Studio connector for scrviz – finally connecting it up

Attaching the connector

The manifest

Deployment

New deployment

Connector URL

The fields

Create report

Sharing the report

Summary

Links