Review the Publishing overview to understand the benefits and required level of commitment for publishing a connector. To publish a Partner Connector, your connector must meet all of the requirements described below.
- Share view access of your Apps Script project with the following:
- Create a deployment named
Productionand update the
Productiondeployment to the version of code you intend to publish.
Include the following in your connector's manifest. View the manifest reference for more information.
descriptionshould provide information and instructions for a basic understanding of the connector and how to use it. Connectors with vague and incomplete descriptions will be rejected.
addOnUrlshould be a dedicated hosted page about your connector, preferably hosted on your own domain. The page must include the following:
the same domain as the
- Details the user will need to know to use your connector.
- The sign up link, if an account is required to use your connector,.
- Content hosted preferably on your domain. Hosting on
https://sites.google.com/is not allowed.
- See example pages from existing partners: Funnel, Supermetrics, CallRail.
supportUrlshould be a hosted page to get support for your connector. This cannot be an email or mailto link.
logoUrlshould point to a static image hosted under your control. You cannot use images served by Google services on domains such as
*.googleusercontent.com. Using Google Cloud Storage to serve images from the
*.googleapis.comdomain is acceptable and is a recommended hosting option.
- Connectors with animated icons will be rejected. Use static images.
- It's recommended to use at minimum, a 48x48-pixel image.
- Avoid text-only images that are difficult to read when scaled down to 48x48-pixels.
- Populate the
sourcesproperty with all sources your connector connects to. See Sources in Manifest reference for details.
- You can view the existing list of sources at 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. Your connector will show up in the search results when users search for a specific source in the gallery.
- Provide values for
nameshould directly represent the purpose of the connector. A clear name will help users determine whether your connector meets their needs. Avoid using the word connector in the name since users already know they are looking at a connector.
- Do not include special or non-visible characters with the intention of drawing attention to or potentially altering the position of your connector.
- 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 (
name, etc). In general, do not include special or non-visible characters with the intention of drawing attention to your connector.
- If your connector has a fixed schema, create a report template for your
connector and add it to the manifest. Enable Sharing by link for the
- 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.
- Include all endpoints used with the
- If your connector does not fetch resources using the
urlFetchWhitelistto an empty list
- If your connector does not connect to a set of fixed endpoints or the
endpoint prefix varies, omit the
urlFetchWhitelistproperty and provide details in the Exception for urlFetchWhitelist form field when submitting the review request.
- Include all endpoints used with 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.
supportUrllink, and OAuth page (if applicable) should be free of spelling and grammatical errors.
shortDescriptioncannot contain URLs.
- Use authentication methods provided by
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 a different process from the connector review and is handled by a separate team, not Data Studio. Consult the OAuth API Verification FAQ for more info. Your connector will be rejected 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: