Riferimento manifest

Il manifest (appsscript.json) è un file JSON nel connettore Apps Script progetto. Contiene alcune informazioni sul tuo connettore della community necessario per eseguire il deployment del connettore in Looker Studio e utilizzarlo. Scopri di più sui file manifest in Apps Script.

Il file manifest deve contenere le seguenti informazioni:

nome struttura Tipo Descrizione
Obbligatorio (sotto la proprietà dataStudio)
name string Nome del connettore.
Massimo 28 caratteri
company string Nome dell'organizzazione o dello sviluppatore.
companyUrl string (link) Link al sito web dell'organizzazione o dello sviluppatore.
logoUrl string (image link) L'URL a un'icona del connettore.
Le dimensioni richieste sono 40 x 40 px.
addOnUrl string (link) Link a una sezione "Scopri di più" pagina che dovrebbe spiegare cosa e ai dati a cui accede. Devi ospitare e mantenere .
Questa pagina deve contenere o rimandare ai tuoi Termini di servizio e alla tua privacy Policy.
supportUrl string (link) Link alla pagina di assistenza per il supporto di questo connettore. Utenti dovresti poter segnalare problemi con il connettore a questo link. Tu deve ospitare e gestire questa pagina.
description string La descrizione del connettore.
Gli utenti vedranno la descrizione completa nel connettore di configurazione del deployment. I link saranno cliccabili.
Facoltativo (nella proprietà dataStudio)
shortDescription string Limite di caratteri: 114. Se il connettore è pubblicato, questa breve descrizione sarà visibile nella scheda Galleria di rete. Utilizza questa descrizione per descrivere brevemente ciò che fa il connettore. Utenti potranno visualizzarlo quando sfogliano i connettori nel galleria.
privacyPolicyUrl string (link) Link alle norme sulla privacy per il connettore / l'organizzazione dello sviluppatore.
termsOfServiceUrl string (link) Link ai Termini di servizio per il connettore / l'organizzazione dello sviluppatore.
authType list(AuthType) Tipo di metodo di autenticazione per il connettore. Consulta la sezione AuthType riportata di seguito.
feeType list(FeeType) Indica il tipo di tariffa per il connettore. Consulta la sezione FeeType di seguito.
sources list(Sources) L'elenco di origini dati a cui può connettersi questo connettore. Consulta la sezione Fonti di seguito.
templates Object Elenco dei modelli che possono essere utilizzati con questo connettore. Solo uno predefinito modello è supportato, identificato dall'impostazione di un default chiave. Il valore deve essere l'ID report per Looker Report di Studio che verrà utilizzato come modello. Consulta la guida su come fornire modelli di report.
forceViewersCredentials boolean Indica se le credenziali del visualizzatore devono essere forzate o meno per le origini dati. creati da questo connettore. Questa proprietà è facoltativa e il valore predefinito è false. Consulta la sezione Dati credenziali di origine per ulteriori dettagli sulle credenziali del visualizzatore.
useQueryConfig boolean OBSOLETO: indica se il connettore restituirà o meno una configurazione delle query per `getData()`. Usa invece "advancedServices".
advancedServices.data boolean Indica se questo connettore restituirà o meno una configurazione delle query per `getData()`. Vedi le opzioni avanzate Google Cloud.
advancedServices.schema boolean Indica se questo connettore restituirà o meno una configurazione delle query per `getSchema()`. Vedi le opzioni avanzate Google Cloud.
Facoltativo (proprietà a livello di directory principale)
urlFetchWhitelist list(string) Un elenco di prefissi URL HTTPS utilizzati dal connettore. Qualsiasi endpoint URL recuperati devono corrispondere a uno dei prefissi in questo elenco. Questo può essere utile per proteggere i dati degli utenti. Consulta la sezione SafeSearch URL per ulteriori dettagli.

AuthType

I valori per il tipo di metodo di autenticazione possono essere uno dei seguenti:

Valore enum Descrizione
NONE Indica che non è richiesta l'autenticazione per di rete.
OAUTH2 Indica che il connettore utilizza OAuth 2.0.
KEY Indica che il connettore utilizza la chiave API.
USER_PASS Indica che il connettore utilizza nome utente e password.
USER_TOKEN Indica che il connettore utilizza nome utente/token.
PATH_USER_PASS Indica che il connettore utilizza percorso/nome utente/password.
PATH_KEY Indica che il connettore utilizza il percorso/la chiave.

FeeType

I valori per il tipo di tariffa possono essere:

Valore enum Descrizione
FREE Indica che il connettore è completamente senza costi.
FREE_TRIAL Indica che il connettore dispone di un'opzione di prova senza costi.
PAID Indica che l'utente dovrà pagare per utilizzare il connettore.

Fonti

Fonti è un elenco di enumerazioni per le sorgenti. Puoi visualizzare l'elenco esistente di nel nostro Repository dei dati. Se la fonte a cui ti stai connettendo non esiste nel repository, invia una richiesta di pull al registro dati Repository per aggiungere l'origine. Il nome dell'origine può contenere solo lettere maiuscole e trattini bassi (ad es. Google Analytics sarà GOOGLE_ANALYTICS). Nel manifest del connettore della community, utilizza il valore dell'ID origine dati proprietà, ad esempio GOOGLE_ANALYTICS.

Manifest di esempio per un connettore della community

Di seguito è riportato un esempio di manifest completato:

data-studio/appsscript.json
{
  "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/"
  ]
}