Cette page a été traduite par l'API Cloud Translation.

Référence du fichier manifeste

Le fichier manifeste (appsscript.json) est un fichier JSON dans votre projet de connecteur Apps Script. Il contient certaines informations sur votre connecteur de communauté qui sont nécessaires pour le déployer et l'utiliser dans Looker Studio. En savoir plus sur les fichiers manifestes dans Apps Script

Votre fichier manifeste doit contenir les informations suivantes :

nom de la propriété	Type	Description
Obligatoire (sous la propriété `dataStudio`)
`name`	`string`	Nom de votre connecteur. 28 caractères maximum
`company`	`string`	Nom de l'organisation ou du développeur.
`companyUrl`	`string (link)`	Lien vers le site Web de l'organisation ou du développeur.
`logoUrl`	`string (image link)`	URL d'une icône pour votre connecteur. Les dimensions requises sont de 40 x 40 pixels.
`addOnUrl`	`string (link)`	Lien vers une page "En savoir plus" dédiée qui doit expliquer ce que fait votre connecteur et les données auxquelles il accède. Vous devez héberger et gérer cette page. Cette page doit contenir vos conditions d'utilisation et vos règles de confidentialité, ou un lien vers celles-ci.
`supportUrl`	`string (link)`	Lien vers la page d'assistance pour ce connecteur. Les utilisateurs doivent pouvoir signaler les problèmes liés à votre connecteur sur cette page. Vous devez héberger et gérer cette page.
`description`	`string`	Description de votre connecteur. Les utilisateurs verront la description complète sur la page de configuration de votre connecteur. Les liens seront cliquables.
Facultatif (sous la propriété `dataStudio`)
`shortDescription`	`string`	Limite : 114 caractères. Si votre connecteur est publié, cette brève description sera visible dans la fiche de la galerie pour votre connecteur. Décrivez brièvement le rôle de votre connecteur. Les utilisateurs pourront voir cette description lorsqu'ils parcourront les connecteurs dans la galerie.
`privacyPolicyUrl`	`string (link)`	Lien vers les règles de confidentialité de l'organisation du connecteur / développeur.
`termsOfServiceUrl`	`string (link)`	Lien vers les conditions d'utilisation du connecteur / de l'organisation du développeur.
`authType`	`list(AuthType)`	Type de méthode d'authentification pour votre connecteur. Reportez-vous à la section AuthType ci-dessous.
`feeType`	`list(FeeType)`	Indique le type de frais pour votre connecteur. Reportez-vous à la section FeeType ci-dessous.
`sources`	`list(Sources)`	Liste des sources de données auxquelles ce connecteur peut se connecter. Consultez la section Sources ci-dessous.
`templates`	`Object`	Liste des modèles pouvant être utilisés avec ce connecteur. Un seul modèle par défaut est accepté. Il est identifié par la définition d'une clé `default`. La valeur doit correspondre à l'ID du rapport Looker Studio qui sera utilisé comme modèle. Consultez le guide sur la fourniture de modèles de rapports.
`forceViewersCredentials`	`boolean`	Indique si les identifiants du lecteur doivent être forcés pour les sources de données créées à partir de ce connecteur. Cette propriété est facultative et est définie par défaut sur `false`. Pour en savoir plus sur les identifiants du lecteur, consultez Identifiants de la source de données.
`useQueryConfig`	`boolean`	OBSOLÈTE : indique si ce connecteur renverra une configuration de requête pour `getData()`. Utilisez plutôt `advancedServices`.
`advancedServices.data`	`boolean`	Indique si ce connecteur renverra ou non une configuration de requête pour `getData()`. Consultez Services avancés.
`advancedServices.schema`	`boolean`	Indique si ce connecteur renverra ou non une configuration de requête pour `getSchema()`. Consultez Services avancés.
Facultatif (propriété de niveau racine)
`urlFetchWhitelist`	`list(string)`	Liste des préfixes d'URL HTTPS utilisés par votre connecteur. Tout point de terminaison d'URL récupéré doit correspondre à l'un des préfixes de cette liste. Cela peut aider à protéger les données utilisateur. Pour en savoir plus, consultez Ajouter des URL à la liste d'autorisation.

AuthType

Les valeurs du type de méthode d'authentification peuvent être les suivantes :

Valeur enum	Description
`NONE`	Indique qu'aucune authentification n'est requise pour le connecteur.
`OAUTH2`	Indique que le connecteur utilise OAuth 2.0.
`KEY`	Indique que le connecteur utilise une clé API.
`USER_PASS`	Indique que le connecteur utilise un nom d'utilisateur et un mot de passe.
`USER_TOKEN`	Indique que le connecteur utilise un nom d'utilisateur/jeton.
`PATH_USER_PASS`	Indique que le connecteur utilise un chemin d'accès, un nom d'utilisateur et un mot de passe.
`PATH_KEY`	Indique que le connecteur utilise un chemin d'accès/une clé.

FeeType

Les valeurs du type de frais peuvent être les suivantes :

Valeur enum	Description
`FREE`	Indique que le connecteur est entièrement sans frais.
`FREE_TRIAL`	Indique que le connecteur propose une option d'essai sans frais.
`PAID`	Indique que l'utilisateur devra payer pour utiliser le connecteur.

Sources

"Sources" est une liste d'énums pour les sources. Vous pouvez consulter la liste existante des sources dans notre dépôt du registre de données. Si la source à laquelle vous vous connectez n'existe pas dans le dépôt, envoyez une demande d'extraction au dépôt du Registre de données pour l'ajouter. Le nom de la source ne peut contenir que des caractères en majuscules et des traits de soulignement (par exemple, Google Analytics sera GOOGLE_ANALYTICS). Dans le fichier manifeste de votre connecteur de communauté, utilisez la valeur de la propriété d'ID de source de données, par exemple GOOGLE_ANALYTICS.

Exemple de fichier manifeste pour un connecteur de communauté

Voici un exemple de fichier manifeste rempli :

data-studio/appsscript.json

Afficher sur GitHub

{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}