You should first review the Publishing overview to understand the benefits and required level of commitment for publishing a connector. If you want to publish your connector as a Partner Connector, you must meet the following requirements before requesting a review.
- Share view access of your Apps Script project with both of these addresses:
- Create a deployment named
Productionand update the
Productiondeployment to contain the version of code you want to publish.
- If you have updated your code since creating the
Productiondeployment, ensure that the correct version of the code is selected for the deployment before you submit your connector.
You must include the following in your connector's manifest. View the manifest reference for more information about each property in the manifest.
description, make sure you provide all information and instructions necessary to have a basic understanding of the connector and how to use it. Connectors with vague and incomplete descriptions will be rejected during review.
addOnUrlshould be a dedicated hosted page about your connector, preferably hosted on your own domain.
- This page should contain any details the user will need to know to use your connector.
- If users need to sign up for an account to use your connector, the sign up link should be available from this page.
- The page cannot be hosted at
- See example pages from existing partners: Funnel, Supermetrics, CallRail.
supportUrlshould be a hosted page where users can go to get support for your connector. This cannot be an email or mailto link.
- You should populate the
sourcesproperty with all the sources your connector connects to. See Sources in Manifest reference for details.
- You can view the existing list of sources at our Data Registry Repository. If the source you are connecting to does not exist in the repository, send a pull request to the Data Registry Repository to add the source. Your connector will fail the review process if the sources in your manifest do not exist in the repository.
- This is additional metadata for the connector that will be indexed for search feature in the gallery. You connector will show up in the search results when users search for a specific data source in the gallery.
- The gallery will let users discover connectors by data sources by providing a Connectors by Data Source interface.
- Manifest should contain values for
nameshould be directly representative of what the connector specifically does. This makes it clear what the connector does and helps the user to identify the correct connector for their need. Avoid using the word 'connector' in the name.
- Do not use shorthand names for Data Studio anywhere in the manifest (e.g. GDS, DS, etc.).
- Emojis are not allowed in any manifest field (
- If you connector has a fixed schema, create a report template for your
connector and add it to the manifest. Enable Sharing by link for the report.
- Limit the number of endpoints called by
UrlFetchAppto 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
- If your connector does not connect to a fixed domain or the endpoint
prefix varies, omit the
urlFetchWhitelistproperty in the manifest.
- This property should contain all URLs your connector connects to using the
- Set explicit OAuth scopes in the manifest. Connectors without explicit OAuth scopes will be rejected.
- If the user needs an account to use the connector, make sure the connector
addOnUrllink provides instructions to help the user create one.
- Your connector cannot be in unfinished or beta status. You have to publish a complete and functional connector. You can always update your connector but the production deployment that is released to users should be tested and feature complete.
- Provide meaningful and actionable error messages to users when users encounter a Connector internal error. This includes cases when a user provides invalid/blank input at configuration.
- You connector's
supportUrllink, and OAuth page (if applicable) should be free of spelling and grammatical errors.
shortDescriptioncannot contain any URL.
- Use appropriate authentication method in
getAuthType(). Do not request credentials via
- Complete the OAuth Client Verification process. The verification is
mandatory for all connectors regardless of the authentication method in
getAuthType(). The verification process is handled by a separate team. Consult the OAuth API Verification FAQ for more info on this. Your connector will not be published if the OAuth Client Verification process is not completed.
- During the OAuth verification process, add your connector's required
OAuth scopes as part of the OAuth consent screen configuration. If you
fail to add all required scopes, you might pass the OAuth verification
process but your connector will still show the Unverified app screen.
This will cause the Partner Connector verification process to fail.
Authorize and test your connector using a new account after passing the OAuth verification process to ensure that Unverified app screen is not displayed to your users.
- During the OAuth verification process, add your connector's required OAuth scopes as part of the OAuth consent screen configuration. If you fail to add all required scopes, you might pass the OAuth verification process but your connector will still show the Unverified app screen. This will cause the Partner Connector verification process to fail.
- Ensure you 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: