Requisiti del connettore di partner

Consulta la Panoramica della pubblicazione per comprendere i vantaggi e il livello di impegno richiesto per pubblicare un connettore. Per pubblicare un connettore partner, il tuo connettore deve soddisfare tutti i requisiti descritti di seguito.

Apps Script

Prima di inviare il connettore per la revisione, completa le seguenti operazioni in Apps Script:

  1. Condividi l'accesso in visualizzazione del tuo progetto Apps Script con i seguenti utenti:
  2. Crea un deployment denominato Production e aggiorna il deployment Production alla versione del codice che intendi pubblicare.
  3. Conferma di aver aggiornato il deployment di Production alla versione del codice che vuoi che venga esaminato.
  4. Verifica che il file manifest sia visibile in Apps Script. A sinistra, fai clic su Impostazioni progetto . Seleziona la casella di controllo Mostra il file manifest "appsscript.json" nell'editor.

Manifest

Includi quanto segue nel manifest del connettore e verifica che il progetto Apps Script sia configurato per mostrare il file manifest appsscript.json nell'editor.

Per ulteriori informazioni, consulta il riferimento al file manifest del connettore della community.

dataStudio

  1. description deve fornire informazioni e istruzioni per una comprensione di base del connettore e del suo utilizzo. I connettori con descrizioni vaghe e incomplete verranno rifiutati.
  2. addOnUrl deve essere una pagina ospitata dedicata al tuo connettore, preferibilmente ospitata sul tuo dominio. La pagina deve includere quanto segue:
    • Norme sulla privacy e Termini e condizioni d'uso o un link a questi contenuti, sullo stesso dominio di addOnUrl.
    • Dettagli che l'utente dovrà conoscere per utilizzare il connettore.
    • Il link di registrazione, se è necessario un account per utilizzare il connettore.
    • Contenuti ospitati preferibilmente sul tuo dominio. L'hosting su https://sites.google.com/ non è consentito.
    • Consulta le pagine di esempio dei partner esistenti: Funnel, Supermetrics, CallRail.
  3. supportUrl deve essere una pagina ospitata per ricevere assistenza per il connettore. Non può essere un link email o mailto.
  4. logoUrl deve puntare a un'immagine statica ospitata sotto il tuo controllo. Non puoi utilizzare immagini pubblicate dai servizi Google su domini come *.gstatic.com, *.ggpht.com, *.google.com, *.googleusercontent.com. L'utilizzo di Google Cloud Storage per pubblicare immagini dal dominio *.googleapis.com è accettabile ed è un'opzione di hosting consigliata.
    • I connettori con icone animate verranno rifiutati. Utilizza immagini statiche.
    • Ti consigliamo di utilizzare un'immagine di almeno 48 x 48 pixel.
    • Evita immagini solo di testo difficili da leggere quando vengono ridotte a 48 x 48 pixel.
  5. Compila la proprietà sources con tutte le fonti a cui si connette il connettore. Per maggiori dettagli, consulta Fonti nel riferimento al file manifest.
    • Puoi visualizzare l'elenco esistente di fonti all'indirizzo Data Registry Repository. Se l'origine a cui ti stai connettendo non esiste nel repository, invia una richiesta di pull al repository del registro dei dati per aggiungere l'origine. Il tuo connettore non supererà la procedura di revisione se le origini nel manifest non esistono nel repository.
    • Si tratta di metadati aggiuntivi per il connettore che verranno indicizzati per la funzionalità dei risultati di ricerca nella galleria. Il connettore verrà visualizzato nei risultati di ricerca quando gli utenti cercano una fonte specifica nella galleria.
  6. Fornisci i valori per shortDescription, authType, feeType, privacyPolicyUrl e termsOfServiceUrl.
  7. name deve rappresentare direttamente lo scopo del connettore. Un nome chiaro aiuterà gli utenti a determinare se il connettore soddisfa le loro esigenze. Evita di utilizzare la parola connettore nel nome, poiché gli utenti sanno già che stanno visualizzando un connettore.
    • Non includere caratteri speciali o non visibili con l'intenzione di attirare l'attenzione o alterare potenzialmente la posizione del connettore.
  8. Non utilizzare nomi abbreviati per Data Studio in nessun punto del manifest (ad es. GDS, DS e così via).
  9. Le emoji non sono consentite in nessun campo del file manifest (description, shortDescription, name e così via). In generale, non includere caratteri speciali o non visibili con l'intenzione di attirare l'attenzione sul connettore.
  10. Se il connettore ha uno schema fisso, crea un modello di report per il connettore e aggiungilo al manifest. Attiva la condivisione tramite link per il report.

urlFetchWhitelist

  1. Limita il numero di endpoint chiamati da UrlFetchApp a quelli assolutamente necessari per la funzionalità del connettore. Aggiungi la proprietà urlFetchWhitelist al livello principale del manifest. Per ulteriori informazioni, consulta il riferimento urlFetchWhitelist.
    • Includi tutti gli endpoint utilizzati con il servizio UrlFetchApp.
    • Se il connettore non recupera le risorse utilizzando il servizio UrlFetchApp, imposta urlFetchWhitelist su un elenco vuoto [].
    • Se il connettore non si connette a un insieme di endpoint fissi o se il prefisso dell'endpoint varia, ometti la proprietà urlFetchWhitelist e fornisci i dettagli nel campo del modulo Eccezione per urlFetchWhitelist quando invii la richiesta di revisione.

oauthScopes

  1. Imposta ambiti OAuth espliciti nel manifest. I connettori senza ambiti OAuth espliciti verranno rifiutati.

Connettore

  1. Se l'utente ha bisogno di un account per utilizzare il connettore, assicurati che il connettore description o il link addOnUrl fornisca istruzioni per aiutare l'utente a crearne uno.
  2. Il connettore non può essere in stato di bozza o beta. Devi pubblicare un connettore completo e funzionante. Puoi sempre aggiornare il connettore, ma il deployment di produzione rilasciato agli utenti deve essere testato e completo di funzionalità.
  3. Fornisci messaggi di errore significativi e strategici agli utenti quando si verifica un errore interno del connettore. Sono inclusi i casi in cui un utente fornisce input non validi/vuoti durante la configurazione.
  4. shortDescription, description, addOnUrl, supportUrl e pagina OAuth (se applicabile) devono essere privi di errori ortografici e grammaticali.
  5. shortDescription non può contenere URL.
  6. Utilizza i metodi di autenticazione forniti da getAuthType(). Non richiedere le credenziali tramite getConfig().
  7. Completa la procedura di verifica del client OAuth. La verifica è obbligatoria per tutti i connettori, indipendentemente dal metodo di autenticazione in getAuthType(). La procedura di verifica è diversa dalla revisione del connettore ed è gestita da un team separato, non da Data Studio. Per ulteriori informazioni, consulta le domande frequenti sulla verifica delle API OAuth. Il connettore verrà rifiutato se la procedura di verifica del client OAuth non viene completata.
    • Durante la procedura di verifica OAuth, aggiungi gli ambiti OAuth richiesti del connettore nell'ambito della configurazione della schermata per il consenso OAuth. Se non riesci ad aggiungere tutti gli ambiti richiesti, potresti superare la procedura di verifica OAuth, ma il connettore mostrerà comunque la schermata App non verificata. In questo modo, la procedura di verifica del connettore del partner non andrà a buon fine.
      Autorizza e testa il connettore utilizzando un nuovo account dopo aver superato la procedura di verifica OAuth per assicurarti che la schermata "App non verificata" non venga mostrata ai tuoi utenti.
  8. Assicurati di rispettare i Termini di servizio per le gallerie di Data Studio (mittente).

Una volta soddisfatti tutti i requisiti, fai clic sul pulsante seguente per richiedere una revisione del connettore:

Pubblica il tuo connettore partner