API Reference

Данная справочная информация по API организована по типам ресурсов. Каждый тип ресурса имеет одно или несколько представлений данных и одно или несколько методов.

Типы ресурсов

  1. Устройства
  2. Токены регистрации
  3. Предприятия
  4. Права
  5. Групповые лицензии
  6. Grouplicenseusers
  7. Устанавливает
  8. Управляемые конфигурации для устройства
  9. Управляемые конфигурации для пользователя
  10. Управляемые настройки конфигурации
  11. Разрешения
  12. Продукты
  13. Ключи учетных записей служб
  14. Кластеры компоновки магазинов
  15. Страницы макета магазина
  16. Пользователи
  17. Веб-приложения

Устройства

Подробную информацию о ресурсах устройств см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
forceReportUpload POST /enterprises/ enterpriseId /users/ userId /devices/ deviceId /forceReportUpload Загружает отчет, содержащий все изменения в состоянии приложения на устройстве с момента создания последнего отчета. Вы можете вызывать этот метод до 3 раз в течение 24 часов для данного устройства.
получать GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId Получает подробную информацию об устройстве.
getState GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId /state Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
список GET /enterprises/ enterpriseId /users/ userId /devices Получает идентификаторы всех устройств пользователя.
setState PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId /state Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
обновлять PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId Обновляет политику устройства.

To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play .

Токены регистрации

Подробную информацию о ресурсе Enrollmenttokens см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
создавать POST /enterprises/ enterpriseId /enrollmentTokens Создает токен регистрации для предприятия. Этот метод является частью класса EnrollmentTokensService.

Предприятия

Подробную информацию о ресурсах предприятия см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
acknowledgeNotificationSet POST /enterprises/acknowledgeNotificationSet Подтверждает получение уведомлений от Enterprises.PullNotificationSet, чтобы предотвратить возврат тех же уведомлений при последующих вызовах.
завершить регистрацию POST /enterprises/completeSignup Завершает процесс регистрации, указывая токен завершения и корпоративный токен. Этот запрос не должен вызываться несколько раз для одного и того же корпоративного токена.
создатьWebToken POST /enterprises/ enterpriseId /createWebToken Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the JavaScript API documentation for further information.
зарегистрироваться POST /enterprises/enroll Регистрирует предприятие в вызывающей системе EMM.

Обязательные параметры запроса: token

generateEnterpriseUpgradeUrl POST /enterprises/ enterpriseId /generateEnterpriseUpgradeUrl Генерирует URL-адрес обновления для предприятия, позволяющий обновить существующие корпоративные учетные записи Google Play до управляемого домена Google. Дополнительные сведения см. в руководстве по обновлению корпоративных учетных записей .
generateSignupUrl POST /enterprises/signupUrl Генерирует URL-адрес для регистрации.
получать GET /enterprises/ enterpriseId Получает название и домен предприятия.
getServiceAccount GET /enterprises/ enterpriseId /serviceAccount Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.

Этот метод можно вызывать только после вызова Enterprises.Enroll или Enterprises.CompleteSignup и до вызова Enterprises.SetAccount; в противном случае он вернет ошибку.

Последующие вызовы после первого сгенерируют новый, уникальный набор учетных данных и аннулируют ранее сгенерированные учетные данные.

После привязки учетной записи службы к корпоративной сети, управлять ею можно с помощью ресурса serviceAccountKeys.

.
getStoreLayout GET /enterprises/ enterpriseId /storeLayout Возвращает макет магазина для предприятия. Если макет магазина не задан, возвращает "basic" в качестве типа макета магазина и не отображает главную страницу.
список GET /enterprises Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.

Обязательные параметры запроса: domain

pullNotificationSet POST /enterprises/pullNotificationSet Получает и возвращает набор уведомлений для предприятий, связанных с учетной записью службы, прошедшей аутентификацию для запроса. Набор уведомлений может быть пустым, если нет ожидающих уведомлений.
Возвращенный набор уведомлений необходимо подтвердить в течение 20 секунд, вызвав метод Enterprises.AcknowledgeNotificationSet, если только набор уведомлений не пуст.
Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.
Для получения уведомлений может выполняться несколько запросов одновременно, в этом случае ожидающие уведомления (если таковые имеются) будут распределены между каждым вызывающим абонентом, если таковые имеются.
Если уведомления отсутствуют, возвращается пустой список уведомлений. Последующие запросы могут вернуть дополнительные уведомления по мере их появления.
sendTestPushNotification POST /enterprises/ enterpriseId /sendTestPushNotification Отправляет тестовое уведомление для проверки интеграции EMM с сервисом Google Cloud Pub/Sub для данного предприятия.
setAccount PUT /enterprises/ enterpriseId /account Задает учетную запись, которая будет использоваться для аутентификации в API, как корпоративная.
setStoreLayout PUT /enterprises/ enterpriseId /storeLayout Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.
отписаться POST /enterprises/ enterpriseId /unenroll Отключает предприятие от вызывающей системы EMM.

Права

Подробную информацию о ресурсах, предоставляющих права доступа, см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /users/ userId /entitlements/ entitlementId Лишает пользователя права доступа к приложению.
получать GET /enterprises/ enterpriseId /users/ userId /entitlements/ entitlementId Получает подробную информацию о праве на получение льгот.
список GET /enterprises/ enterpriseId /users/ userId /entitlements Выводит список всех прав доступа для указанного пользователя. Указывается только идентификатор.
обновлять PUT /enterprises/ enterpriseId /users/ userId /entitlements/ entitlementId Добавляет или обновляет права доступа к приложению для пользователя.

Групповые лицензии

Подробную информацию о групповых лицензиях см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
получать GET /enterprises/ enterpriseId /groupLicenses/ groupLicenseId Получает подробную информацию о групповой лицензии предприятия на продукт.
список GET /enterprises/ enterpriseId /groupLicenses Получает идентификаторы всех продуктов, на которые у предприятия есть групповая лицензия.

Grouplicenseusers

Подробную информацию о ресурсе Grouplicenseusers см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
список GET /enterprises/ enterpriseId /groupLicenses/ groupLicenseId /users Получает идентификаторы пользователей, которым были предоставлены права в соответствии с лицензией.

Устанавливает

Подробную информацию об установке ресурсов см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /users/ userId /devices/ deviceId /installs/ installId Запросы на удаление приложения с устройства. Вызов методов get или ` list будет по-прежнему отображать приложение как установленное на устройстве до тех пор, пока оно фактически не будет удалено.
получать GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId /installs/ installId Получает подробную информацию об установке приложения на устройство.
список GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId /installs Получает подробную информацию обо всех приложениях, установленных на указанном устройстве.
обновлять PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId /installs/ installId Запрос на установку последней версии приложения на устройство. Если приложение уже установлено, то при необходимости оно обновляется до последней версии.

Управляемые конфигурации для устройства

Подробную информацию о управляемых конфигурациях для ресурсов устройства см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /users/ userId /devices/ deviceId /managedConfigurationsForDevice/ managedConfigurationForDeviceId Удаляет управляемую конфигурацию для каждого устройства для приложения на указанном устройстве.
получать GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId /managedConfigurationsForDevice/ managedConfigurationForDeviceId Получает подробную информацию о конфигурации, управляемой для каждого устройства.
список GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId /managedConfigurationsForDevice Выводит список всех управляемых конфигураций для указанного устройства. Задается только идентификатор.
обновлять PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId /managedConfigurationsForDevice/ managedConfigurationForDeviceId Добавляет или обновляет управляемую конфигурацию для каждого устройства для приложения на указанном устройстве.

Управляемые конфигурации для пользователя

Подробную информацию о ресурсе Managedconfigurationsforuser см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /users/ userId /managedConfigurationsForUser/ managedConfigurationForUserId Удаляет управляемую для каждого пользователя конфигурацию приложения для указанного пользователя.
получать GET /enterprises/ enterpriseId /users/ userId /managedConfigurationsForUser/ managedConfigurationForUserId Получает подробную информацию о конфигурации приложения, управляемой каждым пользователем, для указанного пользователя.
список GET /enterprises/ enterpriseId /users/ userId /managedConfigurationsForUser Выводит список всех управляемых конфигураций для указанного пользователя. Указывается только идентификатор.
обновлять PUT /enterprises/ enterpriseId /users/ userId /managedConfigurationsForUser/ managedConfigurationForUserId Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe , you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.

Управляемые настройки конфигурации

Подробную информацию о ресурсе Managedconfigurationssettings см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
список GET /enterprises/ enterpriseId /products/ productId /managedConfigurationsSettings Отображает список всех параметров управляемой конфигурации для указанного приложения.

Разрешения

Подробную информацию о ресурсах, содержащих разрешения, см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
получать GET /permissions/ permissionId Получает подробную информацию о разрешениях приложения Android для отображения администратору предприятия.

Продукты

Подробную информацию о ресурсах продуктов см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
утвердить POST /enterprises/ enterpriseId /products/ productId /approve

Подтверждает указанный продукт и соответствующие разрешения приложения, если таковые имеются. Максимальное количество продуктов, которые можно утвердить для одного корпоративного клиента, составляет 1000.

Чтобы узнать, как использовать управляемый Google Play для разработки и создания макета магазина, отображающего одобренные товары для ваших пользователей, см. раздел «Разработка макета магазина» .

generateApprovalUrl POST /enterprises/ enterpriseId /products/ productId /generateApprovalUrl Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.

Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.
получать GET /enterprises/ enterpriseId /products/ productId Получает подробную информацию о продукте для отображения администратору предприятия.
getAppRestrictionsSchema GET /enterprises/ enterpriseId /products/ productId /appRestrictionsSchema Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play .
получить разрешения GET /enterprises/ enterpriseId /products/ productId /permissions Получает необходимые для работы приложения Android разрешения.
список GET /enterprises/ enterpriseId /products Находит одобренные товары, соответствующие запросу, или все одобренные товары, если запроса нет.
не одобрить POST /enterprises/ enterpriseId /products/ productId /unapprove Отменяет разрешение на использование указанного продукта (и соответствующих разрешений приложения, если таковые имеются).

Ключи учетных записей служб

Подробную информацию о ресурсе Serviceaccountkeys см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /serviceAccountKeys/ keyId Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
вставлять POST /enterprises/ enterpriseId /serviceAccountKeys Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

В ресурсе, подлежащем вставке, следует указывать только тип ключа.
список GET /enterprises/ enterpriseId /serviceAccountKeys Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

Кластеры компоновки магазинов

Подробную информацию о ресурсе Storelayoutclusters см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /storeLayout/pages/ pageId /clusters/ clusterId Удаляет кластер.
получать GET /enterprises/ enterpriseId /storeLayout/pages/ pageId /clusters/ clusterId Получает подробную информацию о кластере.
вставлять POST /enterprises/ enterpriseId /storeLayout/pages/ pageId /clusters Вставляет новый кластер на страницу.
список GET /enterprises/ enterpriseId /storeLayout/pages/ pageId /clusters Получает подробную информацию обо всех кластерах на указанной странице.
обновлять PUT /enterprises/ enterpriseId /storeLayout/pages/ pageId /clusters/ clusterId Обновляет кластер.

Страницы макета магазина

Подробную информацию о ресурсе Storelayoutpages см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /storeLayout/pages/ pageId Удаляет страницу магазина.
получать GET /enterprises/ enterpriseId /storeLayout/pages/ pageId Получает подробную информацию со страницы магазина.
вставлять POST /enterprises/ enterpriseId /storeLayout/pages Вставляет новую страницу магазина.
список GET /enterprises/ enterpriseId /storeLayout/pages Получает подробную информацию обо всех страницах магазина.
обновлять PUT /enterprises/ enterpriseId /storeLayout/pages/ pageId Обновляет содержимое страницы магазина.

Пользователи

Подробную информацию о ресурсах пользователей см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /users/ userId Удалён пользователь, управляемый системой EMM.
generateAuthenticationToken POST /enterprises/ enterpriseId /users/ userId /authenticationToken Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.

На одного пользователя можно подключить максимум 10 устройств.

Этот вызов работает только с учетными записями, управляемыми EMM.
получать GET /enterprises/ enterpriseId /users/ userId Получает данные пользователя.
getAvailableProductSet GET /enterprises/ enterpriseId /users/ userId /availableProductSet Получает набор продуктов, к которым пользователь имеет право доступа.
вставлять POST /enterprises/ enterpriseId /users Создает нового пользователя, управляемого системой EMM.

Ресурс Users , передаваемый в теле запроса, должен содержать accountIdentifier и accountType .

Если соответствующий пользователь с тем же идентификатором учетной записи уже существует, данные пользователя будут обновлены. В этом случае изменить можно только поле displayName .

список GET /enterprises/ enterpriseId /users Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.

Обязательные параметры запроса: email

revokeDeviceAccess DELETE /enterprises/ enterpriseId /users/ userId /deviceAccess Отменяет доступ ко всем устройствам, которые в данный момент предоставлены пользователю. Пользователь больше не сможет использовать управляемый магазин Play Store ни на одном из своих управляемых устройств.

Этот вызов работает только с учетными записями, управляемыми EMM.
setAvailableProductSet PUT /enterprises/ enterpriseId /users/ userId /availableProductSet Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
обновлять PUT /enterprises/ enterpriseId /users/ userId Обновляет данные пользователя, управляемого системой EMM.

Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.

Веб-приложения

Подробную информацию о ресурсах веб-приложений см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI указаны относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
удалить DELETE /enterprises/ enterpriseId /webApps/ webAppId Удаляет существующее веб-приложение.
получать GET /enterprises/ enterpriseId /webApps/ webAppId Получает доступ к существующему веб-приложению.
вставлять POST /enterprises/ enterpriseId /webApps Создает новое веб-приложение для предприятия.
список GET /enterprises/ enterpriseId /webApps Получает подробную информацию обо всех веб-приложениях для данного предприятия.
обновлять PUT /enterprises/ enterpriseId /webApps/ webAppId Обновляет существующее веб-приложение.