Riferimento manifest

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

Il manifest deve contenere le seguenti informazioni:

nome della proprietà Tipo Descrizione
Obbligatorio (nella proprietà dataStudio)
name string Il nome del connettore.
Limite di 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 di un'icona per il connettore.
Le dimensioni richieste sono 40 x 40 px.
addOnUrl string (link) Link a una pagina dedicata "Scopri di più" che deve spiegare cosa fa il tuo connettore e i dati a cui accede. Devi ospitare e gestire questa pagina.
Questa pagina deve contenere o rimandare ai Termini di servizio e alle 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 relativi al 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 viene pubblicato, questa breve descrizione sarà visibile nella scheda della galleria del connettore. Utilizza questo campo per descrivere brevemente la funzione del connettore. Gli utenti potranno visualizzarlo quando sfogliano i connettori nella galleria.
privacyPolicyUrl string (link) Link alle norme sulla privacy per l'organizzazione del connettore / dello sviluppatore.
termsOfServiceUrl string (link) Link ai Termini di servizio per l'organizzazione del connettore / dello sviluppatore.
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. Vedi FeeType di seguito.
sources list(Sources) L'elenco delle origini dati a cui questo connettore può connettersi. Vedi 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 report per il report di Looker Studio che verrà utilizzato come modello. Consulta la guida su come fornire modelli di report.
forceViewersCredentials boolean Se le credenziali del visualizzatore devono essere forzate per le origini dati create da questo connettore. Questa proprietà è facoltativa e il valore predefinito è false. Per maggiori dettagli sulle credenziali del visualizzatore, consulta la sezione Credenziali dell'origine dati.
useQueryConfig boolean DEPRECATO: indica se questo connettore restituirà o meno una configurazione della query per `getData()`. Utilizza invece `advancedServices`.
advancedServices.data boolean Indica se questo connettore restituirà o meno una configurazione della query per `getData()`. Consulta servizi avanzati.
advancedServices.schema boolean Indica se questo connettore restituirà o meno una configurazione di query per `getSchema()`. Consulta servizi avanzati.
Facoltativo (proprietà di livello principale)
urlFetchWhitelist list(string) Un elenco di prefissi URL HTTPS utilizzati dal connettore. Qualsiasi endpoint URL recuperato deve corrispondere a uno dei prefissi di questo elenco. In questo modo, puoi proteggere i dati degli utenti. Per ulteriori dettagli, consulta la sezione Inserimento di URL nella lista consentita.

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 il connettore.
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/password.
USER_TOKEN Indica che il connettore utilizza nome utente/token.
PATH_USER_PASS Indica che il connettore utilizza il percorso/nome utente/password.
PATH_KEY Indica che il connettore utilizza il percorso/la chiave.

FeeType

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

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

Fonti

Sources è un elenco di enumerazioni per le origini. Puoi visualizzare l'elenco esistente di fonti nel nostro repository del registro dei dati. Se l'origine a cui ti stai connettendo non esiste nel repository, invia una pull request al repository del registro dei datiper aggiungere l'origine. Il nome dell'origine può contenere solo caratteri maiuscoli e trattini bassi (ad es. Google Analytics sarà GOOGLE_ANALYTICS). Nel manifest del connettore della community, utilizza il valore della proprietà id origine dati, ad es. GOOGLE_ANALYTICS.

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