Riferimento manifest

Il file manifest (appsscript.json) è un file JSON nel progetto del connettore Apps Script. Contiene alcune informazioni sul connettore della community, necessarie per implementare e utilizzare il connettore in Looker Studio. Scopri di più sui manifest in Apps Script.

Il file manifest deve contenere le seguenti informazioni:

nome proprietà Tipo Descrizione
Obbligatorio (nella proprietà dataStudio)
name string Nome del connettore.
Limite di caratteri: 28
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 pagina "Scopri di più" dedicata che dovrebbe spiegare la funzione del connettore e i dati a cui accede. Devi ospitare e gestire questa pagina.
Questa pagina deve contenere o rimandare i tuoi Termini di servizio e le tue Norme sulla privacy.
supportUrl string (link) Link alla pagina di assistenza per il supporto di questo connettore. Gli utenti dovrebbero essere in grado di segnalare problemi con il connettore a questo link. Devi ospitare e gestire questa pagina.
description string La descrizione del connettore.
Gli utenti vedranno la descrizione completa nella pagina di configurazione del connettore. I link saranno cliccabili.
Facoltativo (nella proprietà dataStudio)
shortDescription string Limite: 114 caratteri. Se il connettore è stato pubblicato, questa breve descrizione sarà visibile nella scheda della galleria del connettore. Utilizzalo per descrivere brevemente la funzione del connettore. Gli utenti potranno visualizzare questo elemento quando sfogliano i connettori nella galleria.
privacyPolicyUrl string (link) Link alle Norme sulla privacy per il connettore / l'organizzazione di sviluppatori.
termsOfServiceUrl string (link) Link ai Termini di servizio del connettore / dell'organizzazione di sviluppatori.
authType list(AuthType) Tipo di metodo di autenticazione per il connettore. Vedi AuthType 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. È supportato un solo modello predefinito, identificato impostando una chiave default. Il valore deve essere l'ID del report di Looker Studio che verrà utilizzato come modello. Consulta la guida Fornire modelli di report.
forceViewersCredentials boolean Indica se forzare o meno le credenziali del visualizzatore per le origini dati create da questo connettore. Questa proprietà è facoltativa e il valore predefinito è false. Per ulteriori dettagli sulle credenziali del visualizzatore, consulta Credenziali per origine dati.
useQueryConfig boolean OBSOLETO: indica se il connettore restituirà o meno una configurazione di query per "getData()". Usa invece "advancedServices".
advancedServices.data boolean Indica se il connettore restituirà o meno una configurazione di query per "getData()". Vedi i servizi avanzati.
advancedServices.schema boolean Indica se il connettore restituirà o meno una configurazione di query per "getSchema()". Vedi i servizi avanzati.
Facoltativo (proprietà di livello principale)
urlFetchWhitelist list(string) Un elenco dei prefissi URL HTTPS utilizzati dal connettore. Qualsiasi endpoint URL recuperato deve corrispondere a uno dei prefissi in questo elenco. Ciò può contribuire a proteggere i dati utente. Per ulteriori dettagli, consulta la pagina relativa alla lista sicura degli URL.

AuthType

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

Valore numerico Descrizione
NONE Indica che non è richiesta alcuna autenticazione per il connettore.
OAUTH2 Indica che il connettore utilizza OAuth 2.0.
KEY Indica che il connettore utilizza una 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 un percorso/chiave.

FeeType

I valori per il tipo di tariffa possono essere:

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

Fonti

Le origini sono un elenco di enumerazioni per le origini. Puoi visualizzare l'elenco esistente delle origini nel nostro repository del registro di dati. Se l'origine a cui ti connetti non esiste nel repository, invia una richiesta pull al repository di Data Registry per aggiungere l'origine. Il nome dell'origine può contenere solo caratteri maiuscoli e trattini bassi (ad es. Google Analytics sarà GOOGLE_ANALYTICS). Nel file manifest del connettore della community, utilizza il valore della proprietà ID origine dati, ad esempio GOOGLE_ANALYTICS.

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