API Reference

Questo riferimento API è organizzato in base al 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. Aziende
  3. Diritti
  4. Grouplicenses
  5. Grouplicenseusers
  6. Installazioni
  7. Managedconfigurationsfordevice
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. Autorizzazioni
  11. Prodotti
  12. Serviceaccountkeys
  13. Storelayoutclusters
  14. Storelayoutpages
  15. Utenti
  16. App web

Dispositivi

Per i dettagli della 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 eventuali modifiche degli 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 ai servizi Google di un dispositivo è attivo o disattivato. Lo stato del dispositivo viene applicato solo se l'applicazione dei criteri EMM sui dispositivi Android è attivata nella Console di amministrazione Google. In caso contrario, lo stato del dispositivo viene ignorato e a tutti i dispositivi viene consentito l'accesso ai servizi Google. Questa opzione è 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 ai servizi Google di un dispositivo è attivo o disattivato. Lo stato del dispositivo viene applicato solo se l'applicazione dei criteri EMM sui dispositivi Android è attivata nella Console di amministrazione Google. In caso contrario, lo stato del dispositivo viene ignorato e a tutti i dispositivi viene consentito l'accesso ai servizi Google. Questa opzione è supportata solo per gli utenti gestiti da Google.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Aggiorna i criteri del dispositivo.

Per assicurarti che il criterio venga applicato correttamente, 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 su come limitare gli account su Google Play.

Aziende

Per i dettagli della risorsa per le aziende, consulta la pagina Rappresentazione della risorsa.

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

Parametri di query obbligatori: token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl Genera un URL di upgrade aziendale per eseguire l'upgrade di account Google Play gestiti per l'azienda esistenti a un dominio Google gestito.

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 account di servizio e le credenziali. L'account di servizio puoi essere associato all'azienda chiamando setAccount. L'account di servizio è univoco per questa azienda e per questo provider EMM e verrà eliminato se l'azienda non è associata. Le credenziali contengono dati della chiave privata e non vengono memorizzate sul lato server.

Questo metodo può essere chiamato solo dopo aver chiamato Enterprises.Enroll o Enterprises.CompleteSignup e prima di Enterprises.SetAccount; in altri casi 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, l'account di servizio può essere gestito utilizzando la risorsa serviceAccountKeys.

.

.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Restituisce il layout del negozio per l'azienda. Se il layout del negozio non è stato impostato, viene restituito "base" come tipo di layout del negozio e non viene visualizzata alcuna home page.
list GET  /enterprises Cerca un'azienda tramite il nome di dominio. Questa opzione è 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 dall'EMM, poiché l'EMM acquisisce l'ID azienda nel callback specificato nella chiamata Enterprises.generateSignupUrl.

Parametri di query obbligatori: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Estrae e restituisce un insieme di notifiche per le aziende associate all'account di servizio autenticato per la richiesta. L'insieme di notifiche può 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 il insieme di notifiche non sia vuoto.
Le notifiche che non vengono confermate entro 20 secondi verranno nuovamente incluse nella risposta a un'altra richiesta PullNotificationSet e quelle che non vengono mai confermate verranno infine eliminate in base alle norme del sistema Pub/Sub della piattaforma Google Cloud.
Per recuperare le notifiche potrebbero essere eseguite più richieste contemporaneamente, nel qual caso le notifiche in attesa (se presenti) verranno suddivise tra ciascun chiamante.
Se non sono presenti notifiche, viene restituito un elenco di notifiche vuoto. Le richieste successive potrebbero restituire altre notifiche non appena diventano disponibili.
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification Invia una notifica di prova per convalidare l'integrazione di EMM con il servizio Google Cloud Pub/Sub per l'azienda.
setAccount PUT  /enterprises/enterpriseId/account Imposta l'account che verrà utilizzato per autenticarsi nell'API come azienda.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Imposta il layout del negozio per l'azienda. Per impostazione predefinita, il valore di storeLayoutType è impostato su "base" e il layout della vetrina di base è attivato. Il layout di base contiene solo le app approvate dall'amministratore e aggiunte all'insieme di prodotti disponibili per un utente (utilizzando la chiamata setAvailableProductSet). Le app nella pagina sono ordinate in base al valore del loro ID prodotto. Se crei un layout della vetrina personalizzato (impostando storeLayoutType = "custom" e impostando una home page), il layout della vetrina di base viene disattivato.
annullare la registrazione POST  /enterprises/enterpriseId/unenroll Annullare la registrazione di un'azienda dal provider EMM che effettua la chiamata.

Diritti

Per i dettagli della risorsa Diritti, 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 Consente di rimuovere un diritto a un'app per un utente.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupero 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.
update PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Aggiungi o aggiorna un diritto a un'app per un utente.

Grouplicenses

Per i dettagli della risorsa Grouplicenses, 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  /enterprises/enterpriseId/groupLicenses/groupLicenseId Recupero dei dettagli della licenza di gruppo di un'azienda per un prodotto.
list GET  /enterprises/enterpriseId/groupLicenses Recupero degli ID di tutti i prodotti per i quali l'azienda dispone di una licenza di gruppo.

Grouplicenseusers

Per i dettagli della risorsa Grouplicenseusers, 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/groupLicenses/groupLicenseId/users Recupero degli ID degli utenti a cui sono stati concessi i diritti previsti dalla licenza.

Installazioni

Per i dettagli sulla risorsa Installazioni, 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/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 viene effettivamente rimossa.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Recupero dei dettagli di un'installazione di un'app su un dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Recupero dei dettagli di tutte le app installate sul dispositivo specificato.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Richiede di installare la versione più recente 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, vedi 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 Recupero dei 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.
update 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 della risorsa Managedconfigurationsforuser, vedi 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 Recupero dei 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. È impostato solo l'ID.
update PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Aggiungi 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 le configurazioni gestite passando un elenco di proprietà gestite.

Managedconfigurationssettings

Per i dettagli della risorsa Managedconfigurationssettings, vedi 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 delle configurazioni gestite per l'app specificata.

Autorizzazioni

Per i dettagli sulla risorsa Permissions, 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 della 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
approve POST  /enterprises/enterpriseId/products/productId/approve

Approva il prodotto specificato e le autorizzazioni 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 agli utenti, consulta Design 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 poter approvare il prodotto.

Gli amministratori devono accettare le autorizzazioni visualizzate interagisce con un elemento dell'interfaccia utente 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 per visualizzare le autorizzazioni solo 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 Recupero dello schema che definisce le proprietà configurabili per questo prodotto. Tutti i prodotti hanno uno schema, che potrebbe essere vuoto se non sono state definite configurazioni gestite. Questo schema può essere utilizzato per compilare un'interfaccia utente che consente a un amministratore di configurare il prodotto. Per applicare una configurazione gestita in base allo schema ottenuto utilizzando questa API, consulta Configurazioni gestite tramite Google Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupero delle autorizzazioni per le app Android richieste da questa app.
list GET  /enterprises/enterpriseId/products Trova i prodotti approvati corrispondenti a una query o tutti i prodotti approvati se non è presente alcuna query.
non approvare POST  /enterprises/enterpriseId/products/productId/unapprove Annulla l'approvazione del prodotto specificato (e delle autorizzazioni 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 convalida le credenziali specificate per l'account di servizio associato a questa azienda. L'account di servizio chiamante deve essere stato recuperato chiamando Enterprises.GetServiceAccount e deve essere stato impostato come account di servizio aziendale chiamando Enterprises.SetAccount.
insert POST  /enterprises/enterpriseId/serviceAccountKeys Genera nuove credenziali per l'account di servizio associato a questa impresa. L'account di servizio chiamante deve essere stato recuperato chiamando Enterprises.GetServiceAccount e deve essere stato impostato come account di servizio 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 l'account di servizio associato a questa impresa. 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 account di servizio aziendale chiamando Enterprises.SetAccount.

Storelayoutclusters

Per i dettagli della risorsa Storelayoutclusters, 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/storeLayout/pages/pageId/clusters/clusterId Consente di eliminare 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.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Aggiorna un cluster.

Storelayoutpages

Per i dettagli della risorsa Storelayoutpages, 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/storeLayout/pages/pageId Consente di eliminare 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 del negozio.
list GET  /enterprises/enterpriseId/storeLayout/pages Recupera i dettagli di tutte le pagine del negozio.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Aggiorna i contenuti di una pagina del negozio.

Utenti

Per i dettagli della risorsa Utenti, 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 eseguire il provisioning del determinato account utente gestito da EMM 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 Recupero dell'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 Users passata nel corpo della richiesta deve includere un accountIdentifier e un accountType.

Se esiste già un utente corrispondente con lo stesso identificatore 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 opzione è 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 configurati 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 (chiamati prodotti nella lista consentita). Solo i prodotti approvati o quelli approvati in precedenza (prodotti con approvazione revocata) possono essere inseriti nella lista consentita.
update PUT  /enterprises/enterpriseId/users/userId Aggiorna i dettagli di un utente gestito da EMM.

Può essere utilizzato solo con gli utenti gestiti da EMM (non con gli utenti gestiti da Google). Passa 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 web app, 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/webApps/webAppId Consente di eliminare 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 app web per una determinata azienda.
update PUT  /enterprises/enterpriseId/webApps/webAppId Aggiorna un'app web esistente.