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. Grouplicenses
  5. Grouplicenseusers
  6. Instalaciones
  7. Managedconfigurationsfordevice
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. Permisos
  11. Productos
  12. Claves de cuenta de servicio
  13. Storelayoutclusters
  14. Storelayoutpages
  15. Usuarios
  16. Apps web

Dispositivos

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

Método Solicitud HTTP Descripción
URI relacionados con 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 contiene 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 para 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, se ignorará el estado del dispositivo y todos los dispositivos podrán acceder a los servicios de Google. Solo se admite en el caso de los usuarios administrados por Google.
list GET  /enterprises/enterpriseId/users/userId/devices Recupera los IDs 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, se ignorará el estado del dispositivo y todos los dispositivos podrán acceder a los servicios de Google. Solo se admite en el caso de los usuarios administrados por Google.
actualizar PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Actualiza la política de dispositivo.

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

Empresas

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

Método Solicitud HTTP Descripción
URI relacionados con 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 mediante la especificación del token de finalización y el token de Enterprise. No se debe llamar a esta solicitud varias veces para un token empresarial determinado.
createWebToken POST  /enterprises/enterpriseId/createWebToken Muestra 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 a una empresa en 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 la empresa con una llamada 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 en el servidor.

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

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

Una vez que la cuenta de servicio está vinculada a la empresa, se puede administrar mediante el recurso serviceAccountKeys.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Muestra el diseño de la tienda para la empresa. Si no se configuró el diseño de la tienda, muestra "basic" como el tipo de diseño y sin 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. Las empresas creadas a través del flujo iniciado con EMM no necesitan la búsqueda del ID, ya que este último 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. La notificación configurada puede estar vacía si no hay ninguna notificación pendiente.
Si se muestra un conjunto de notificaciones, se debe confirmar en un plazo de 20 segundos mediante una llamada a Enterprises.RecognizeNotificationSet, a menos que el conjunto de notificaciones esté vacío.
Las notificaciones que no se confirman en los 20 segundos más adelante se incluirán de nuevo en la respuesta a otra solicitud PullNotificationSet y, en última instancia, las que nunca se confirman se borrarán según la política del sistema Pub/Sub de Google Cloud Platform.
Se pueden realizar varias solicitudes de forma simultánea para recuperar notificaciones, en cuyo caso las notificaciones pendientes (si las hay) se dividirán entre cada emisor, si es que alguna está pendiente.
Si no hay notificaciones presentes, se muestra una lista de notificaciones 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 con el servicio de Google Cloud Pub/Sub para esta empresa.
setAccount PUT  /enterprises/enterpriseId/account Configura la cuenta que se usará para autenticarse en la API como la empresa.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Establece el diseño de la tienda para la empresa. De forma predeterminada, storeLayoutType está configurado como "basic" y su diseño básico está habilitado. 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 a setAvailableProductSet). Las apps de la página se ordenan en función del valor de ID del producto. Si creas un diseño personalizado de la tienda (mediante la configuración de storeLayoutType = "custom" y una página principal), el diseño básico de la tienda se inhabilita.
anular la inscripción POST  /enterprises/enterpriseId/unenroll Da de baja a una empresa del 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 recursos.

Método Solicitud HTTP Descripción
URI relacionados con https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Quita el derecho de un usuario a una app. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera los detalles de una autorización. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
list GET  /enterprises/enterpriseId/users/userId/entitlements Muestra una lista de todos los derechos del usuario especificado. Solo se establece el ID. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
actualizar PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Agrega o actualiza el derecho de un usuario a una app. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Licencias grupales

Para obtener detalles sobre los recursos Grouplicenses, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relacionados con 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 de grupo de una empresa para un producto. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
list GET  /enterprises/enterpriseId/groupLicenses Recupera los ID de todos los productos para los que la empresa tiene una licencia de grupo. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Usuarios con licencias del grupo

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

Método Solicitud HTTP Descripción
URI relacionados con https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Recupera los IDs de los usuarios a los que se les otorgaron derechos en virtud de la licencia. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Instalaciones

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

Método Solicitud HTTP Descripción
URI relacionados con 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 detalles de la 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.
actualizar 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.

Parámetros de configuración administrados

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

Método Solicitud HTTP Descripción
URI relacionados con 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 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.
actualizar 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.

Parámetros de configuración administrados para el usuario

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

Método Solicitud HTTP Descripción
URI relacionados con 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 para el 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 Muestra una lista de todas las configuraciones administradas por usuario para el usuario especificado. Solo se configura el ID.
actualizar PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Agrega o actualiza la configuración administrada de una app para el usuario especificado. Si admites el iframe de configuración administrada, puedes aplicar configuraciones administradas a un usuario si especificas un mcmId y sus variables de configuración asociadas (si las hubiera) en la solicitud. Como alternativa, todos los EMM pueden aplicar configuraciones administradas pasando una lista de propiedades administradas.

Configuración administrada

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

Método Solicitud HTTP Descripción
URI relacionados con 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 para 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 relacionados con 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 a fin de mostrarlos a un administrador empresarial.

Productos

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

Método Solicitud HTTP Descripción
URI relacionados con 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 de la app pertinentes (si corresponde). La cantidad máxima de productos que puedes aprobar por cliente empresarial es de 1,000.

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

Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
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 independiente en la consola de EMM, que, a su vez, debe activar el uso de esta URL como la propiedad approvalUrlInfo.approvalUrl en una llamada Products.approve para aprobar el producto. Esta URL solo se puede usar para mostrar permisos durante 1 día como máximo. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
get GET  /enterprises/enterpriseId/products/productId Recupera los detalles de un producto para mostrárselos 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 definieron configuraciones administradas. Este esquema se puede usar para propagar una IU que permita a un administrador configurar el producto. Para aplicar una configuración administrada según el esquema obtenido con esta API, consulta Configuraciones administradas mediante Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera los permisos de app para Android que esta app requiere.
list GET  /enterprises/enterpriseId/products Encuentra productos aprobados que coinciden con una consulta o todos los productos aprobados si no hay una consulta. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
no aprobar POST  /enterprises/enterpriseId/products/productId/unapprove Anula la aprobación del producto especificado (y los permisos relevantes de la app, si los hubiera). Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Claves de cuenta de servicio

Para obtener detalles sobre los recursos de claves de cuenta de servicio, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relacionados con https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Quita y, luego, invalida las credenciales especificadas para la cuenta de servicio asociada con esta empresa. La cuenta de servicio de llamadas se debe haber recuperado mediante una llamada a Enterprises.GetServiceAccount y debe haberse configurado como la cuenta de servicio empresarial mediante una llamada 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 se debe haber recuperado mediante una llamada a Enterprises.GetServiceAccount y se debe haber configurado como la cuenta de servicio empresarial mediante una llamada a Enterprises.SetAccount.

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

Clústeres de diseño de tiendas

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

Método Solicitud HTTP Descripción
URI relacionados con 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 en la página especificada.
actualizar PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Actualiza un clúster.

Páginas de diseño de la tienda

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

Método Solicitud HTTP Descripción
URI relacionados con 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.
actualizar PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Actualiza el contenido de una página de la tienda.

empresariales

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

Método Solicitud HTTP Descripción
URI relacionados con https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId Se borró 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 administrada por EMM determinada en un dispositivo. El token generado es de un solo uso y vence 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. Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
insertar POST  /enterprises/enterpriseId/users Crea un nuevo usuario administrado por EMM.

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

Si ya existe un usuario correspondiente con el mismo identificador de cuenta, se lo 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. Solo se admite en el caso de los usuarios administrados por Google. Los usuarios administrados por EMM no necesitan la búsqueda del ID porque el ID ya se muestra en el 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 previamente (productos con aprobación revocada). Nota: Este elemento dejó de estar disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
actualizar PUT  /enterprises/enterpriseId/users/userId Actualiza los detalles de un usuario administrado por EMM.

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

Apps web

Para obtener detalles sobre los recursos de Webapps, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relacionados con 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 nueva aplicación web para la empresa.
list GET  /enterprises/enterpriseId/webApps Recupera los detalles de todas las apps web de una empresa determinada.
actualizar PUT  /enterprises/enterpriseId/webApps/webAppId Actualiza una app web existente.