Configurazione del progetto Google Cloud

Questa pagina contiene le informazioni necessarie per creare e configurazione dei progetti Google Cloud per i componenti aggiuntivi di Classroom. I progetti Google Cloud vengono utilizzati per implementare il servizio Single Sign-On di Google tramite OAuth 2.0 (SSO Google), per autorizzare le richieste effettuate dal componente aggiuntivo e gestire elenco dei componenti aggiuntivi in Google Workspace Marketplace .

Per informazioni più generali sulla pubblicazione di un componente aggiuntivo in Nel Marketplace, consulta Pubblicazione di un'app.

Creazione di progetti Google Cloud

Punto chiave: l'applicazione del componente aggiuntivo di produzione deve avere visibilità pubblica impostate nell'SDK di Google Workspace Marketplace. Un progetto privato può essere utile per lo sviluppo e il test del componente aggiuntivo, ma solo uno pubblico è obbligatorio.

Ci sono due tipi di progetti da creare: un progetto privato utilizzato sviluppo e un progetto pubblico raggiungibile dagli utenti finali. Il "pubblico" e "privato" le etichette si riferiscono alla visibilità dell'applicazione Google Workspace Marketplace un marketplace privato applicazione può essere installata solo dagli utenti all'interno del dominio in cui è stata mentre un'applicazione Marketplace pubblica disponibili per qualsiasi dominio Google Workspace. Questi devono essere due le applicazioni, un progetto non può essere sia pubblico sia privato. Applicazioni pubbliche devono essere esaminati e approvati prima di essere disponibili sul Marketplace.

Importante: non puoi convertire un progetto privato in uno pubblico.

Per informazioni generali sulla creazione di progetti Google Cloud, visita Crea un progetto Google Cloud.

Crea un progetto Google Cloud pubblico

Questo progetto rappresenta l'applicazione del componente aggiuntivo accessibile amministratori, insegnanti e studenti. Un progetto pubblico deve essere esaminato e approvata dal team di Google Workspace Marketplace prima del lancio o installato.

1. Crea un nuovo progetto Google Cloud nel tuo dominio di produzione.

   Creare un progetto Google Cloud

   Importante: assicurati che il progetto appartenga al tuo dominio di produzione e che hai eseguito l'accesso alla console Google Cloud come utente di quel dominio.
   Avviso: devi utilizzare la versione Bozza del progetto per i test. Alle ore questa volta, la funzionalità Bozza è disponibile solo tramite Programma Anteprima per gli sviluppatori di Google Workspace. Dopo aver creato il progetto Cloud, completa la modulo di richiesta per attivare le funzionalità del Programma Anteprima per gli sviluppatori di Google Workspace. Per maggiori informazioni informazioni, consulta Aggiornare la scheda dell'app con le bozze.

2. Abilitare l'API Classroom nel tuo progetto Cloud.

   Attivare l'API Classroom

3. Abilita l'SDK di Google Workspace Marketplace nel tuo progetto Cloud.

   Attivare l'SDK Google Workspace Marketplace

4. Impostare l'SDK Marketplace Configurazione app Visibilità dell'app su Pubblico e seleziona la casella Non in elenco.

   Punto chiave: non puoi condividere o convertire un progetto privato utilizzato durante sviluppo e test.
   Punto chiave: non è possibile trovare le app non in elenco Google Workspace Marketplace sfogliando i contenuti o eseguendo una ricerca. All'interno del configurazione dell'SDK Marketplace, puoi trovare un URL diretto che può essere utilizzato per installare il componente aggiuntivo. Solo Google e lo sviluppatore possono trova la scheda dello Store. L'app deve rimanere non in elenco finché ha deciso di rilasciarla al pubblico. Puoi attivare/disattivare disponibile nella pagina di configurazione dell'app SDK Marketplace.

5. Compila i campi obbligatori nell'SDK Marketplace Pagina Scheda dello Store e fai clic su PUBBLICA.

6. La tua app verrà esaminata dal team di Google Workspace Marketplace. Loro comunicherà con te utilizzando l'indirizzo email dello sviluppatore specificato SDK Marketplace. Dopo che l'app è stata approvata, cancella la casella Non in elenco, in modo che insegnanti e amministratori possano trovarla nella Marketplace.

Crea un progetto Google Cloud privato

Questo progetto privato rappresenta l'applicazione del componente aggiuntivo utilizzata per lo sviluppo. Non è accessibile agli utenti esterni al dominio in cui è stata creata, ma senza richiedere l'approvazione prima dell'installazione. Per questo motivo, Google consiglia utilizzando questo progetto per sviluppare e testare il tuo componente aggiuntivo in un ambiente controllato.

Devi accedere a un dominio Google Workspace for Education con Teaching & Apprendimento o Plus per creare un progetto privato. Se non hai ancora accesso a questo segui questi passaggi per configurare un dominio Google Workspace for Education dimostrativo, eseguirne l'upgrade a Inoltre, con la licenza e l'accesso all'API dei componenti aggiuntivi di Classroom:

1. Completa i passaggi per richiedere un dominio di prova per sviluppatori.

2. Dopo aver effettuato l'accesso come amministratore nel dominio demo, crea un nuovo progetto Google Cloud.

   Creare un progetto Google Cloud

   Avviso: assicurati che il progetto appartenga al dominio demo e di essere hai eseguito l'accesso alla console Google Cloud utilizzando un account amministratore della demo dominio.

   Se non riesci ad accedere alla console Google Cloud o a creare progetti Cloud, verifica quanto segue nel Console di amministrazione:

   • Vai alla pagina Impostazioni account > pagina delle impostazioni di accesso in base all'età e seleziona l'opzione Tutti gli utenti di questo gruppo o di questa unità organizzativa hanno 18 anni oppure meno recenti.
   • In App > Servizi Google aggiuntivi:
   • La piattaforma Google Cloud è ON per tutti.
   • Le impostazioni per la creazione dei progetti sono Consenti agli utenti di creare progetti.
   • Le impostazioni di accesso a Cloud Shell sono Consenti l'accesso a Cloud Shell.

3. Compila e invia il modulo di richiesta di upgrade del dominio demo. Invio in corso... modulo richiede che Google esegua l'upgrade del tuo dominio dimostrativo a Google Workspace for Education Plus con dieci e consente al tuo progetto Cloud di accedere l'API Classroom Add-ons.

   Riceverai un'email quando verranno eseguiti i processi di upgrade e lista consentita completato. Assegna licenze Plus agli account degli insegnanti di prova in Console di amministrazione. Sottopeso Directory > Utenti, crea o seleziona i tuoi account degli insegnanti di prova. In ogni Licenze dell'insegnante, verifica che Google Workspace for Education Plus sia Assegnato.

4. Abilitare l'API Classroom nel tuo progetto Cloud.

   Attivare l'API Classroom

5. Abilita l'SDK di Google Workspace Marketplace nel tuo progetto Cloud.

   Attivare l'SDK Google Workspace Marketplace

6. Impostare l'SDK Marketplace Configurazione app Visibilità delle app come private.

7. Compila i campi obbligatori nell'SDK Marketplace Pagina Scheda dello Store e fai clic su PUBBLICA. Dopo la pubblicazione della scheda dell'app, gli utenti del dominio possono trovare e installare l'app in Google Workspace Marketplace oppure visitando l'URL dell'app mostrato nella pagina Scheda dello Store.

OAuth 2.0

L'accesso all'API Classroom richiede il consenso all'accesso ai dati utente. Questi si ottengono richiedendo a Google l'accesso agli ambiti OAuth per gli utenti che hanno eseguito l'accesso utente e riceve un token che può essere utilizzato per effettuare successivamente chiamate API Google Classroom. Gli ambiti devono essere configurati nella scheda dello Store di Google Workspace Marketplace in modo che l'amministratore di dominio possono fornire il consenso per conto degli utenti del loro dominio se installano il componente aggiuntivo.

Importante: se il componente aggiuntivo richiede ambiti aggiuntivi, includili nella schermata per il consenso, scheda Configurazione app dell'SDK Marketplace e dal codice dell'applicazione del tuo componente aggiuntivo. Ambiti non corrispondenti in queste località potrebbero causare problemi agli utenti durante l'installazione del componente aggiuntivo.

Consulta la pagina Ambiti OAuth per le API di Google per un elenco dettagliato di tutti gli ambiti e i loro utilizzi. Vedi Configurare la pagina OAuth nella documentazione di Workspace per informazioni generali sulla configurazione OAuth.

Autorizzazioni utente

La tua app web deve richiedere almeno uno dei seguenti ambiti:

• https://www.googleapis.com/auth/userinfo.email, che consente per visualizzare l'indirizzo email dell'utente.
• https://www.googleapis.com/auth/userinfo.profile, che consente applicazione per visualizzare informazioni personali quali Verticale, Nome e Cognome nomi e altre informazioni personali che l'utente ha reso pubblicamente disponibili.

Dopo che un utente ha autorizzato uno di questi ambiti nel tuo componente aggiuntivo, identificati dal parametro di query login_hint. Questo parametro viene passato a qualsiasi degli URL dell'app web quando viene aperto un iframe. Se un utente non ne ha autorizzato una di questi ambiti, login_hint non verrà inviato.

Avviso: la tua app deve richiedere almeno uno dei userinfo.email o userinfo.profile ambiti per ricevere login_hint per le visite successive dallo stesso utente.

login_hint è un parametro OpenID Connect standard che puoi scegliere Trasmettere a Google quando si utilizza Accedi con Google o si richiede un token OAuth. it ha lo scopo di rendere l'esperienza di autorizzazione più fluida per l'utente finale.

Ambiti dei componenti aggiuntivi di Classroom

I seguenti ambiti sono specifici dei componenti aggiuntivi di Classroom:

• https://www.googleapis.com/auth/classroom.addons.teacher, che consente l'accesso a tutti i metodi dell'API.
• https://www.googleapis.com/auth/classroom.addons.student, che consente accesso per avviare le operazioni di convalida e lettura degli allegati.

Anche con un token di accesso OAuth valido che indica le credenziali dell'utente, le chiamate API sono regolati da requisiti aggiuntivi:

• Tutti i metodi richiedono che l'utente sia un insegnante o uno studente del corso specificato da courseId nella richiesta.
• La creazione, l'aggiornamento, l'eliminazione e il trasferimento dei voti degli allegati richiedono che l'utente essere un insegnante.
• Le chiamate a un post specifico di Google Classroom sono controllate da: controlli.
  • Quando un componente aggiuntivo ha già almeno un allegato in un post, può invia richieste per:
    • Convalida lancio iframe
    • Operazioni di lettura, aggiornamento ed eliminazione degli allegati
    • Aggiornamenti dei voti per quel post
  • Alla prima apertura dell'iframe di rilevamento dell'allegato, il componente aggiuntivo potrebbe non hanno ancora un allegato nel post. Un parametro di query addOnToken che può essere utilizzata per effettuare richieste relative a quanto segue:
    • Creazione di un allegato sotto il post (addOnToken obbligatorio)
    • Convalida del lancio (addOnToken viene convalidata se fornita ed è necessaria quando il componente aggiuntivo non ha un allegato esistente nella post)

Verifica OAuth

Nota: non puoi creare un video dimostrativo da inviare come parte della verifica OAuth. e il processo di sviluppo. Devi invece pubblicare il componente aggiuntivo senza verificare OAuth. In questo modo chiede al team di revisione di Google Workspace Marketplace di realizzare un video dimostrativo per conto tuo. Il team di revisione ti fornisce il video in modo che tu possa includilo nell'invio della verifica OAuth.

Un componente aggiuntivo di Classroom utilizza le API di Google per accedere all'account e i dati di Google Cloud.

• Verifica l'identità del tuo brand.
• Verifica gli ambiti OAuth sensibili.

Per ulteriori informazioni, consulta le Domande frequenti sulla verifica dell'API OAuth. procedura di verifica.

Scheda di Google Workspace Marketplace

Avviso: dopo aver salvato l'opzione di visibilità durante il processo di pubblicazione, non potrai modificare la tua selezione in un secondo momento.

Per informazioni generali sulla configurazione dell'SDK di Google Workspace Marketplace, visita la pagina Abilitare e configurare l'SDK di Google Workspace Marketplace e Crea una scheda dello Store di Google Workspace Marketplace.

Considerazioni sulle schede

Lo store SDK Marketplace del tuo progetto Google Cloud pubblico Scheda specifica il nome della tua applicazione e e descrizioni rivolte agli utenti finali. Puoi fornire questi dettagli in più lingue nella sezione Dettagli sull'app.

Segui queste linee guida nelle tue schede:

• In Dettagli sull'app:

  • Evita la punteggiatura nel nome dell'applicazione. Ad esempio, utilizza "Il mio componente aggiuntivo da La mia azienda" anziché "La mia azienda: il mio componente aggiuntivo" o "Il mio componente aggiuntivo, di Società".

  • La Descrizione breve e la Descrizione dettagliata non devono contenere esattamente lo stesso testo.

  + Assicurati di aver selezionato un valore per il campo Pricing (Prezzi). Questo include le opzioni per Senza costi, Pagato con una prova senza costi, Pagato con funzionalità senza costi e prezzi a pagamento. Non è necessario specificare il costo nella scheda di Marketplace.

  • Assicurati di aver selezionato un valore per il campo Categoria. Le Risorse accademiche o gli Strumenti per insegnanti e amministratori potrebbero essere ottime scelte per un componente aggiuntivo di Classroom.

  • Visualizza gli articoli elencati nell'App del Marketplace descrizione dettagliata per ulteriori informazioni.

Importante: controlla i dettagli dell'app per ogni lingua in cui offri il tuo come componente aggiuntivo.

• Nella sezione Risorse grafiche:

  • Le risorse grafiche fornite non sono sfocate e non soddisfano le dimensioni specificate negli standard di Google Workspace Marketplace

  • Tutti gli screenshot forniti sono rappresentazioni accurate del componente aggiuntivo un'esperienza ottimale.

• In Link per assistenza:

  • Assicurati di aver fornito un link ai Termini di servizio della tua applicazione servizio.

• Assicurati di rispettare le linee guida per il branding delle API di Google, che copre nomi e descrizioni consentiti.

• Se fai riferimento a qualsiasi prodotto Google nella tua scheda, utilizza il nome nella fornito nell'elenco dei marchi. Assicurati di includere i campi simbolo del marchio registrato (TM), se specificato; utilizza "Google DocsTM", non "Google documenti".

Eseguire l'integrazione con i servizi di licenze e fatturazione di Google

Se ti interessa consentire alle tue applicazioni di Google Workspace Marketplace integrare con i servizi di licenza e fatturazione di Google, visita l'API Marketplace.

Impostazioni di installazione

I componenti aggiuntivi possono consentire l'installazione singola oltre che per l'amministratore dell'installazione. Questa pagina evidenzia alcune differenze tra i due sistemi di installazione di testo. ma non è pensato per promuovere nessuno dei due tipi di installazione. Puoi scegliere se consentire l'installazione individuale nell'SDK di Google Workspace Marketplace pagina di configurazione dell'app.

Installazione come amministratore

Le installazioni per amministratori consentono a un amministratore di aggiungere un componente aggiuntivo a tutti di un dominio o a unità organizzative o gruppi di accesso specifici. Solo un amministratore di dominio può eseguire l'installazione da parte dell'amministratore. La l'amministratore può concedere il consenso a tutti gli ambiti di accesso per conto di tutti gli utenti nel dominio; agli utenti non viene richiesto di concedere il consenso a nessun ambito di accesso se l'amministratore sceglie di farlo.

Di seguito sono riportate alcune considerazioni relative all'installazione da parte degli amministratori.

• Controlli più rigorosi. Gli amministratori possono limitare gli utenti che possono accedere a un come componente aggiuntivo.
• Compatibilità con le licenze. Se la tua applicazione richiede una licenza, il canale delle installazioni tramite un amministratore può contribuire ad assicurare che vengono distribuite e utilizzate in modo appropriato con i dell'istituto.
• Meno carico per gli utenti finali. L'installazione da parte di un amministratore riduce per insegnanti e studenti. Ciò potrebbe garantire un'esperienza utente più fluida un'esperienza utente con meno clic e meno opportunità di confusione.

Vedi Installare le app del Marketplace nel dominio per ulteriori informazioni su come: Eseguire installazioni da parte degli amministratori e Funzionamento della struttura organizzativa. per saperne di più sulle unità organizzative e sui gruppi di accesso.

Installazione individuale

Le installazioni singole aggiungono un componente aggiuntivo all'account dell'utente. L'utente viene chiesto di concedere il consenso agli ambiti di accesso del componente aggiuntivo durante l'installazione.

Di seguito sono riportate alcune considerazioni relative alla singola installazione.

• Favorire l'adozione. Più utenti possono vedere e installare il tuo componente aggiuntivo dal Google Workspace Marketplace. L'autorizzazione per l'installazione individuale potrebbe richiedere più insegnanti ad adottare o sostenere il tuo prodotto.
• Test per gli amministratori. Un amministratore può installare singolarmente un componente aggiuntivo per testarlo o valutarlo prima di approvarlo o installarlo un gruppo più ampio.

Oltre a installare componenti aggiuntivi per conto degli utenti, gli amministratori possono anche una lista consentita per consentire agli utenti di installare componenti aggiuntivi che consentono dell'installazione. Se un componente aggiuntivo non è nella lista consentita, gli utenti possono comunque visualizzare il in Google Workspace Marketplace ma non riesci a installare add-on; viene visualizzato un messaggio che indica che il componente aggiuntivo non è stato consentita per l'installazione da parte di un amministratore di dominio. Vedi Gestire Google Workspace App del Marketplace inserite nella lista consentita per scoprire di più su questo comportamento.

Consulta la documentazione relativa alle impostazioni di installazione di Google Workspace Marketplace per ulteriori informazioni.

Integrazione app

Devi fornire un URL iframe di avvio nel campo URI di configurazione dell'allegato. Questo L'URL viene utilizzato come valore src iframe per l'iframe di rilevamento degli allegati. La L'iframe discovery degli allegati viene utilizzato dagli insegnanti per trovare contenuti o attività allegare al compito.

Devi inoltre specificare tutti i prefissi URI da cui sono consentiti gli allegati dal tuo componente aggiuntivo. Questa funzionalità aumenta la sicurezza impedendo agli allegati di da fonti non autorizzate.

Consulta la pagina della guida relativa agli iframe per ulteriori dettagli su questi campi.

Account di prova

Crea account di prova sul tuo dominio dimostrativo per verificare il corretto comportamento del tuo privato aggiuntivo. Sono necessari due account studente per verificare il passaggio da un account all'altro nell'iframe della revisione del lavoro dello studente.

Account di prova suggeriti:

• Insegnante Tammy, tammy.teacher@<dominio demo>
• Samuele Studente, sam.student@<il tuo dominio demo>
• Sally Studente, sally.student@<dominio demo>

Segui questa procedura per creare un nuovo account di test:

1. Accedi alla Console di amministrazione.
2. Vai a Utenti.
3. Fai clic su Aggiungi nuovo utente (vedi Figura 1).
4. Inserisci le informazioni dell'utente e assegna i ruoli appropriati.

Figura 1. Posizione del link Aggiungi nuovo utente all'interno di alla Console di amministrazione.

Segui questa procedura per creare un nuovo gruppo di test:

1. Accedi alla Console di amministrazione.
2. Vai a Gruppi.
3. Fai clic su Crea gruppo (vedi la Figura 2).
4. Inserisci i membri e i proprietari del gruppo.

Figura 2. Posizione del link Crea gruppo all'interno di alla Console di amministrazione.