Open Source Community Connectors

You can explore all open source Community Connectors as well as contribute your own by visiting the Data Studio repository on GitHub.

Open Source Community Connectors serve as examples for different use cases and also highlight best practices. You can view the code for these connectors to better understand Community Connectors. You can also deploy these connectors yourself and use them in Data Studio.

Contributing to Open Source Community Connectors

If you want to contribute your connector as an Open Source Community Connector, you must meet the following requirements before requesting a pull request.

  1. Add a readme.md file to your code. See readme of npm Downloads as an example. This document should explain how a user can deploy the connector and use it.
  2. Add JSDoc comments.
  3. Manifest should contain values for the follwoing:
    • shortDescription
    • authType
    • supportUrl
    • feeType
  4. Populate the sources property with all the sources your connector connects to. See Sources in Manifest reference for details.
  5. Limit the number of endpoints called by UrlFetchApp in your connector to those absolutely required for connector functionality. Add the urlFetchWhitelist property to the root level of your manifest. View the urlFetchWhitelist reference for more info.
    • This property should contain all URLs your connector connects to using the UrlFetchApp call.
    • If your connector does not execute a UrlFetchApp call then set the property value to an empty list [].
  6. If you connector has a fixed schema, create a report template for your connector and add it to the manifest.
  7. Provide meaningful and actionable error messages to users when users encounter a Connector internal error. This includes cases when user provides invalid/blank input at configuration.
  8. Ensure you and your connector adhere to the Data Studio Galleries Terms of Service (Submitter).

Once you have met all the requirements, click the following button to request a review for your connector:

Publish your Open Source Community Connector