API Reference

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

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

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

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

сгенерироватьEnterpriseUpgradeUrl POST /enterprises/ enterpriseId /generateEnterpriseUpgradeUrl Генерирует URL-адрес обновления предприятия для обновления существующего управляемого предприятия Google Play Accounts до управляемого домена Google. Подробнее см. в руководстве по обновлению предприятия .
сгенерироватьSignupUrl 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, а те, которые не будут подтверждены, в конечном итоге будут удалены в соответствии с политикой системы Pub/Sub Google Cloud Platform.
Для получения уведомлений может быть выполнено несколько запросов одновременно, в этом случае ожидающие уведомления (если таковые имеются) будут разделены между каждым вызывающим абонентом, если таковые имеются в состоянии ожидания.
Если уведомлений нет, возвращается пустой список уведомлений. Последующие запросы могут возвращать больше уведомлений, как только они станут доступны.
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 для проектирования и создания макета магазина для демонстрации одобренных продуктов вашим пользователям, см. раздел Разработка макета магазина .

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

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

Storelayoutкластеры

Подробную информацию о ресурсе 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.
генерироватьAuthenticationToken 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

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

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