Requisiti del connettore di partner

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

Apps Script

Prima di inviare il connettore per la revisione, completa i seguenti passaggi in Apps Script:

  1. Condividi l'accesso in visualizzazione del tuo progetto Apps Script con quanto segue:
  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 esaminare.
  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 file manifest del connettore e verifica che il progetto Apps Script sia configurato per visualizzare il file manifest appsscript.json nell'editor.

Consulta il riferimento al file manifest del connettore della community per ulteriori informazioni.

dataStudio

  1. description deve fornire informazioni e istruzioni per acquisire una conoscenza di base del connettore e di come utilizzarlo. I connettori con descrizioni vaghe e incomplete verranno rifiutati.
  2. addOnUrl deve essere una pagina ospitata dedicata relativa al 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 nello stesso dominio del 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'email o un link mailto.
  4. logoUrl deve indirizzare a un'immagine statica ospitata sotto il tuo controllo. Non puoi utilizzare le 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. Utilizzare immagini statiche.
    • Ti consigliamo di utilizzare come minimo un'immagine di 48 x 48 pixel.
    • Evita immagini di solo testo difficili da leggere con dimensioni ridotte a 48 x 48 pixel.
  5. Completa la proprietà sources con tutte le origini a cui si collega il connettore. Per maggiori dettagli, consulta Origini nel riferimento manifest.
    • Puoi visualizzare l'elenco esistente delle origini in Repository Data Registry. 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 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à di ricerca nella galleria. Il connettore verrà visualizzato nei risultati di ricerca quando gli utenti cercano un'origine specifica nella galleria.
  6. Fornisci valori per shortDescription, authType, feeType, privacyPolicyUrl e termsOfServiceUrl.
  7. name deve rappresentare direttamente lo scopo del connettore. Un nome chiaro aiuterà gli utenti a stabilire se il connettore soddisfa le loro esigenze. Evita di utilizzare la parola connettore nel nome, poiché gli utenti sanno già di guardare un connettore.
    • Non includere caratteri speciali o non visibili con l'intento di attirare l'attenzione sul connettore o modificarne potenzialmente la posizione.
  8. Non utilizzare nomi abbreviati per Looker 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 allo scopo di attirare l'attenzione sul connettore.
  10. Se il connettore ha uno schema fisso, crea un modello di report per quest'ultimo e aggiungilo al manifest. Attiva Condivisione tramite link per il report.

urlFetchWhitelist

  1. Limita il numero di endpoint chiamati da UrlFetchApp a quelli strettamente necessari per la funzionalità del connettore. Aggiungi la proprietà urlFetchWhitelist al livello principale del file manifest. Visualizza il riferimento urlFetchWhitelist per ulteriori informazioni.
    • Include tutti gli endpoint utilizzati con il servizio UrlFetchApp.
    • Se il connettore non recupera 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 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 file 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 le istruzioni per aiutarlo a crearne uno.
  2. Il connettore non può essere in stato Non completato o beta. Devi pubblicare un connettore completo e funzionale. Puoi sempre aggiornare il connettore, ma il deployment di produzione rilasciato agli utenti deve essere testato e completato le funzionalità.
  3. Fornisci agli utenti messaggi di errore significativi e strategici quando gli utenti riscontrano un errore interno del connettore. Sono inclusi i casi in cui un utente fornisce un input non valido/vuoto durante la configurazione.
  4. shortDescription, description, link addOnUrl, supportUrl link e la pagina OAuth (se applicabile) devono essere privi di errori ortografici e grammaticali.
  5. Il campo 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 dei connettori ed è gestita da un team separato, non da Looker Studio. Per ulteriori informazioni, consulta le domande frequenti sulla verifica dell'API OAuth. Se la procedura di verifica client OAuth non viene completata, il connettore verrà rifiutato.
    • Durante la procedura di verifica OAuth, aggiungi gli ambiti OAuth richiesti del connettore come parte della configurazione della schermata per il consenso OAuth. Se non riesci ad aggiungere tutti gli ambiti obbligatori, potresti superare il processo di verifica OAuth, ma il connettore continuerà a mostrare la schermata App non verificata. Di conseguenza, la procedura di verifica del connettore partner non andrà a buon fine.
      Autorizza e testa il connettore utilizzando un nuovo account dopo aver superato il processo di verifica OAuth per assicurarti che agli utenti non venga visualizzata la schermata App non verificata.
  8. Assicurati di rispettare i Termini di servizio delle gallerie di Looker Studio (Mittente).

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

Pubblica il connettore partner