Важно! Мы больше не принимаем новых регистраций для Play EMM API. Узнать больше .

API Reference

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

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

  1. Устройства
  2. Предприятия
  3. Права
  4. Групповые лицензии
  5. Grouplicenseusers
  6. Устанавливает
  7. Управляемые конфигурации для устройства
  8. Управляемые конфигурации для пользователя
  9. Настройки управляемых конфигураций
  10. Разрешения
  11. Продукты
  12. Сервисные учетные записи
  13. Storelayoutclusters
  14. Storelayoutpages
  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 Получает сведения об устройстве.
получить состояние 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 Завершает процесс регистрации, указывая токен завершения и токен предприятия. Этот запрос не должен вызываться несколько раз для данного корпоративного токена.
создатьWebToken POST /enterprises/ enterpriseId /createWebToken Возвращает уникальный токен для доступа к встраиваемому пользовательскому интерфейсу. Чтобы создать веб-интерфейс, передайте сгенерированный токен в управляемый Google Play javascript API. Каждый токен можно использовать только для запуска одного сеанса пользовательского интерфейса. Дополнительную информацию см. в документации по javascript API.
зарегистрироваться POST /enterprises/enroll Регистрирует предприятие в вызывающем EMM.

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

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

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

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

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

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

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

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

Сведения о ресурсе 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 Список всех управляемых конфигураций для каждого устройства для указанного устройства. Устанавливается только ID.
обновлять PUT /enterprises/ enterpriseId /users/ userId /devices/ deviceId /managedConfigurationsForDevice/ managedConfigurationForDeviceId Добавляет или обновляет управляемую конфигурацию для каждого устройства для приложения для указанного устройства.

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

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

Метод 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 Список всех управляемых конфигураций для каждого пользователя для указанного пользователя. Устанавливается только ID.
обновлять 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 для approvalUrlInfo.approvalUrl продукта. Этот 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 Удаляет и делает недействительными указанные учетные данные для учетной записи службы, связанной с этим предприятием. Учетная запись вызывающей службы должна быть получена путем вызова Enterprise.GetServiceAccount и должна быть установлена ​​в качестве учетной записи службы предприятия путем вызова Enterprise.SetAccount.
вставлять POST /enterprises/ enterpriseId /serviceAccountKeys Создает новые учетные данные для учетной записи службы, связанной с этим предприятием. Учетная запись вызывающей службы должна быть получена путем вызова Enterprise.GetServiceAccount и должна быть установлена ​​в качестве учетной записи службы предприятия путем вызова Enterprise.SetAccount.

В вставляемом ресурсе должен быть указан только тип ключа.
список GET /enterprises/ enterpriseId /serviceAccountKeys Список всех активных учетных данных для учетной записи службы, связанной с этим предприятием. Возвращаются только идентификатор и тип ключа. Учетная запись вызывающей службы должна быть получена путем вызова Enterprise.GetServiceAccount и должна быть установлена ​​в качестве учетной записи службы предприятия путем вызова Enterprise.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.
генерироватьаутентикатионтокен 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

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

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

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

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