Conditions requises pour les connecteurs partenaires

Consultez la présentation de la publication pour comprendre les avantages et le niveau d'engagement requis pour publier un connecteur. Pour publier un connecteur partenaire, votre connecteur doit répondre à toutes les exigences décrites ci-dessous.

Apps Script

Avant de soumettre votre connecteur pour examen, procédez comme suit dans Apps Script :

  1. Partagez l'accès en lecture de votre projet Apps Script avec les personnes suivantes :
  2. Créez un déploiement nommé Production et mettez à jour le déploiement Production avec la version du code que vous souhaitez publier.
  3. Vérifiez que vous avez mis à jour le déploiement Production avec la version du code que vous souhaitez examiner.
  4. Vérifiez que le fichier manifeste est visible dans Apps Script. À gauche, cliquez sur Paramètres du projet . Cochez la case Afficher le fichier manifeste "appsscript.json" dans l'éditeur.

Fichier manifeste

Incluez les éléments suivants dans le fichier manifeste de votre connecteur et vérifiez que votre projet Apps Script est configuré pour afficher le fichier manifeste appsscript.json dans l'éditeur.

Pour en savoir plus, consultez la documentation de référence sur le fichier manifeste du connecteur de communauté.

dataStudio

  1. description doit fournir des informations et des instructions pour comprendre les bases du connecteur et savoir comment l'utiliser. Les connecteurs dont les descriptions sont vagues et incomplètes seront refusés.
  2. addOnUrl doit être une page hébergée dédiée à votre connecteur, de préférence sur votre propre domaine. La page doit inclure les éléments suivants :
    • Des Règles de confidentialité et des Conditions d'utilisation ou un lien vers ce contenu, sur le même domaine que addOnUrl.
    • Les informations dont l'utilisateur aura besoin pour utiliser votre connecteur.
    • Le lien d'inscription, si un compte est requis pour utiliser votre connecteur.
    • Le contenu hébergé de préférence sur votre domaine. L'hébergement sur https://sites.google.com/ n'est pas autorisé.
    • Consultez des exemples de pages de partenaires existants : Funnel, Supermetrics, CallRail.
  3. supportUrl doit être une page hébergée permettant d' obtenir de l'aide pour votre connecteur. Il ne peut pas s'agir d'un e-mail ni d'un lien mailto.
  4. logoUrl doit pointer vers une image statique hébergée sous votre contrôle. Vous ne pouvez pas utiliser d'images fournies par les services Google sur des domaines tels que *.gstatic.com, *.ggpht.com, *.google.com ou *.googleusercontent.com. L'utilisation de Google Cloud Storage pour diffuser des images à partir du domaine *.googleapis.com est acceptable et constitue une option d'hébergement recommandée.
    • Les connecteurs avec des icônes animées seront refusés. Utilisez des images statiques.
    • Nous vous recommandons d'utiliser une image d'au moins 48 x 48 pixels.
    • Évitez les images contenant uniquement du texte, qui sont difficiles à lire lorsqu'elles sont réduites à 48 x 48 pixels.
  5. Remplissez la sources propriété avec toutes les sources auxquelles votre connecteur se connecte. Pour en savoir plus, consultez la section Sources dans la documentation de référence sur le fichier manifeste pour plus de détails.
    • Vous pouvez consulter la liste des sources existantes dans le dépôt du registre de données Data Registry Repository. Si la source à laquelle vous vous connectez n'existe pas dans le dépôt, envoyez une requête d'extraction au dépôt du registre de données pour l'ajouter. Votre connecteur échouera à la procédure d'examen si les sources de votre fichier manifeste n'existent pas dans le dépôt.
    • Il s'agit de métadonnées supplémentaires pour le connecteur, qui seront indexées pour la fonctionnalité de recherche dans la galerie. Votre connecteur s'affichera dans les résultats de recherche lorsque les utilisateurs rechercheront une source spécifique dans la galerie.
  6. Fournissez des valeurs pour shortDescription, authType, feeType, privacyPolicyUrl, et termsOfServiceUrl.
  7. name doit représenter directement l'objectif de le connecteur. Un nom clair aidera les utilisateurs à déterminer si votre connecteur répond à leurs besoins. Évitez d'utiliser le mot connecteur dans le nom, car les utilisateurs savent déjà qu'ils consultent un connecteur.
    • N'incluez pas de caractères spéciaux ou non visibles dans le but d'attirer l'attention sur votre connecteur ou de modifier sa position.
  8. N'utilisez pas de noms abrégés pour Data Studio dans le fichier manifeste (par exemple, GDS, DS, etc.).
  9. Les emojis ne sont pas autorisés dans les champs du fichier manifeste (description, shortDescription, name, etc.). En règle générale, n'incluez pas de caractères spéciaux ou non visibles dans le but d'attirer l'attention sur votre connecteur.
  10. Si votre connecteur a un schéma fixe, créez un modèle de rapport pour celui-ci et ajoutez-le au fichier manifeste. Activez le Partage par lien pour le rapport.

urlFetchWhitelist

  1. Limitez le nombre de points de terminaison appelés par UrlFetchApp à ceux qui sont absolument nécessaires au fonctionnement du connecteur. Ajoutez la propriété urlFetchWhitelist au niveau racine de votre fichier manifeste. Pour en savoir plus, consultez la documentation de référence sur urlFetchWhitelist.
    • Incluez tous les points de terminaison utilisés avec le service UrlFetchApp.
    • Si votre connecteur ne récupère pas de ressources à l'aide du service UrlFetchApp, définissez urlFetchWhitelist sur une liste vide [].
    • Si votre connecteur ne se connecte pas à un ensemble de points de terminaison fixes ou si le préfixe du point de terminaison varie, omettez la propriété urlFetchWhitelist et fournissez des informations dans le champ de formulaire Exception pour urlFetchWhitelist lorsque vous envoyez la demande d'examen.

oauthScopes

  1. Définissez des niveaux d'accès OAuth explicites dans le fichier manifeste. Les connecteurs sans niveaux d'accès OAuth explicites seront refusés.

Connecteur

  1. Si l'utilisateur a besoin d'un compte pour utiliser le connecteur, assurez-vous que la description du connecteur ou le lien addOnUrl fournit des instructions pour l'aider à en créer un.
  2. Votre connecteur ne peut pas être en version bêta ou inachevée. Vous devez publier un connecteur complet et fonctionnel. Vous pouvez toujours mettre à jour votre connecteur, mais le déploiement en production mis à la disposition des utilisateurs doit être testé et complet.
  3. Fournissez aux utilisateurs des messages d'erreur pertinents et exploitables lorsqu'ils rencontrent une erreur interne du connecteur. Cela inclut les cas où un utilisateur fournit une entrée non valide/vide lors de la configuration.
  4. shortDescription, description, le lien addOnUrl, le lien supportUrl et la page OAuth (le cas échéant) ne doivent pas contenir de fautes d'orthographe ni de grammaire.
  5. shortDescription ne peut pas contenir d'URL.
  6. Utilisez les méthodes d'authentification fournies par getAuthType(). Ne demandez pas d'identifiants via getConfig().
  7. Effectuez la procédure de validation du client OAuth. La validation est obligatoire pour tous les connecteurs, quelle que soit la méthode d'authentification dans getAuthType(). La procédure de validation est différente de l'examen du connecteur et est gérée par une équipe distincte, et non par Data Studio. Pour en savoir plus, consultez les questions fréquentes sur la validation de l'API OAuth. Votre connecteur sera refusé si la procédure de validation du client OAuth n'est pas terminée.
  8. Assurez-vous de respecter les Conditions d'utilisation des Galeries Data Studio (personne proposant un produit).

Une fois que vous avez rempli toutes les conditions requises, cliquez sur le bouton suivant pour demander un examen de votre connecteur :

Publier votre connecteur partenaire