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 de votre connecteur Apps Script projet. Il contient certaines informations sur votre connecteur de communauté requis pour déployer et utiliser votre connecteur 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 du 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 un lien "En savoir plus" dédié expliquant ce que sont vos le connecteur et les données auxquelles il accède. Vous devez héberger et gérer . Cette page doit contenir vos conditions d'utilisation et vos règles de confidentialité, ou proposer un lien vers ces pages Règle.
`supportUrl`	`string (link)`	Lien vers la page d'assistance concernant la compatibilité avec ce connecteur. Utilisateurs vous devriez pouvoir signaler les problèmes liés à votre connecteur via ce lien. Toi doit héberger et gérer cette page.
`description`	`string`	Description du connecteur. Les utilisateurs verront la description complète dans votre connecteur page de configuration. 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 le connecteur. Utilisez ce champ pour décrire brièvement le rôle de votre connecteur. Utilisateurs pourra le consulter en parcourant les connecteurs du 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 de l'organisation du connecteur / développeur.
`authType`	`list(AuthType)`	Type de méthode d'authentification pour votre connecteur. Consultez la section AuthType ci-dessous.
`feeType`	`list(FeeType)`	Indique le type de frais associés à votre connecteur. Consultez 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. Une seule valeur par défaut standard est pris en charge, identifié par la définition d'un Clé `default`. La valeur doit correspondre à l'ID du rapport Looker rapport Studio qui sera utilisé comme modèle. Consultez le guide Fournir modèles de rapports.
`forceViewersCredentials`	`boolean`	Indique si les identifiants du lecteur doivent être forcés pour les sources de données créés à partir de ce connecteur. Cette propriété est facultative et est définie par défaut sur `false` Voir Données les identifiants de la source pour en savoir plus sur les identifiants du lecteur.
`useQueryConfig`	`boolean`	OBSOLÈTE: indique si le connecteur renvoie ou non une configuration de requête pour `getData()`. Utilisez plutôt "advancedServices".
`advancedServices.data`	`boolean`	Indique si ce connecteur renvoie ou non une configuration de requête pour `getData()`. Voir les options avancées Google Cloud.
`advancedServices.schema`	`boolean`	Indique si ce connecteur renvoie ou non une configuration de requête pour `getSchema()`. Voir les options avancées Google Cloud.
Facultatif (propriété au niveau racine)
`urlFetchWhitelist`	`list(string)`	Liste des préfixes d'URL HTTPS utilisés par votre connecteur. Tout point de terminaison d'URL doit correspondre à l'un des préfixes de cette liste. Cela peut vous aider à à protéger les données utilisateur. Reportez-vous à la section Ajouter à la liste d'autorisation URL pour en savoir plus.

AuthType

Les valeurs possibles pour le type de méthode d'authentification sont 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/mot de passe.
`USER_TOKEN`	Indique que le connecteur utilise un nom d'utilisateur ou un jeton.
`PATH_USER_PASS`	Indique que le connecteur utilise un chemin/nom d'utilisateur/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 l'une des suivantes:

Valeur enum	Description
`FREE`	Indique que l'utilisation du 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'énumérations pour les sources. Vous pouvez afficher la liste existante sources dans notre dépôt Data Registry. Si la source à laquelle vous vous connectez n'existe pas dans le dépôt, envoyez une demande d'extraction au registre de données. Repository pour ajouter la source. Le nom de la source ne peut contenir que des majuscules et des traits de soulignement (par exemple, Google Analytics sera GOOGLE_ANALYTICS). Dans votre fichier manifeste Community Connector, utilisez la valeur de l'ID de la source de données. (ex. : GOOGLE_ANALYTICS

Exemple de fichier manifeste pour un connecteur de communauté

Voici un exemple de fichier manifeste terminé:

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/"
  ]
}