API Reference

Esta referencia de la API está organizada por tipo de recurso. Cada tipo de recurso tiene una o más representaciones de datos y uno o más métodos.

Tipos de recursos

  1. Dispositivos
  2. Empresas
  3. Derechos
  4. Licencias grupales
  5. Usuario de licencia del grupo
  6. Instalaciones
  7. Configuración administrada para el dispositivo
  8. Parámetros de configuración administrados para el usuario
  9. Configuración administrada
  10. Permisos
  11. Productos
  12. Claves de la cuenta de servicio
  13. Storelayoutclusters
  14. Páginas de diseño de tienda
  15. Usuarios
  16. Apps web

Dispositivos

Para obtener más información sobre los recursos de dispositivos, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Sube un informe que contenga los cambios en los estados de la app en el dispositivo desde que se generó el último informe. Puedes llamar a este método hasta 3 veces cada 24 horas en un dispositivo determinado.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId Recupera los detalles de un dispositivo.
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state Recupera si el acceso de un dispositivo a los servicios de Google está habilitado o inhabilitado. El estado del dispositivo solo se aplica si la aplicación de políticas de EMM en dispositivos Android está habilitada en la Consola del administrador de Google. De lo contrario, el estado del dispositivo se ignora y todos los dispositivos tienen acceso a los servicios de Google. Esta opción solo se admite para los usuarios administrados por Google.
list GET  /enterprises/enterpriseId/users/userId/devices Recupera los ID de todos los dispositivos de un usuario.
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Establece si se habilita o inhabilita el acceso de un dispositivo a los servicios de Google. El estado del dispositivo solo se aplica si la aplicación de políticas de EMM en dispositivos Android está habilitada en la Consola del administrador de Google. De lo contrario, el estado del dispositivo se ignora y todos los dispositivos tienen acceso a los servicios de Google. Esta opción solo se admite para los usuarios administrados por Google.
actualización PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Actualiza la política de dispositivo.

Para asegurarte de que la política se aplique correctamente, debes evitar que las cuentas no administradas accedan a Google Play. Para ello, debes establecer allowed_accounts en la configuración administrada del paquete de Google Play. Consulta cómo restringir cuentas en Google Play.

Empresas

Para conocer los detalles de los recursos para empresas, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Reconoce las notificaciones que se recibieron de Enterprises.PullNotificationSet para evitar que las llamadas posteriores muestren las mismas notificaciones.
completeSignup POST  /enterprises/completeSignup Completa el flujo de registro especificando el token de finalización y el token Enterprise. Esta solicitud no se debe llamar varias veces para un token empresarial determinado.
createWebToken POST  /enterprises/enterpriseId/createWebToken Devuelve un token único para acceder a una IU integrable. Para generar una IU web, pasa el token generado a la API de JavaScript de Google Play administrado. Cada token solo se puede usar para iniciar una sesión de IU. Consulta la documentación de la API de JavaScript para obtener más información.
inscribirse POST  /enterprises/enroll Inscribe una empresa con el EMM que realiza la llamada.

Parámetros de consulta obligatorios: token

generateSignupUrl POST  /enterprises/signupUrl Genera una URL de registro.
get GET  /enterprises/enterpriseId Recupera el nombre y el dominio de una empresa.
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount Muestra una cuenta de servicio y credenciales. La cuenta de servicio se puede vincular a una empresa llamando a setAccount. La cuenta de servicio es exclusiva de esta empresa y de EMM, y se borrará si la empresa no está vinculada. Las credenciales contienen datos de clave privada y no se almacenan del lado del servidor.

Solo se puede llamar a este método después de llamar a Enterprises.Enroll o Enterprises.CompleteSignup, y antes que Enterprises.SetAccount. En otras ocasiones, se mostrará un error.

Las llamadas posteriores después de la primera generarán un conjunto de credenciales nuevo y único, lo que invalidará las credenciales generadas con anterioridad.

Una vez que la cuenta de servicio está vinculada a la empresa, se puede administrar con el recurso serviceAccountKeys.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Muestra el diseño de la tienda para la empresa. Si no se estableció el diseño de la tienda, muestra "básico" como el tipo de diseño y no muestra página principal.
list GET  /enterprises Busca una empresa por nombre de dominio. Esto solo es compatible con empresas creadas a través del flujo de creación iniciado por Google. La búsqueda del ID no es necesaria para las empresas creadas a través del flujo iniciado por EMM, ya que EMM aprende el ID empresarial en la devolución de llamada especificada en la llamada Enterprises.generateSignupUrl.

Parámetros de consulta obligatorios: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Extrae y muestra un conjunto de notificaciones para las empresas asociadas con la cuenta de servicio autenticada para la solicitud. Es posible que el conjunto de notificaciones esté vacío si no hay ninguna notificación pendiente.
Un conjunto de notificaciones que se muestra debe confirmarse en un plazo de 20 segundos mediante una llamada a Enterprises.AcknowledgeNotificationSet, a menos que el conjunto de notificaciones esté vacío.
Las notificaciones que no se confirmen en un plazo de 20 segundos se volverán a incluir en la respuesta a otra solicitud PullNotificationSet, y aquellas que nunca se confirmen se borrarán en última instancia según la política del sistema de Pub/Sub de Google Cloud Platform.
Se pueden realizar varias solicitudes de forma simultánea para recuperar notificaciones. En ese caso, las notificaciones pendientes (si las hay) se dividirán entre cada emisor, si hay alguno pendiente.
Si no hay notificaciones, se muestra una lista vacía. Es posible que las solicitudes posteriores muestren más notificaciones una vez que estén disponibles.
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification Envía una notificación de prueba para validar la integración de EMM en el servicio de Google Cloud Pub/Sub para esta empresa.
setAccount PUT  /enterprises/enterpriseId/account Establece la cuenta que se usará para autenticarse en la API como empresa.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Establece el diseño de la tienda para la empresa. De forma predeterminada, storeLayoutType está configurado como "básico" y está habilitado el diseño básico de la tienda. El diseño básico solo contiene apps aprobadas por el administrador que se agregaron al conjunto de productos disponible para un usuario (mediante la llamada setAvailableProductSet). Las apps de la página se ordenan por el valor del ID del producto. Si creas un diseño de tienda personalizado (configurando storeLayoutType = "custom" y configurando una página principal), se inhabilita el diseño básico de la tienda.
dar de baja POST  /enterprises/enterpriseId/unenroll Da de baja una empresa al EMM que realiza la llamada.

Autorizaciones

Para obtener más información sobre los recursos de derechos, consulta la página de representación de los recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Quita una autorización de una app para un usuario.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera los detalles de una autorización.
list GET  /enterprises/enterpriseId/users/userId/entitlements Enumera todos los derechos del usuario especificado. Solo se establece el ID.
actualización PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Agrega o actualiza un derecho en una app de un usuario.

Licencias grupales

Para conocer los detalles del recurso Grouplicenses, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Recupera los detalles de la licencia grupal de una empresa de un producto.
list GET  /enterprises/enterpriseId/groupLicenses Recupera los IDs de todos los productos para los que la empresa tiene una licencia grupal.

Usuarios con licencia del grupo

Para conocer los detalles del recurso Grouplicenseusers, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Recupera los ID de los usuarios a los que se les otorgaron derechos en virtud de la licencia.

Instalaciones

Para conocer los detalles del recurso de instalaciones, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Solicitudes para quitar una app de un dispositivo Una llamada a get o list seguirá mostrando la app como instalada en el dispositivo hasta que se quite.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Recupera los detalles de una instalación de una app en un dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Recupera los detalles de todas las apps instaladas en el dispositivo especificado.
actualización PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Solicita instalar la versión más reciente de una app en un dispositivo. Si ya está instalada, se actualiza a la versión más reciente si es necesario.

Configuraciones administradas del dispositivo

Para obtener más información sobre el recurso Managedconfigurationsfordevice, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Quita una configuración administrada por dispositivo de una app para el dispositivo especificado.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Recupera los detalles de una configuración administrada por dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice Enumera todas las configuraciones administradas por dispositivo para el dispositivo especificado. Solo se establece el ID.
actualización PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Agrega o actualiza una configuración administrada por dispositivo de una app para el dispositivo especificado.

Configuración administrada para el usuario

Para obtener más información sobre el recurso Managedconfigurationsforuser, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Quita una configuración administrada por usuario de una app destinada al usuario especificado.
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Recupera los detalles de una configuración administrada por usuario de una app para el usuario especificado.
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Enumera todas las configuraciones administradas por usuario para el usuario especificado. Solo se establece el ID.
actualización PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Agrega o actualiza los parámetros de configuración administrados de una app para el usuario especificado. Si admites el iframe de configuraciones administradas, puedes aplicar configuraciones administradas a un usuario especificando un mcmId y sus variables de configuración asociadas (si las hubiera) en la solicitud. Como alternativa, todos los EMM pueden aplicar una configuración administrada si pasan una lista de propiedades administradas.

Configuración administrada

Para obtener más información sobre el recurso Managedconfigurationssettings, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Muestra una lista de todos los parámetros de configuración administrados de la app especificada.

Permisos

Para obtener más información sobre los recursos de permisos, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
get GET  /permissions/permissionId Recupera los detalles de un permiso de app para Android para mostrárselos a un administrador empresarial.

Productos

Para obtener más información sobre los recursos de productos, consulta la página de representación de los recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
aprobar POST  /enterprises/enterpriseId/products/productId/approve

Aprueba el producto especificado y los permisos relevantes de la app, si los hay. La cantidad máxima de productos que puedes aprobar por cliente empresarial es de 1,000.

Si quieres aprender a usar Google Play administrado para diseñar y crear un diseño de tienda a fin de mostrar productos aprobados a los usuarios, consulta Diseño de la tienda.

generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Genera una URL que se puede renderizar en un iframe para mostrar los permisos (si los hay) de un producto. Un administrador empresarial debe ver estos permisos y aceptarlos en nombre de su organización para aprobar ese producto.

Los administradores deben aceptar los permisos que se muestran interactuando con un elemento de la IU separado en la consola de EMM, lo que, a su vez, debería activar el uso de esta URL como la propiedad approvalUrlInfo.approvalUrl en una llamada a Products.approve para aprobar el producto. Esta URL solo se puede usar para mostrar los permisos durante 1 día como máximo.
get GET  /enterprises/enterpriseId/products/productId Recupera detalles de un producto para mostrar a un administrador empresarial.
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Recupera el esquema que define las propiedades configurables de este producto. Todos los productos tienen un esquema, pero este puede estar vacío si no se definió ninguna configuración administrada. Este esquema se puede usar para propagar una IU que permita que un administrador configure el producto. Para aplicar una configuración administrada según el esquema obtenido con esta API, consulta Configuraciones administradas a través de Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera los permisos de las apps para Android que requiere esta app.
list GET  /enterprises/enterpriseId/products Encuentra productos aprobados que coinciden con una consulta o todos los productos aprobados si no hay una consulta.
no aprobar POST  /enterprises/enterpriseId/products/productId/unapprove No aprueba el producto especificado (y los permisos relevantes de la app, si los hubiera).

Claves de la cuenta de servicio

Para obtener más información sobre los recursos Serviceaccountkeys, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Quita e invalida las credenciales especificadas para la cuenta de servicio asociada con esta empresa. La cuenta de servicio de llamadas debe haberse recuperado llamando a Enterprises.GetServiceAccount y debe haberse establecido como la cuenta de servicio empresarial llamando a Enterprises.SetAccount.
insertar POST  /enterprises/enterpriseId/serviceAccountKeys Genera credenciales nuevas para la cuenta de servicio asociada con esta empresa. La cuenta de servicio de llamadas debe haberse recuperado llamando a Enterprises.GetServiceAccount y se debe haber configurado como la cuenta de servicio empresarial llamando a Enterprises.SetAccount.

Solo el tipo de clave debe propagarse en el recurso que se insertará.
list GET  /enterprises/enterpriseId/serviceAccountKeys Enumera todas las credenciales activas de la cuenta de servicio asociada con esta empresa. Solo se muestran el ID y el tipo de clave. La cuenta de servicio de llamadas debe haberse recuperado llamando a Enterprises.GetServiceAccount y se debe haber configurado como la cuenta de servicio empresarial llamando a Enterprises.SetAccount.

Storelayoutclusters

Para obtener los detalles del recurso Storelayoutclusters, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Borra un clúster.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Recupera los detalles de un clúster.
insertar POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Inserta un clúster nuevo en una página.
list GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Recupera los detalles de todos los clústeres de la página especificada.
actualización PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Actualiza un clúster.

Páginasdediseñodetiendas

Para obtener los detalles del recurso Storelayoutpages, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Borra una página de la tienda.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId Recupera los detalles de una página de tienda.
insertar POST  /enterprises/enterpriseId/storeLayout/pages Inserta una nueva página de tienda.
list GET  /enterprises/enterpriseId/storeLayout/pages Recupera los detalles de todas las páginas de la tienda.
actualización PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Actualiza el contenido de una página de la tienda.

Usuarios

Para obtener más información sobre los recursos de usuarios, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId Borraste un usuario administrado por EMM.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Genera un token de autenticación que el cliente de política de dispositivo puede usar para aprovisionar la cuenta de usuario determinada administrada por EMM en un dispositivo. El token generado es de un solo uso y expira después de unos minutos.

Puedes aprovisionar un máximo de 10 dispositivos por usuario.

Esta llamada solo funciona con cuentas administradas por EMM.
get GET  /enterprises/enterpriseId/users/userId Recupera los detalles de un usuario.
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet Recupera el conjunto de productos a los que un usuario tiene derecho a acceder.
insertar POST  /enterprises/enterpriseId/users Crea un nuevo usuario administrado por EMM.

El recurso Users que se pasó en el cuerpo de la solicitud debe incluir accountIdentifier y accountType.

Si un usuario correspondiente ya existe con el mismo identificador de cuenta, el usuario se actualizará con el recurso. En este caso, solo se puede cambiar el campo displayName.

list GET  /enterprises/enterpriseId/users Busca un usuario por su dirección de correo electrónico principal. Esta opción solo se admite para los usuarios administrados por Google. Los usuarios administrados por EMM no necesitan buscar el ID porque el ID ya se muestra como resultado de la llamada Users.insert.

Parámetros de consulta obligatorios: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Revoca el acceso a todos los dispositivos aprovisionados actualmente al usuario. El usuario ya no podrá usar Play Store administrado en ninguno de sus dispositivos administrados.

Esta llamada solo funciona con cuentas administradas por EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Modifica el conjunto de productos a los que un usuario tiene derecho a acceder (denominados productos whitelisted). Solo se pueden incluir en la lista blanca los productos que están aprobados o los que se aprobaron con anterioridad (productos con aprobación revocada).
actualización PUT  /enterprises/enterpriseId/users/userId Actualiza los detalles de un usuario administrado por EMM.

Solo se puede usar con usuarios administrados por EMM (no con usuarios administrados por Google). Pasa los detalles nuevos en el recurso Usuarios en el cuerpo de la solicitud. Solo se puede cambiar el campo displayName. Otros campos deben no estar configurados o tener el valor activo en ese momento.

Apps web

Para obtener más información sobre los recursos de apps web, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/webApps/webAppId Borra una app web existente.
get GET  /enterprises/enterpriseId/webApps/webAppId Obtiene una app web existente.
insertar POST  /enterprises/enterpriseId/webApps Crea una app web nueva para la empresa.
list GET  /enterprises/enterpriseId/webApps Recupera los detalles de todas las aplicaciones web de una empresa determinada.
actualización PUT  /enterprises/enterpriseId/webApps/webAppId Actualiza una app web existente.