API Reference

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

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

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

Устройства

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

Метод 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 Определяет, включен или отключен доступ устройства к сервисам 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» .

Предприятия

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

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/androidenterprise/v1, если не указано иное.
ПодтвердитьNotificationSet POST /enterprises/acknowledgeNotificationSet Подтверждает уведомления, полученные от Enterprises.PullNotificationSet, чтобы предотвратить возврат тех же уведомлений последующими вызовами.
полнаяРегистрация POST /enterprises/completeSignup Завершает процесс регистрации, указывая токен завершения и токен Enterprise. Этот запрос не должен вызываться несколько раз для одного токена предприятия.
создатьWebToken POST /enterprises/ enterpriseId /createWebToken Возвращает уникальный токен для доступа к встраиваемому пользовательскому интерфейсу. Чтобы создать веб-интерфейс, передайте сгенерированный токен в управляемый API JavaScript Google Play. Каждый токен можно использовать только для запуска одного сеанса пользовательского интерфейса. Дополнительную информацию см. в документации по API JavaScript .
зарегистрироваться POST /enterprises/enroll Регистрирует предприятие с помощью вызывающего EMM.

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

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

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

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

Как только учетная запись службы будет привязана к предприятию, ею можно будет управлять с помощью ресурса serviceAccountKeys.
getStoreLayout 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 см. на странице представления ресурса .

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

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

Подробную информацию о ресурсе 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 Добавляет или обновляет параметры управляемой конфигурации приложения для указанного пользователя. Если вы поддерживаете 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 для разработки и создания макета магазина для показа пользователям одобренных продуктов, см. раздел «Дизайн макета магазина» .

генерироватьApprovalUrl POST /enterprises/ enterpriseId /products/ productId /generateApprovalUrl Создает URL-адрес, который можно отобразить в iframe для отображения разрешений (если таковые имеются) продукта. Администратор предприятия должен просмотреть эти разрешения и принять их от имени своей организации, чтобы утвердить этот продукт.

Администраторам следует принять отображаемые разрешения, взаимодействуя с отдельным элементом пользовательского интерфейса в консоли EMM, что, в свою очередь, должно инициировать использование этого URL-адреса в качестве свойства approvalUrlInfo.approvalUrl в вызове Products.approve для утверждения продукта. Этот URL-адрес можно использовать только для отображения разрешений на срок до 1 дня.
получать 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 см. на странице представления ресурса .

Метод 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 см. на странице представления ресурса .

Метод 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.
генерировать токен аутентификации POST /enterprises/ enterpriseId /users/ userId /authenticationToken Создает токен аутентификации, который клиент политики устройства может использовать для подготовки данной учетной записи пользователя, управляемой EMM, на устройстве. Сгенерированный токен является одноразовым и истекает через несколько минут.

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

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

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

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

список GET /enterprises/ enterpriseId /users Ищет пользователя по основному адресу электронной почты. Это поддерживается только для пользователей, управляемых Google. Для пользователей, управляемых EMM, поиск идентификатора не требуется, поскольку идентификатор уже возвращается в результате вызова Users.insert.

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

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

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

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

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

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

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