API Reference

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

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

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

Устройства

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

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное
forceReportUpload POST /enterprises/ enterpriseId /users/ userId /devices/ deviceId /forceReportUpload Загружает отчёт, содержащий все изменения в состоянии приложений на устройстве с момента создания последнего отчёта. Вы можете вызывать этот метод до 3 раз в сутки для одного устройства.
получать GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId Получает сведения об устройстве.
получитьСостояние GET /enterprises/ enterpriseId /users/ userId /devices/ deviceId /state Возвращает информацию о том, включен или отключен доступ устройства к сервисам Google. Состояние устройства вступает в силу только в том случае, если в консоли администратора Google включено применение политик EMM на устройствах Android. В противном случае состояние устройства игнорируется, и всем устройствам разрешен доступ к сервисам Google. Эта функция поддерживается только для пользователей, управляемых Google.
список GET /enterprises/ enterpriseId /users/ userId /devices Извлекает идентификаторы всех устройств пользователя.
setState PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId /state Устанавливает, включен или выключен доступ устройства к сервисам Google. Состояние устройства вступает в силу только в том случае, если в консоли администратора Google включено применение политик EMM на устройствах Android. В противном случае состояние устройства игнорируется, и всем устройствам разрешен доступ к сервисам Google. Эта функция поддерживается только для пользователей, управляемых Google.
обновлять PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId Обновляет политику устройства.

Для обеспечения надлежащего применения политики необходимо запретить доступ к Google Play неуправляемым учётным записям, установив параметр allowed_accounts в управляемой конфигурации пакета Google Play. См. раздел «Ограничение доступа к учётным записям в 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 Завершает процесс регистрации, указывая токены завершения и предприятия. Этот запрос не должен выполняться несколько раз для одного и того же токена предприятия.
createWebToken POST /enterprises/ enterpriseId /createWebToken Возвращает уникальный токен для доступа к встраиваемому пользовательскому интерфейсу. Чтобы сгенерировать веб-интерфейс, передайте сгенерированный токен в управляемый JavaScript-API Google Play. Каждый токен можно использовать только для запуска одного сеанса пользовательского интерфейса. Подробнее см. в документации по JavaScript API .
зарегистрироваться POST /enterprises/enroll Регистрирует предприятие с вызывающим EMM.

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

generateEnterpriseUpgradeUrl POST /enterprises/ enterpriseId /generateEnterpriseUpgradeUrl Создаёт URL-адрес для обновления корпоративного аккаунта Google Play до управляемого домена Google. Подробнее см. в руководстве по обновлению корпоративного аккаунта .
generateSignupUrl POST /enterprises/signupUrl Генерирует URL-адрес для регистрации.
получать GET /enterprises/ enterpriseId Возвращает название и домен предприятия.
получитьServiceAccount GET /enterprises/ enterpriseId /serviceAccount Возвращает учетную запись службы и учетные данные. Учетную запись службы можно привязать к предприятию, вызвав setAccount. Учетная запись службы уникальна для данного предприятия и EMM и будет удалена при отмене привязки предприятия. Учетные данные содержат данные закрытого ключа и не хранятся на стороне сервера.

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

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

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

.
получитьStoreLayout GET /enterprises/ enterpriseId /storeLayout Возвращает макет магазина для предприятия. Если макет магазина не задан, возвращается тип макета «базовый» без главной страницы.
список GET /enterprises Поиск предприятия по доменному имени. Поддерживается только для предприятий, созданных через процесс создания, инициированный Google. Поиск идентификатора не требуется для предприятий, созданных через процесс создания, инициированный EMM, поскольку EMM получает идентификатор предприятия в обратном вызове, указанном в вызове Enterprises.generateSignupUrl.

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

pullNotificationSet POST /enterprises/pullNotificationSet Извлекает и возвращает набор уведомлений для предприятий, связанных с учётной записью службы, аутентифицированной для запроса. Набор уведомлений может быть пустым, если нет ожидающих уведомлений.
Возвращенный набор уведомлений необходимо подтвердить в течение 20 секунд, вызвав Enterprises.AcknowledgeNotificationSet, если только набор уведомлений не пуст.
Уведомления, которые не будут подтверждены в течение 20 секунд, в конечном итоге будут снова включены в ответ на другой запрос PullNotificationSet, а те, которые не будут подтверждены, в конечном итоге будут удалены в соответствии с системной политикой Google Cloud Platform Pub/Sub.
Для получения уведомлений можно одновременно выполнить несколько запросов. В этом случае ожидающие уведомления (если таковые имеются) будут разделены между каждым вызывающим объектом, если таковые имеются.
Если уведомлений нет, возвращается пустой список уведомлений. Последующие запросы могут возвращать дополнительные уведомления, как только они станут доступны.
sendTestPushNotification POST /enterprises/ enterpriseId /sendTestPushNotification Отправляет тестовое уведомление для проверки интеграции EMM со службой Google Cloud Pub/Sub для этого предприятия.
setAccount PUT /enterprises/ enterpriseId /account Устанавливает учетную запись, которая будет использоваться для аутентификации в API в качестве предприятия.
setStoreLayout PUT /enterprises/ enterpriseId /storeLayout Задаёт макет магазина для предприятия. По умолчанию для storeLayoutType задано значение «basic», и базовый макет магазина включён. Базовый макет содержит только приложения, одобренные администратором и добавленные в набор доступных продуктов для пользователя (с помощью вызова setAvailableProductSet ). Приложения на странице сортируются по значению идентификатора продукта. Если вы создаёте собственный макет магазина (устанавливая storeLayoutType = «custom» и указывая домашнюю страницу), базовый макет магазина отключается.
отписаться 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 Добавляет или обновляет права на приложение для пользователя.

Grouplicenses

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

Метод 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 Извлекает идентификаторы пользователей, которым предоставлены права по лицензии.

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

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

Метод 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 Запрашивает установку последней версии приложения на устройство. Если приложение уже установлено, оно обновляется до последней версии при необходимости.

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

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

Метод 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 Добавляет или обновляет параметры управляемой конфигурации приложения для указанного пользователя. Если вы поддерживаете iframe управляемых конфигураций , вы можете применить управляемые конфигурации к пользователю, указав mcmId и связанные с ним переменные конфигурации (если таковые имеются) в запросе. Кроме того, все EMM могут применять управляемые конфигурации, передавая список управляемых свойств.

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

Подробную информацию о ресурсе 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 Генерирует URL-адрес, который можно отобразить в iframe для отображения разрешений (если таковые имеются) продукта. Администратор предприятия должен просмотреть эти разрешения и принять их от имени своей организации, чтобы одобрить этот продукт.

Администраторы должны принять отображаемые разрешения, взаимодействуя с отдельным элементом пользовательского интерфейса в консоли EMM, что, в свою очередь, должно инициировать использование этого URL-адреса в качестве свойства approvalUrlInfo.approvalUrl в вызове Products.approve для одобрения продукта. Этот URL-адрес можно использовать для отображения разрешений только в течение одного дня.
получать GET /enterprises/ enterpriseId /products/ productId Извлекает сведения о продукте для отображения администратору предприятия.
getAppRestrictionsSchema GET /enterprises/ enterpriseId /products/ productId /appRestrictionsSchema Возвращает схему, определяющую настраиваемые свойства данного продукта. Схема есть у всех продуктов, но она может быть пустой, если не определены управляемые конфигурации. Эту схему можно использовать для заполнения пользовательского интерфейса, позволяющего администратору настраивать продукт. Чтобы применить управляемую конфигурацию на основе схемы, полученной с помощью этого API, см. раздел «Управляемые конфигурации через Play» .
получитьРазрешения GET /enterprises/ enterpriseId /products/ productId /permissions Получает разрешения приложения Android, требуемые этому приложению.
список GET /enterprises/ enterpriseId /products Находит одобренные продукты, соответствующие запросу, или все одобренные продукты, если запроса нет.
не одобрять POST /enterprises/ enterpriseId /products/ productId /unapprove Отменяет одобрение указанного продукта (и соответствующих разрешений приложения, если таковые имеются)

Serviceaccountkeys

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

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное
удалить DELETE /enterprises/ enterpriseId /serviceAccountKeys/ keyId Удаляет и делает недействительными указанные учетные данные для учетной записи службы, связанной с этим предприятием. Вызывающая учетная запись службы должна быть получена с помощью вызова Enterprises.GetServiceAccount и установлена ​​в качестве учетной записи службы предприятия с помощью вызова Enterprises.SetAccount.
вставлять POST /enterprises/ enterpriseId /serviceAccountKeys Создаёт новые учётные данные для учётной записи службы, связанной с этим предприятием. Учётная запись вызывающей службы должна быть получена с помощью вызова Enterprises.GetServiceAccount и установлена ​​в качестве учётной записи службы предприятия с помощью вызова Enterprises.SetAccount.

В ресурсе, который будет вставлен, необходимо указать только тип ключа.
список GET /enterprises/ enterpriseId /serviceAccountKeys Выводит список всех активных учётных данных для учётной записи службы, связанной с этим предприятием. Возвращаются только идентификатор и тип ключа. Учётная запись вызывающей службы должна быть получена с помощью вызова Enterprises.GetServiceAccount и установлена ​​в качестве учётной записи службы предприятия с помощью вызова Enterprises.SetAccount.

Storelayoutclusters

Подробную информацию о ресурсе 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

Подробную информацию о ресурсе 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 Генерирует токен аутентификации, который клиент политики устройства может использовать для предоставления данной учётной записи пользователя, управляемой EMM, на устройстве. Сгенерированный токен является одноразовым и истекает через несколько минут.

Вы можете подключить максимум 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 Поиск пользователя по основному адресу электронной почты. Поддерживается только для пользователей, управляемых Google. Поиск идентификатора не требуется для пользователей, управляемых EMM, поскольку он уже возвращается в результате вызова Users.insert.

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

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

Этот вызов работает только с учетными записями, управляемыми EMM.
setAvailableProductSet PUT /enterprises/ enterpriseId /users/ userId /availableProductSet Изменяет набор продуктов, к которым пользователь имеет доступ (так называемые продукты из белого списка ). В белый список можно добавить только одобренные или ранее одобренные продукты (продукты с отозванным одобрением).
обновлять PUT /enterprises/ enterpriseId /users/ userId Обновляет данные пользователя, управляемого EMM.

Можно использовать только с пользователями, управляемыми EMM (не с пользователями, управляемыми Google). Передайте новые данные в ресурсе Users в теле запроса. Изменить можно только поле displayName . Остальные поля должны быть либо неактивны, либо иметь текущее активное значение.

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

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

Метод 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 Обновляет существующее веб-приложение.