You should first review the Publishing overview to understand the different publishing options as well as their differences in benefits and required level of commitment. This will help you to choose the right publishing option for your connector.
If you want to publish your connector as an Open Source Community Connector, you must meet the following requirements before requesting a pull request.
- Add a
readme.mdfile to your code. You do not need to include a deployment link. See readme of npm Downloads as an example.
- Add JSDoc comments.
- Manifest should contain values for
- You should populate the
sourcesproperty with all the sources your connector connects to. See Sources in Manifest reference for details.
- You should limit the number of endpoints called by
UrlFetchAppin your connector to those absolutely required for connector functionality. Add the
urlFetchWhitelistproperty 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
- If your connector does not execute a
UrlFetchAppcall then set the property value to an empty list
- This property should contain all URLs your connector connects to using the
- If you connector has a fixed schema, create a report template for your connector and add it to the manifest.
- 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.
- 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: