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. Enrollmenttokens
  3. Empresas
  4. Autorizaciones
  5. Licencias de grupo
  6. Grouplicenseusers
  7. Instalaciones
  8. Managedconfigurationsfordevice
  9. Managedconfigurationsforuser
  10. Managedconfigurationssettings
  11. Permisos
  12. Productos
  13. Serviceaccountkeys
  14. Storelayoutclusters
  15. Storelayoutpages
  16. Usuarios
  17. Apps web

Dispositivos

Para obtener detalles sobre el recurso Devices, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son 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 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 tiene efecto si se habilitó la aplicación de políticas de EMM en dispositivos Android en la Consola del administrador de Google. De lo contrario, se ignorará el estado del dispositivo y se permitirá el acceso de todos los dispositivos a los servicios de Google. Esta opción solo es compatible con 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 el acceso de un dispositivo a los servicios de Google está habilitado o inhabilitado. El estado del dispositivo solo tiene efecto si se habilitó la aplicación de políticas de EMM en dispositivos Android en la Consola del administrador de Google. De lo contrario, se ignorará el estado del dispositivo y se permitirá el acceso de todos los dispositivos a los servicios de Google. Esta opción solo es compatible con los usuarios administrados por Google.
actualizar PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Actualiza la política de dispositivos.

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

Enrollmenttokens

Para obtener detalles sobre el recurso Enrollmenttokens, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario.
create POST  /enterprises/enterpriseId/enrollmentTokens Crea un token de inscripción para la empresa. Este método forma parte de EnrollmentTokensService.

Empresas

Para obtener detalles sobre el recurso de Enterprise, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario.
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Confirma las notificaciones que se recibieron de las empresas.Establece PullNotificationSet para evitar que las llamadas posteriores devuelvan las mismas notificaciones.
completeSignup POST  /enterprises/completeSignup Completa el flujo de registro especificando el token de finalización y el token de la empresa. No se debe llamar a esta solicitud varias veces para un token empresarial determinado.
createWebToken POST  /enterprises/enterpriseId/createWebToken Devuelve un token único para acceder a una IU incorporable. 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. Para obtener más información, consulta la documentación de la API de JavaScript.
enroll POST  /enterprises/enroll Inscribe una empresa con el EMM de llamadas.

Parámetros de consulta obligatorios: token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl Genera una URL de actualización de la empresa para actualizar una empresa existente de cuentas de Google Play administradas a un dominio de Google administrado. Consulta la guía para actualizar una empresa para obtener más detalles.
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 Devuelve una cuenta de servicio y credenciales. La cuenta de servicio se puede vincular a la empresa llamando a setAccount. La cuenta de servicio es exclusiva de esta empresa y EMM, y se borrará si se desvincula la empresa. Las credenciales contienen datos de claves privadas 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; en otros momentos, mostrará un error.

Las llamadas posteriores a la primera generarán un nuevo conjunto único de credenciales y anularán las credenciales generadas anteriormente.

Una vez que la cuenta de servicio esté vinculada a la empresa, se podrá administrar con el recurso serviceAccountKeys.

.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Devuelve el diseño de la tienda para la empresa. Si no se estableció el diseño de la tienda, se muestra "basic" como el tipo de diseño de la tienda y no se muestra la página principal.
list GET  /enterprises Busca una empresa por nombre de dominio. Esto solo se admite para las empresas creadas a través del flujo de creación iniciado por Google. No es necesario buscar el ID de las empresas creadas a través del flujo iniciado por el EMM, ya que el EMM conoce el ID de la empresa en la devolución de llamada especificada en la llamada a Enterprises.generateSignupUrl.

Parámetros de consulta obligatorios: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Recupera y devuelve un conjunto de notificaciones para las empresas asociadas con la cuenta de servicio autenticada para la solicitud. El conjunto de notificaciones puede estar vacío si no hay notificaciones pendientes.
Se debe confirmar la recepción de un conjunto de notificaciones en un plazo de 20 segundos llamando 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 de PullNotificationSet, y las que nunca se confirmen se borrarán según la política del sistema de Google Cloud Pub/Sub.
Es posible que se realicen varias solicitudes de forma simultánea para recuperar notificaciones, en cuyo caso las notificaciones pendientes (si las hay) se dividirán entre cada llamador, si hay alguna pendiente.
Si no hay notificaciones, se devuelve una lista de notificaciones vacía. Las solicitudes posteriores pueden devolver 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 del EMM con 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 la empresa.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Establece el diseño de la tienda para la empresa. De forma predeterminada, storeLayoutType se establece en "básico" y se habilita el diseño básico de la tienda. El diseño básico solo contiene las apps aprobadas por el administrador y que se agregaron al conjunto de productos disponibles para un usuario (con la llamada setAvailableProductSet). Las apps de la página se ordenan según el valor de su ID de producto. Si creas un diseño de tienda personalizado (configurando storeLayoutType = "custom" y estableciendo una página principal), se inhabilitará el diseño de tienda básico.
anular la inscripción POST  /enterprises/enterpriseId/unenroll Da de baja la inscripción de una empresa en el EMM de llamadas.

Autorizaciones

Para obtener detalles sobre el recurso Entitlements, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 acceso a una app para un usuario.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera los detalles de un derecho.
list GET  /enterprises/enterpriseId/users/userId/entitlements Enumera todos los derechos del usuario especificado. Solo se establece el ID.
actualizar PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Agrega o actualiza un derecho de acceso a una app para un usuario.

Grouplicenses

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

Método Solicitud HTTP Descripción
Los URIs son 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 de grupo de una empresa para un producto.
list GET  /enterprises/enterpriseId/groupLicenses Recupera los IDs de todos los productos para los que la empresa tiene una licencia de grupo.

Grouplicenseusers

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

Método Solicitud HTTP Descripción
Los URIs son relativos a 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.

Instalaciones

Para obtener detalles sobre el recurso Installs, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son 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 Son 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 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 la instalación de la versión más reciente de una app en un dispositivo. Si la app ya está instalada, se actualizará a la versión más reciente si es necesario.

Managedconfigurationsfordevice

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

Método Solicitud HTTP Descripción
Los URIs son 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 la 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 para una app en el dispositivo especificado.

Managedconfigurationsforuser

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

Método Solicitud HTTP Descripción
Los URIs son 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 para una app del usuario especificado.
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Recupera los detalles de una configuración administrada por usuario para una app del 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.
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 especificando un mcmId y sus variables de configuración asociadas (si las hay) en la solicitud. Como alternativa, todos los EMM pueden aplicar parámetros de configuración administrados pasando una lista de propiedades administradas.

Managedconfigurationssettings

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

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

Permisos

Para obtener detalles sobre el recurso Permissions, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son 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 detalles sobre el recurso Products, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario.
approve 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 y diseñar y crear un diseño de la tienda para mostrar productos aprobados a tus usuarios, consulta Diseño del 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 de la empresa 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 IU independiente en la consola del EMM, lo que, a su vez, debería 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 un máximo de 1 día.
get GET  /enterprises/enterpriseId/products/productId Recupera los detalles de un producto para mostrárselos al administrador de la empresa.
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Recupera el esquema que define las propiedades configurables para este producto. Todos los productos tienen un esquema, pero este puede estar vacío si no se definieron parámetros de configuración administrados. Este esquema se puede usar para completar una IU que permita que un administrador configure el producto. Para aplicar un parámetro de configuración administrado basado en el esquema obtenido con esta API, consulta Parámetros de configuración administrados a través de Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera los permisos de la app para Android que requiere esta app.
list GET  /enterprises/enterpriseId/products Encuentra los productos aprobados que coinciden con una búsqueda o todos los productos aprobados si no hay una búsqueda.
unapprove POST  /enterprises/enterpriseId/products/productId/unapprove Rechaza el producto especificado (y los permisos de la app pertinentes, si los hay).

Serviceaccountkeys

Para obtener detalles sobre el recurso Serviceaccountkeys, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 a esta empresa. La cuenta de servicio de llamada se debe haber recuperado llamando a Enterprises.GetServiceAccount y se debe haber establecido como la cuenta de servicio de la empresa 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 llamada se debe haber recuperado llamando a Enterprises.GetServiceAccount y se debe haber establecido como la cuenta de servicio de la empresa llamando a Enterprises.SetAccount.

Solo se debe completar el tipo de clave 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 devuelven el ID y el tipo de clave. La cuenta de servicio de llamada se debe haber recuperado llamando a Enterprises.GetServiceAccount y se debe haber establecido como la cuenta de servicio de la empresa llamando a Enterprises.SetAccount.

Storelayoutclusters

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

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

Storelayoutpages

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

Método Solicitud HTTP Descripción
Los URIs son 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 Play Store.
insertar POST  /enterprises/enterpriseId/storeLayout/pages Inserta una página de la tienda nueva.
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.

Usuarios

Para obtener detalles sobre el recurso Users, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 la política de dispositivos puede usar para aprovisionar la cuenta de usuario administrada por EMM especificada 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.
insertar POST  /enterprises/enterpriseId/users Crea un usuario nuevo 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 actualizará el usuario 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 es compatible con los usuarios administrados por Google. No es necesario buscar el ID para los usuarios administrados por el EMM, ya que este ya se devuelve en el resultado de la llamada a Users.insert.

Parámetros de consulta obligatorios: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Revoca el acceso a todos los dispositivos aprovisionados actualmente para el 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 incluidos en la lista blanca). Solo se pueden incluir en la lista blanca los productos que estén aprobados o que se hayan aprobado anteriormente (productos con aprobación revocada).
actualizar 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 Users del cuerpo de la solicitud. Solo se puede cambiar el campo displayName. Los otros campos deben estar sin configurar 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
Los URIs son 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 nueva app 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.