API Reference

Questo riferimento API è organizzato per tipo di risorsa. Ogni tipo di risorsa ha una o più rappresentazioni dei dati e uno o più metodi.

Tipi di risorse

  1. Dispositivi
  2. Enrollmenttokens
  3. Aziende
  4. Diritti
  5. Licenze di gruppo
  6. Grouplicenseusers
  7. Installazioni
  8. Managedconfigurationsfordevice
  9. Managedconfigurationsforuser
  10. Managedconfigurationssettings
  11. Autorizzazioni
  12. Prodotti
  13. Serviceaccountkeys
  14. Storelayoutclusters
  15. Storelayoutpages
  16. Utenti
  17. Webapp

Dispositivi

Per i dettagli sulla risorsa Devices, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Carica un report contenente le modifiche apportate agli stati delle app sul dispositivo dall'ultima generazione del report. Puoi chiamare questo metodo fino a 3 volte ogni 24 ore per un determinato dispositivo.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId Recupera i dettagli di un dispositivo.
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state Recupera se l'accesso di un dispositivo ai servizi Google è attivato o disattivato. Lo stato del dispositivo ha effetto solo se l'applicazione forzata dei criteri EMM sui dispositivi Android è abilitata nella Console di amministrazione Google. In caso contrario, lo stato del dispositivo viene ignorato e a tutti i dispositivi è consentito l'accesso ai servizi Google. Questa funzionalità è supportata solo per gli utenti gestiti da Google.
list GET  /enterprises/enterpriseId/users/userId/devices Recupera gli ID di tutti i dispositivi di un utente.
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Imposta se l'accesso di un dispositivo ai servizi Google è attivato o disattivato. Lo stato del dispositivo ha effetto solo se l'applicazione forzata dei criteri EMM sui dispositivi Android è abilitata nella Console di amministrazione Google. In caso contrario, lo stato del dispositivo viene ignorato e a tutti i dispositivi è consentito l'accesso ai servizi Google. Questa funzionalità è supportata solo per gli utenti gestiti da Google.
aggiornamento PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Aggiorna le norme relative ai dispositivi.

Per garantire l'applicazione corretta delle norme, devi impedire agli account non gestiti di accedere a Google Play impostando allowed_accounts nella configurazione gestita per il pacchetto Google Play. Consulta la sezione Limitare gli account su Google Play.

Enrollmenttokens

Per i dettagli sulla risorsa Enrollmenttokens, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
crea POST  /enterprises/enterpriseId/enrollmentTokens Crea un token di registrazione per l'azienda. Questo metodo fa parte di EnrollmentTokensService.

Aziende

Per i dettagli sulle risorse aziendali, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Riconosce le notifiche ricevute da Enterprises.PullNotificationSet per impedire che le chiamate successive restituiscano le stesse notifiche.
completeSignup POST  /enterprises/completeSignup Completa il flusso di registrazione specificando il token di completamento e il token aziendale. Questa richiesta non deve essere chiamata più volte per un determinato token aziendale.
createWebToken POST  /enterprises/enterpriseId/createWebToken Restituisce un token univoco per accedere a una UI incorporabile. Per generare un'interfaccia utente web, passa il token generato all'API JavaScript di Google Play gestito. Ogni token può essere utilizzato per avviare una sola sessione dell'interfaccia utente. Per ulteriori informazioni, consulta la documentazione dell'API JavaScript.
enroll POST  /enterprises/enroll Registra un'azienda con l'EMM chiamante.

Parametri di query obbligatori: token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl Genera un URL di upgrade dell'azienda per eseguire l'upgrade di un'azienda con account Google Play gestiti esistente a un dominio Google gestito. Per maggiori dettagli, consulta la guida all'upgrade di un'azienda.
generateSignupUrl POST  /enterprises/signupUrl Genera un URL di registrazione.
get GET  /enterprises/enterpriseId Recupera il nome e il dominio di un'azienda.
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount Restituisce un service account e le relative credenziali. Il service account può essere associato all'azienda chiamando setAccount. Il service account è univoco per questa azienda ed EMM e verrà eliminato se l'azienda viene scollegata. Le credenziali contengono dati della chiave privata e non vengono archiviate sul server.

Questo metodo può essere chiamato solo dopo aver chiamato Enterprises.Enroll o Enterprises.CompleteSignup e prima di Enterprises.SetAccount; in altri momenti restituirà un errore.

Le chiamate successive alla prima genereranno un nuovo insieme univoco di credenziali e invalideranno quelle generate in precedenza.

Una volta associato all'azienda, il service account può essere gestito utilizzando la risorsa serviceAccountKeys.

.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Restituisce il layout dello store per l'azienda. Se il layout dello store non è stato impostato, restituisce "basic" come tipo di layout dello store e nessuna homepage.
list GET  /enterprises Cerca un'azienda in base al nome di dominio. Questa funzionalità è supportata solo per le aziende create tramite il flusso di creazione avviato da Google. La ricerca dell'ID non è necessaria per le aziende create tramite il flusso avviato da EMM, poiché EMM apprende l'ID azienda nel callback specificato nella chiamata Enterprises.generateSignupUrl.

Parametri di query obbligatori: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Recupera e restituisce un insieme di notifiche per le aziende associate all'account di servizio autenticato per la richiesta. Il set di notifiche potrebbe essere vuoto se non sono presenti notifiche in attesa.
Un insieme di notifiche restituito deve essere confermato entro 20 secondi chiamando Enterprises.AcknowledgeNotificationSet, a meno che l'insieme di notifiche non sia vuoto.
Le notifiche che non vengono riconosciute entro 20 secondi verranno nuovamente incluse nella risposta a un'altra richiesta PullNotificationSet e quelle che non vengono mai riconosciute verranno eliminate in base alle norme del sistema Google Cloud Pub/Sub.
Potrebbero essere eseguite più richieste contemporaneamente per recuperare le notifiche, nel qual caso le notifiche in attesa (se presenti) verranno suddivise tra i vari chiamanti, se presenti.
Se non sono presenti notifiche, viene restituito un elenco di notifiche vuoto. Le richieste successive potrebbero restituire più notifiche una volta disponibili.
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification Invia una notifica di test per convalidare l'integrazione EMM con il servizio Google Cloud Pub/Sub per questa azienda.
setAccount PUT  /enterprises/enterpriseId/account Imposta l'account che verrà utilizzato per l'autenticazione all'API come organizzazione.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Imposta il layout dello store per l'azienda. Per impostazione predefinita, storeLayoutType è impostato su "basic" e il layout di base del negozio è attivato. Il layout di base contiene solo le app approvate dall'amministratore e aggiunte al set di prodotti disponibili per un utente (utilizzando la chiamata setAvailableProductSet). Le app nella pagina sono ordinate in base al valore dell'ID prodotto. Se crei un layout dello Store personalizzato (impostando storeLayoutType = "custom" e impostando una home page), il layout dello Store di base viene disattivato.
annullare la registrazione POST  /enterprises/enterpriseId/unenroll Annulla la registrazione di un'azienda all'EMM per le chiamate.

Diritti

Per i dettagli sulla risorsa Entitlements, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Rimuove un diritto a un'app per un utente.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera i dettagli di un diritto.
list GET  /enterprises/enterpriseId/users/userId/entitlements Elenca tutti i diritti per l'utente specificato. Viene impostato solo l'ID.
aggiornamento PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Aggiunge o aggiorna un diritto per un'app per un utente.

Grouplicenses

Per i dettagli sulla risorsa Grouplicenses, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Recupera i dettagli della licenza di gruppo di un'azienda per un prodotto.
list GET  /enterprises/enterpriseId/groupLicenses Recupera gli ID di tutti i prodotti per i quali l'azienda dispone di una licenza di gruppo.

Grouplicenseusers

Per i dettagli sulla risorsa Grouplicenseusers, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Recupera gli ID degli utenti a cui sono stati concessi diritti nell'ambito della licenza.

Installazioni

Per i dettagli sulla risorsa Installazioni, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Richieste di rimozione di un'app da un dispositivo. Una chiamata a get o list mostrerà comunque l'app come installata sul dispositivo finché non verrà effettivamente rimossa.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Recupera i dettagli di un'installazione di un'app su un dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Recupera i dettagli di tutte le app installate sul dispositivo specificato.
aggiornamento PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Richieste di installazione dell'ultima versione di un'app su un dispositivo. Se l'app è già installata, viene aggiornata all'ultima versione, se necessario.

Managedconfigurationsfordevice

Per i dettagli della risorsa Managedconfigurationsfordevice, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Rimuove una configurazione gestita per dispositivo per un'app per il dispositivo specificato.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Recupera i dettagli di una configurazione gestita per dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice Elenca tutte le configurazioni gestite per dispositivo per il dispositivo specificato. Viene impostato solo l'ID.
aggiornamento PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Aggiunge o aggiorna una configurazione gestita per dispositivo per un'app per il dispositivo specificato.

Managedconfigurationsforuser

Per i dettagli sulla risorsa Managedconfigurationsforuser, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Rimuove una configurazione gestita per utente per un'app per l'utente specificato.
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Recupera i dettagli di una configurazione gestita per utente per un'app per l'utente specificato.
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Elenca tutte le configurazioni gestite per utente per l'utente specificato. Viene impostato solo l'ID.
aggiornamento PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Aggiunge o aggiorna le impostazioni di configurazione gestita per un'app per l'utente specificato. Se supporti l'iframe delle configurazioni gestite, puoi applicare le configurazioni gestite a un utente specificando un mcmId e le relative variabili di configurazione (se presenti) nella richiesta. In alternativa, tutti gli EMM possono applicare configurazioni gestite passando un elenco di proprietà gestite.

Managedconfigurationssettings

Per i dettagli sulla risorsa Managedconfigurationssettings, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Elenca tutte le impostazioni di configurazione gestita per l'app specificata.

Autorizzazioni

Per i dettagli sulla risorsa Autorizzazioni, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
get GET  /permissions/permissionId Recupera i dettagli di un'autorizzazione app per Android da mostrare a un amministratore aziendale.

Prodotti

Per i dettagli sulla risorsa Prodotti, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
approvare POST  /enterprises/enterpriseId/products/productId/approve

Approva il prodotto specificato e le autorizzazioni dell'app pertinenti, se presenti. Il numero massimo di prodotti che puoi approvare per cliente aziendale è 1000.

Per scoprire come utilizzare la versione gestita di Google Play per progettare e creare un layout dello Store per mostrare i prodotti approvati ai tuoi utenti, consulta Progettazione del layout dello Store.
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Genera un URL che può essere visualizzato in un iframe per mostrare le autorizzazioni (se presenti) di un prodotto. Un amministratore aziendale deve visualizzare queste autorizzazioni e accettarle per conto della propria organizzazione per approvare il prodotto.

Gli amministratori devono accettare le autorizzazioni visualizzate interagendo con un elemento UI separato nella console EMM, che a sua volta deve attivare l'utilizzo di questo URL come proprietà approvalUrlInfo.approvalUrl in una chiamata Products.approve per approvare il prodotto. Questo URL può essere utilizzato solo per visualizzare le autorizzazioni per un massimo di un giorno.
get GET  /enterprises/enterpriseId/products/productId Recupera i dettagli di un prodotto da mostrare a un amministratore aziendale.
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Recupera lo schema che definisce le proprietà configurabili per questo prodotto. Tutti i prodotti hanno uno schema, ma questo schema potrebbe essere vuoto se non sono state definite configurazioni gestite. Questo schema può essere utilizzato per compilare una UI che consente a un amministratore di configurare il prodotto. Per applicare una configurazione gestita in base allo schema ottenuto utilizzando questa API, vedi Configurazioni gestite tramite Google Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera le autorizzazioni app per Android richieste da questa app.
list GET  /enterprises/enterpriseId/products Trova i prodotti approvati che corrispondono a una query o tutti i prodotti approvati se non è presente alcuna query.
unapprove POST  /enterprises/enterpriseId/products/productId/unapprove Annulla l'approvazione del prodotto specificato (e delle autorizzazioni dell'app pertinenti, se presenti)

Serviceaccountkeys

Per i dettagli della risorsa Serviceaccountkeys, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Rimuove e invalida le credenziali specificate per il service account associato a questa azienda. L'account di servizio chiamante deve essere stato recuperato chiamando Enterprises.GetServiceAccount e deve essere stato impostato come service account aziendale chiamando Enterprises.SetAccount.
insert POST  /enterprises/enterpriseId/serviceAccountKeys Genera nuove credenziali per il service account associato a questa azienda. Il service account del servizio di chiamata deve essere stato recuperato chiamando Enterprises.GetServiceAccount e deve essere stato impostato come service account dell'azienda chiamando Enterprises.SetAccount.

Nella risorsa da inserire deve essere compilato solo il tipo di chiave.
list GET  /enterprises/enterpriseId/serviceAccountKeys Elenca tutte le credenziali attive per il service account associato a questa organizzazione. Vengono restituiti solo l'ID e il tipo di chiave. L'account del servizio di chiamata deve essere stato recuperato chiamando Enterprises.GetServiceAccount e deve essere stato impostato come service account aziendale chiamando Enterprises.SetAccount.

Storelayoutclusters

Per i dettagli della risorsa Storelayoutclusters, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Elimina un cluster.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Recupera i dettagli di un cluster.
insert POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Inserisce un nuovo cluster in una pagina.
list GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Recupera i dettagli di tutti i cluster nella pagina specificata.
aggiornamento PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Aggiorna un cluster.

Storelayoutpages

Per i dettagli della risorsa Storelayoutpages, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Elimina una pagina del negozio.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId Recupera i dettagli di una pagina dello Store.
insert POST  /enterprises/enterpriseId/storeLayout/pages Inserisce una nuova pagina dello store.
list GET  /enterprises/enterpriseId/storeLayout/pages Recupera i dettagli di tutte le pagine dello store.
aggiornamento PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Aggiorna i contenuti di una pagina dello Store.

Utenti

Per i dettagli sulla risorsa Users, consulta la pagina Rappresentazione della risorsa.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/users/userId È stato eliminato un utente gestito da EMM.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Genera un token di autenticazione che il client dei criteri relativi ai dispositivi può utilizzare per provisionare l'account utente gestito dall'EMM specificato su un dispositivo. Il token generato è monouso e scade dopo pochi minuti.

Puoi eseguire il provisioning di un massimo di 10 dispositivi per utente.

Questa chiamata funziona solo con gli account gestiti da EMM.
get GET  /enterprises/enterpriseId/users/userId Recupera i dettagli di un utente.
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet Recupera l'insieme di prodotti a cui un utente ha diritto di accedere.
insert POST  /enterprises/enterpriseId/users Crea un nuovo utente gestito da EMM.

La risorsa Utenti trasmessa nel corpo della richiesta deve includere un accountIdentifier e un accountType.

Se esiste già un utente corrispondente con lo stesso identificatore dell'account, l'utente verrà aggiornato con la risorsa. In questo caso, è possibile modificare solo il campo displayName.
list GET  /enterprises/enterpriseId/users Cerca un utente in base all'indirizzo email principale. Questa funzionalità è supportata solo per gli utenti gestiti da Google. La ricerca dell'ID non è necessaria per gli utenti gestiti da EMM perché l'ID viene già restituito nel risultato della chiamata Users.insert.

Parametri di query obbligatori: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Revoca l'accesso a tutti i dispositivi attualmente sottoposti a provisioning per l'utente. L'utente non potrà più utilizzare il Play Store gestito su nessuno dei suoi dispositivi gestiti.

Questa chiamata funziona solo con gli account gestiti da EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Modifica l'insieme di prodotti a cui un utente ha diritto di accedere (denominati prodotti in whitelist). Solo i prodotti approvati o i prodotti precedentemente approvati (prodotti con approvazione revocata) possono essere inseriti nella lista consentita.
aggiornamento PUT  /enterprises/enterpriseId/users/userId Aggiorna i dettagli di un utente gestito da EMM.

Può essere utilizzato solo con utenti gestiti da EMM (non utenti gestiti da Google). Trasferisci i nuovi dettagli nella risorsa Users nel corpo della richiesta. È possibile modificare solo il campo displayName. Gli altri campi devono essere non impostati o avere il valore attualmente attivo.

App web

Per i dettagli sulle risorse delle web app, consulta la pagina Rappresentazione delle risorse.

Metodo Richiesta HTTP Descrizione
URI relativi a https://www.googleapis.com/androidenterprise/v1, se non diversamente indicato
elimina DELETE  /enterprises/enterpriseId/webApps/webAppId Elimina un'app web esistente.
get GET  /enterprises/enterpriseId/webApps/webAppId Recupera un'app web esistente.
insert POST  /enterprises/enterpriseId/webApps Crea una nuova app web per l'azienda.
list GET  /enterprises/enterpriseId/webApps Recupera i dettagli di tutte le web app per un'azienda specifica.
aggiornamento PUT  /enterprises/enterpriseId/webApps/webAppId Aggiorna un'app web esistente.