OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/androidenterprise": { | 5 "https://www.googleapis.com/auth/androidenterprise": { |
6 "description": "Manage corporate Android devices" | 6 "description": "Manage corporate Android devices" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "/androidenterprise/v1/", | 11 "basePath": "/androidenterprise/v1/", |
12 "baseUrl": "https://www.googleapis.com/androidenterprise/v1/", | 12 "baseUrl": "https://www.googleapis.com/androidenterprise/v1/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "canonicalName": "Android Enterprise", | 14 "canonicalName": "Android Enterprise", |
15 "description": "Manages the deployment of apps to Android for Work users.", | 15 "description": "Manages the deployment of apps to Android for Work users.", |
16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
17 "documentationLink": "https://developers.google.com/android/work/play/emm-ap
i", | 17 "documentationLink": "https://developers.google.com/android/work/play/emm-ap
i", |
18 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/qmu3g-0qIQB7C8meI8fD39oNLuA\"", | 18 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/GhRZzPzHWmqlGHjVwgcMslePzRw\"", |
19 "icons": { | 19 "icons": { |
20 "x16": "https://www.google.com/images/icons/product/android-16.png", | 20 "x16": "https://www.google.com/images/icons/product/android-16.png", |
21 "x32": "https://www.google.com/images/icons/product/android-32.png" | 21 "x32": "https://www.google.com/images/icons/product/android-32.png" |
22 }, | 22 }, |
23 "id": "androidenterprise:v1", | 23 "id": "androidenterprise:v1", |
24 "kind": "discovery#restDescription", | 24 "kind": "discovery#restDescription", |
25 "name": "androidenterprise", | 25 "name": "androidenterprise", |
26 "ownerDomain": "google.com", | 26 "ownerDomain": "google.com", |
27 "ownerName": "Google", | 27 "ownerName": "Google", |
28 "parameters": { | 28 "parameters": { |
(...skipping 253 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
282 "$ref": "AdministratorWebTokenSpec" | 282 "$ref": "AdministratorWebTokenSpec" |
283 }, | 283 }, |
284 "response": { | 284 "response": { |
285 "$ref": "AdministratorWebToken" | 285 "$ref": "AdministratorWebToken" |
286 }, | 286 }, |
287 "scopes": [ | 287 "scopes": [ |
288 "https://www.googleapis.com/auth/androidenterprise" | 288 "https://www.googleapis.com/auth/androidenterprise" |
289 ] | 289 ] |
290 }, | 290 }, |
291 "delete": { | 291 "delete": { |
292 "description": "Deletes the binding between the EMM and ente
rprise. This is now deprecated; use this to unenroll customers that were previou
sly enrolled with the 'insert' call, then enroll them again with the 'enroll' ca
ll.", | 292 "description": "Deletes the binding between the EMM and ente
rprise. This is now deprecated. Use this method only to unenroll customers that
were previously enrolled with the insert call, then enroll them again with the e
nroll call.", |
293 "httpMethod": "DELETE", | 293 "httpMethod": "DELETE", |
294 "id": "androidenterprise.enterprises.delete", | 294 "id": "androidenterprise.enterprises.delete", |
295 "parameterOrder": [ | 295 "parameterOrder": [ |
296 "enterpriseId" | 296 "enterpriseId" |
297 ], | 297 ], |
298 "parameters": { | 298 "parameters": { |
299 "enterpriseId": { | 299 "enterpriseId": { |
300 "description": "The ID of the enterprise.", | 300 "description": "The ID of the enterprise.", |
301 "location": "path", | 301 "location": "path", |
302 "required": true, | 302 "required": true, |
(...skipping 175 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
478 }, | 478 }, |
479 "path": "enterprises", | 479 "path": "enterprises", |
480 "response": { | 480 "response": { |
481 "$ref": "EnterprisesListResponse" | 481 "$ref": "EnterprisesListResponse" |
482 }, | 482 }, |
483 "scopes": [ | 483 "scopes": [ |
484 "https://www.googleapis.com/auth/androidenterprise" | 484 "https://www.googleapis.com/auth/androidenterprise" |
485 ] | 485 ] |
486 }, | 486 }, |
487 "pullNotificationSet": { | 487 "pullNotificationSet": { |
488 "description": "Pulls and returns a notification set for the
enterprises associated with the service account authenticated for the request.
The notification set may be empty if no notification are pending.\nA notificatio
n set returned needs to be acknowledged within 20 seconds by calling Enterprises
.AcknowledgeNotificationSet, unless the notification set is empty.\nNotificatio
ns that are not acknowledged within the 20 seconds will eventually be included a
gain in the response to another PullNotificationSet request, and those that are
never acknowledged will ultimately be deleted according to the Google Cloud Plat
form Pub/Sub system policy.\nMultiple requests might be performed concurrently t
o retrieve notifications, in which case the pending notifications (if any) will
be split among each caller, if any are pending.\nIf no notifications are present
, an empty notification list is returned. Subsequent requests may return more no
tifications once they become available.", | 488 "description": "Pulls and returns a notification set for the
enterprises associated with the service account authenticated for the request.
The notification set may be empty if no notification are pending.\nA notificatio
n set returned needs to be acknowledged within 20 seconds by calling Enterprises
.AcknowledgeNotificationSet, unless the notification set is empty.\nNotification
s that are not acknowledged within the 20 seconds will eventually be included ag
ain in the response to another PullNotificationSet request, and those that are n
ever acknowledged will ultimately be deleted according to the Google Cloud Platf
orm Pub/Sub system policy.\nMultiple requests might be performed concurrently to
retrieve notifications, in which case the pending notifications (if any) will b
e split among each caller, if any are pending.\nIf no notifications are present,
an empty notification list is returned. Subsequent requests may return more not
ifications once they become available.", |
489 "httpMethod": "POST", | 489 "httpMethod": "POST", |
490 "id": "androidenterprise.enterprises.pullNotificationSet", | 490 "id": "androidenterprise.enterprises.pullNotificationSet", |
491 "parameters": { | 491 "parameters": { |
492 "requestMode": { | 492 "requestMode": { |
493 "description": "The request mode for pulling notific
ations.\nSpecifying waitForNotifications will cause the request to block and wai
t until one or more notifications are present, or return an empty notification l
ist if no notifications are present after some time.\nSpeciying returnImmediatel
y will cause the request to immediately return the pending notifications, or an
empty list if no notifications are present.\nIf omitted, defaults to waitForNoti
fications.", | 493 "description": "The request mode for pulling notific
ations.\nSpecifying waitForNotifications will cause the request to block and wai
t until one or more notifications are present, or return an empty notification l
ist if no notifications are present after some time.\nSpeciying returnImmediatel
y will cause the request to immediately return the pending notifications, or an
empty list if no notifications are present.\nIf omitted, defaults to waitForNoti
fications.", |
494 "enum": [ | 494 "enum": [ |
495 "returnImmediately", | 495 "returnImmediately", |
496 "waitForNotifications" | 496 "waitForNotifications" |
497 ], | 497 ], |
498 "enumDescriptions": [ | 498 "enumDescriptions": [ |
(...skipping 29 matching lines...) Expand all Loading... |
528 }, | 528 }, |
529 "path": "enterprises/{enterpriseId}/sendTestPushNotification
", | 529 "path": "enterprises/{enterpriseId}/sendTestPushNotification
", |
530 "response": { | 530 "response": { |
531 "$ref": "EnterprisesSendTestPushNotificationResponse" | 531 "$ref": "EnterprisesSendTestPushNotificationResponse" |
532 }, | 532 }, |
533 "scopes": [ | 533 "scopes": [ |
534 "https://www.googleapis.com/auth/androidenterprise" | 534 "https://www.googleapis.com/auth/androidenterprise" |
535 ] | 535 ] |
536 }, | 536 }, |
537 "setAccount": { | 537 "setAccount": { |
538 "description": "Set the account that will be used to authent
icate to the API as the enterprise.", | 538 "description": "Sets the account that will be used to authen
ticate to the API as the enterprise.", |
539 "httpMethod": "PUT", | 539 "httpMethod": "PUT", |
540 "id": "androidenterprise.enterprises.setAccount", | 540 "id": "androidenterprise.enterprises.setAccount", |
541 "parameterOrder": [ | 541 "parameterOrder": [ |
542 "enterpriseId" | 542 "enterpriseId" |
543 ], | 543 ], |
544 "parameters": { | 544 "parameters": { |
545 "enterpriseId": { | 545 "enterpriseId": { |
546 "description": "The ID of the enterprise.", | 546 "description": "The ID of the enterprise.", |
547 "location": "path", | 547 "location": "path", |
548 "required": true, | 548 "required": true, |
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
604 "path": "enterprises/{enterpriseId}/unenroll", | 604 "path": "enterprises/{enterpriseId}/unenroll", |
605 "scopes": [ | 605 "scopes": [ |
606 "https://www.googleapis.com/auth/androidenterprise" | 606 "https://www.googleapis.com/auth/androidenterprise" |
607 ] | 607 ] |
608 } | 608 } |
609 } | 609 } |
610 }, | 610 }, |
611 "entitlements": { | 611 "entitlements": { |
612 "methods": { | 612 "methods": { |
613 "delete": { | 613 "delete": { |
614 "description": "Removes an entitlement to an app for a user
and uninstalls it.", | 614 "description": "Removes an entitlement to an app for a user.
", |
615 "httpMethod": "DELETE", | 615 "httpMethod": "DELETE", |
616 "id": "androidenterprise.entitlements.delete", | 616 "id": "androidenterprise.entitlements.delete", |
617 "parameterOrder": [ | 617 "parameterOrder": [ |
618 "enterpriseId", | 618 "enterpriseId", |
619 "userId", | 619 "userId", |
620 "entitlementId" | 620 "entitlementId" |
621 ], | 621 ], |
622 "parameters": { | 622 "parameters": { |
623 "enterpriseId": { | 623 "enterpriseId": { |
624 "description": "The ID of the enterprise.", | 624 "description": "The ID of the enterprise.", |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
675 }, | 675 }, |
676 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts/{entitlementId}", | 676 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts/{entitlementId}", |
677 "response": { | 677 "response": { |
678 "$ref": "Entitlement" | 678 "$ref": "Entitlement" |
679 }, | 679 }, |
680 "scopes": [ | 680 "scopes": [ |
681 "https://www.googleapis.com/auth/androidenterprise" | 681 "https://www.googleapis.com/auth/androidenterprise" |
682 ] | 682 ] |
683 }, | 683 }, |
684 "list": { | 684 "list": { |
685 "description": "List of all entitlements for the specified u
ser. Only the ID is set.", | 685 "description": "Lists all entitlements for the specified use
r. Only the ID is set.", |
686 "httpMethod": "GET", | 686 "httpMethod": "GET", |
687 "id": "androidenterprise.entitlements.list", | 687 "id": "androidenterprise.entitlements.list", |
688 "parameterOrder": [ | 688 "parameterOrder": [ |
689 "enterpriseId", | 689 "enterpriseId", |
690 "userId" | 690 "userId" |
691 ], | 691 ], |
692 "parameters": { | 692 "parameters": { |
693 "enterpriseId": { | 693 "enterpriseId": { |
694 "description": "The ID of the enterprise.", | 694 "description": "The ID of the enterprise.", |
695 "location": "path", | 695 "location": "path", |
(...skipping 316 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1012 }, | 1012 }, |
1013 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs", | 1013 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs", |
1014 "response": { | 1014 "response": { |
1015 "$ref": "InstallsListResponse" | 1015 "$ref": "InstallsListResponse" |
1016 }, | 1016 }, |
1017 "scopes": [ | 1017 "scopes": [ |
1018 "https://www.googleapis.com/auth/androidenterprise" | 1018 "https://www.googleapis.com/auth/androidenterprise" |
1019 ] | 1019 ] |
1020 }, | 1020 }, |
1021 "patch": { | 1021 "patch": { |
1022 "description": "Requests to install the latest version of an
app to a device. If the app is already installed then it is updated to the late
st version if necessary. This method supports patch semantics.", | 1022 "description": "Requests to install the latest version of an
app to a device. If the app is already installed, then it is updated to the lat
est version if necessary. This method supports patch semantics.", |
1023 "httpMethod": "PATCH", | 1023 "httpMethod": "PATCH", |
1024 "id": "androidenterprise.installs.patch", | 1024 "id": "androidenterprise.installs.patch", |
1025 "parameterOrder": [ | 1025 "parameterOrder": [ |
1026 "enterpriseId", | 1026 "enterpriseId", |
1027 "userId", | 1027 "userId", |
1028 "deviceId", | 1028 "deviceId", |
1029 "installId" | 1029 "installId" |
1030 ], | 1030 ], |
1031 "parameters": { | 1031 "parameters": { |
1032 "deviceId": { | 1032 "deviceId": { |
(...skipping 26 matching lines...) Expand all Loading... |
1059 "$ref": "Install" | 1059 "$ref": "Install" |
1060 }, | 1060 }, |
1061 "response": { | 1061 "response": { |
1062 "$ref": "Install" | 1062 "$ref": "Install" |
1063 }, | 1063 }, |
1064 "scopes": [ | 1064 "scopes": [ |
1065 "https://www.googleapis.com/auth/androidenterprise" | 1065 "https://www.googleapis.com/auth/androidenterprise" |
1066 ] | 1066 ] |
1067 }, | 1067 }, |
1068 "update": { | 1068 "update": { |
1069 "description": "Requests to install the latest version of an
app to a device. If the app is already installed then it is updated to the late
st version if necessary.", | 1069 "description": "Requests to install the latest version of an
app to a device. If the app is already installed, then it is updated to the lat
est version if necessary.", |
1070 "httpMethod": "PUT", | 1070 "httpMethod": "PUT", |
1071 "id": "androidenterprise.installs.update", | 1071 "id": "androidenterprise.installs.update", |
1072 "parameterOrder": [ | 1072 "parameterOrder": [ |
1073 "enterpriseId", | 1073 "enterpriseId", |
1074 "userId", | 1074 "userId", |
1075 "deviceId", | 1075 "deviceId", |
1076 "installId" | 1076 "installId" |
1077 ], | 1077 ], |
1078 "parameters": { | 1078 "parameters": { |
1079 "deviceId": { | 1079 "deviceId": { |
(...skipping 667 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1747 "format": "uint32", | 1747 "format": "uint32", |
1748 "location": "query", | 1748 "location": "query", |
1749 "type": "integer" | 1749 "type": "integer" |
1750 }, | 1750 }, |
1751 "query": { | 1751 "query": { |
1752 "description": "The search query as typed in the Goo
gle Play store search box. If omitted, all approved apps will be returned (using
the pagination parameters), including apps that are not available in the store
(e.g. unpublished apps).", | 1752 "description": "The search query as typed in the Goo
gle Play store search box. If omitted, all approved apps will be returned (using
the pagination parameters), including apps that are not available in the store
(e.g. unpublished apps).", |
1753 "location": "query", | 1753 "location": "query", |
1754 "type": "string" | 1754 "type": "string" |
1755 }, | 1755 }, |
1756 "token": { | 1756 "token": { |
1757 "description": "A pagination token is contained in a
requests response when there are more products. The token can be used in a sub
sequent request to obtain more products, and so forth. This parameter cannot be
used in the initial request.", | 1757 "description": "A pagination token is contained in a
request''s response when there are more products. The token can be used in a su
bsequent request to obtain more products, and so forth. This parameter cannot be
used in the initial request.", |
1758 "location": "query", | 1758 "location": "query", |
1759 "type": "string" | 1759 "type": "string" |
1760 } | 1760 } |
1761 }, | 1761 }, |
1762 "path": "enterprises/{enterpriseId}/products", | 1762 "path": "enterprises/{enterpriseId}/products", |
1763 "response": { | 1763 "response": { |
1764 "$ref": "ProductsListResponse" | 1764 "$ref": "ProductsListResponse" |
1765 }, | 1765 }, |
1766 "scopes": [ | 1766 "scopes": [ |
1767 "https://www.googleapis.com/auth/androidenterprise" | 1767 "https://www.googleapis.com/auth/androidenterprise" |
(...skipping 829 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2597 "response": { | 2597 "response": { |
2598 "$ref": "User" | 2598 "$ref": "User" |
2599 }, | 2599 }, |
2600 "scopes": [ | 2600 "scopes": [ |
2601 "https://www.googleapis.com/auth/androidenterprise" | 2601 "https://www.googleapis.com/auth/androidenterprise" |
2602 ] | 2602 ] |
2603 } | 2603 } |
2604 } | 2604 } |
2605 } | 2605 } |
2606 }, | 2606 }, |
2607 "revision": "20170131", | 2607 "revision": "20170222", |
2608 "rootUrl": "https://www.googleapis.com/", | 2608 "rootUrl": "https://www.googleapis.com/", |
2609 "schemas": { | 2609 "schemas": { |
2610 "Administrator": { | 2610 "Administrator": { |
2611 "description": "This represents an enterprise admin who can manage t
he enterprise in the managed Google Play store.", | 2611 "description": "This represents an enterprise admin who can manage t
he enterprise in the managed Google Play store.", |
2612 "id": "Administrator", | 2612 "id": "Administrator", |
2613 "properties": { | 2613 "properties": { |
2614 "email": { | 2614 "email": { |
2615 "description": "The admin's email address.", | 2615 "description": "The admin's email address.", |
2616 "type": "string" | 2616 "type": "string" |
2617 } | 2617 } |
(...skipping 201 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2819 "type": "string" | 2819 "type": "string" |
2820 }, | 2820 }, |
2821 "token": { | 2821 "token": { |
2822 "description": "The authentication token to be passed to the
device policy client on the device where it can be used to provision the accoun
t for which this token was generated.", | 2822 "description": "The authentication token to be passed to the
device policy client on the device where it can be used to provision the accoun
t for which this token was generated.", |
2823 "type": "string" | 2823 "type": "string" |
2824 } | 2824 } |
2825 }, | 2825 }, |
2826 "type": "object" | 2826 "type": "object" |
2827 }, | 2827 }, |
2828 "Device": { | 2828 "Device": { |
2829 "description": "A device resource represents a mobile device managed
by the EMM and belonging to a specific enterprise user.\n\nThis collection cann
ot be modified via the API; it is automatically populated as devices are set up
to be managed.", | 2829 "description": "A Devices resource represents a mobile device manage
d by the EMM and belonging to a specific enterprise user.\n\nThis collection can
not be modified via the API. It is automatically populated as devices are set up
to be managed.", |
2830 "id": "Device", | 2830 "id": "Device", |
2831 "properties": { | 2831 "properties": { |
2832 "androidId": { | 2832 "androidId": { |
2833 "description": "The Google Play Services Android ID for the
device encoded as a lowercase hex string, e.g. \"123456789abcdef0\".", | 2833 "description": "The Google Play Services Android ID for the
device encoded as a lowercase hex string. For example, \"123456789abcdef0\".", |
2834 "type": "string" | 2834 "type": "string" |
2835 }, | 2835 }, |
2836 "kind": { | 2836 "kind": { |
2837 "default": "androidenterprise#device", | 2837 "default": "androidenterprise#device", |
2838 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#device\".", | 2838 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#device\".", |
2839 "type": "string" | 2839 "type": "string" |
2840 }, | 2840 }, |
2841 "managementType": { | 2841 "managementType": { |
2842 "description": "Identifies the extent to which the device is
controlled by a managed Google Play EMM in various deployment configurations.\n
\nPossible values include: \n- \"managedDevice\", a device that has the EMM's de
vice policy controller (DPC) as the device owner, \n- \"managedProfile\", a devi
ce that has a profile managed by the DPC (DPC is profile owner) in addition to a
separate, personal profile that is unavailable to the DPC, \n- \"containerApp\"
, a device running the container App. The container App is managed by the DPC, \
n- \"unmanagedProfile\", a device that has been allowed (by the domain's admin,
using the Admin Console to enable the privilege) to use managed Google Play, but
the profile is itself not owned by a DPC.", | 2842 "description": "Identifies the extent to which the device is
controlled by a managed Google Play EMM in various deployment configurations.\n
\nPossible values include: \n- \"managedDevice\", a device that has the EMM's de
vice policy controller (DPC) as the device owner, \n- \"managedProfile\", a devi
ce that has a profile managed by the DPC (DPC is profile owner) in addition to a
separate, personal profile that is unavailable to the DPC, \n- \"containerApp\"
, a device running the container App. The container App is managed by the DPC, \
n- \"unmanagedProfile\", a device that has been allowed (by the domain's admin,
using the Admin Console to enable the privilege) to use managed Google Play, but
the profile is itself not owned by a DPC.", |
2843 "type": "string" | 2843 "type": "string" |
(...skipping 115 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2959 "type": "string" | 2959 "type": "string" |
2960 }, | 2960 }, |
2961 "topicName": { | 2961 "topicName": { |
2962 "description": "The name of the Cloud Pub/Sub topic to which
notifications for this enterprise's enrolled account will be sent.", | 2962 "description": "The name of the Cloud Pub/Sub topic to which
notifications for this enterprise's enrolled account will be sent.", |
2963 "type": "string" | 2963 "type": "string" |
2964 } | 2964 } |
2965 }, | 2965 }, |
2966 "type": "object" | 2966 "type": "object" |
2967 }, | 2967 }, |
2968 "Entitlement": { | 2968 "Entitlement": { |
2969 "description": "The existence of an entitlement resource means that
a user has the right to use a particular app on any of their devices. This might
be because the app is free or because they have been allocated a license to the
app from a group license purchased by the enterprise.\n\nIt should always be tr
ue that a user has an app installed on one of their devices only if they have an
entitlement to it. So if an entitlement is deleted, the app will be uninstalled
from all devices. Similarly if the user installs an app (and is permitted to do
so), or the EMM triggers an install of the app, an entitlement to that app is a
utomatically created. If this is impossible - e.g. the enterprise has not purcha
sed sufficient licenses - then installation fails.\n\nNote that entitlements are
always user specific, not device specific; a user may have an entitlement even
though they have not installed the app anywhere. Once they have an entitlement t
hey can install the app on multiple devices.\n\nThe API can be used to create an
entitlement. If the app is a free app, a group license for that app is created.
If it's a paid app, creating the entitlement consumes one license; it remains c
onsumed until the entitlement is removed. Optionally an installation of the app
on all the user's managed devices can be triggered at the time the entitlement i
s created. An entitlement cannot be created for an app if the app requires permi
ssions that the enterprise has not yet accepted.\n\nEntitlements for paid apps t
hat are due to purchases by the user on a non-managed profile will have \"userPu
rchase\" as entitlement reason; those entitlements cannot be removed via the API
.", | 2969 "description": "The presence of an Entitlements resource indicates t
hat a user has the right to use a particular app. Entitlements are user specific
, not device specific. This allows a user with an entitlement to an app to insta
ll the app on all their devices. It's also possible for a user to hold an entitl
ement to an app without installing the app on any device.\n\nThe API can be used
to create an entitlement. As an option, you can also use the API to trigger the
installation of an app on all a user's managed devices at the same time the ent
itlement is created.\n\nIf the app is free, creating the entitlement also create
s a group license for that app. For paid apps, creating the entitlement consumes
one license, and that license remains consumed until the entitlement is removed
. If the enterprise hasn't purchased enough licenses, then no entitlement is cre
ated and the installation fails. An entitlement is also not created for an app i
f the app requires permissions that the enterprise hasn't accepted.\n\nIf an ent
itlement is deleted, the app may be uninstalled from a user's device. As a best
practice, uninstall the app by calling Installs.delete() before deleting the en
titlement.\n\nEntitlements for apps that a user pays for on an unmanaged profile
have \"userPurchase\" as the entitlement reason. These entitlements cannot be r
emoved via the API.", |
2970 "id": "Entitlement", | 2970 "id": "Entitlement", |
2971 "properties": { | 2971 "properties": { |
2972 "kind": { | 2972 "kind": { |
2973 "default": "androidenterprise#entitlement", | 2973 "default": "androidenterprise#entitlement", |
2974 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlement\".", | 2974 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlement\".", |
2975 "type": "string" | 2975 "type": "string" |
2976 }, | 2976 }, |
2977 "productId": { | 2977 "productId": { |
2978 "description": "The ID of the product that the entitlement i
s for, e.g. \"app:com.google.android.gm\".", | 2978 "description": "The ID of the product that the entitlement i
s for. For example, \"app:com.google.android.gm\".", |
2979 "type": "string" | 2979 "type": "string" |
2980 }, | 2980 }, |
2981 "reason": { | 2981 "reason": { |
2982 "description": "The reason for the entitlement, e.g. \"free\
" for free apps. This is temporary, it will be replaced by the acquisition kind
field of group licenses.", | 2982 "description": "The reason for the entitlement. For example,
\"free\" for free apps. This property is temporary: it will be replaced by the
acquisition kind field of group licenses.", |
2983 "type": "string" | 2983 "type": "string" |
2984 } | 2984 } |
2985 }, | 2985 }, |
2986 "type": "object" | 2986 "type": "object" |
2987 }, | 2987 }, |
2988 "EntitlementsListResponse": { | 2988 "EntitlementsListResponse": { |
2989 "description": "The entitlement resources for the user.", | 2989 "description": "The entitlement resources for the user.", |
2990 "id": "EntitlementsListResponse", | 2990 "id": "EntitlementsListResponse", |
2991 "properties": { | 2991 "properties": { |
2992 "entitlement": { | 2992 "entitlement": { |
2993 "description": "An entitlement of a user to a product (e.g.
an app). For example, a free app that they have installed, or a paid app that th
ey have been allocated a license to.", | 2993 "description": "An entitlement of a user to a product (e.g.
an app). For example, a free app that they have installed, or a paid app that th
ey have been allocated a license to.", |
2994 "items": { | 2994 "items": { |
2995 "$ref": "Entitlement" | 2995 "$ref": "Entitlement" |
2996 }, | 2996 }, |
2997 "type": "array" | 2997 "type": "array" |
2998 }, | 2998 }, |
2999 "kind": { | 2999 "kind": { |
3000 "default": "androidenterprise#entitlementsListResponse", | 3000 "default": "androidenterprise#entitlementsListResponse", |
3001 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlementsListResponse\".", | 3001 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlementsListResponse\".", |
3002 "type": "string" | 3002 "type": "string" |
3003 } | 3003 } |
3004 }, | 3004 }, |
3005 "type": "object" | 3005 "type": "object" |
3006 }, | 3006 }, |
3007 "GroupLicense": { | 3007 "GroupLicense": { |
3008 "description": "A group license object indicates a product that an e
nterprise admin has approved for use in the enterprise. The product may be free
or paid. For free products, a group license object is created in these cases: if
the enterprise admin approves a product in Google Play, if the product is added
to a collection, or if an entitlement for the product is created for a user via
the API. For paid products, a group license object is only created as part of t
he first bulk purchase of that product in Google Play by the enterprise admin.\n
\nThe API can be used to query group licenses; the available information include
s the total number of licenses purchased (for paid products) and the total numbe
r of licenses that have been provisioned, that is, the total number of user enti
tlements in existence for the product.\n\nGroup license objects are never delete
d. If, for example, a free app is added to a collection and then removed, the gr
oup license will remain, allowing the enterprise admin to keep track of any rema
ining entitlements. An enterprise admin may indicate they are no longer interest
ed in the group license by marking it as unapproved in Google Play.", | 3008 "description": "A group license object indicates a product that an e
nterprise admin has approved for use in the enterprise. The product may be free
or paid. For free products, a group license object is created in these cases: if
the enterprise admin approves a product in Google Play, if the product is added
to a collection, or if an entitlement for the product is created for a user via
the API. For paid products, a group license object is only created as part of t
he first bulk purchase of that product in Google Play by the enterprise admin.\n
\nThe API can be used to query group licenses; the available information include
s the total number of licenses purchased (for paid products) and the total numbe
r of licenses that have been provisioned, that is, the total number of user enti
tlements in existence for the product.\n\nGroup license objects are never delete
d. If, for example, a free app is added to a collection and then removed, the gr
oup license will remain, allowing the enterprise admin to keep track of any rema
ining entitlements. An enterprise admin may indicate they are no longer interest
ed in the group license by marking it as unapproved in Google Play.", |
3009 "id": "GroupLicense", | 3009 "id": "GroupLicense", |
3010 "properties": { | 3010 "properties": { |
3011 "acquisitionKind": { | 3011 "acquisitionKind": { |
3012 "description": "How this group license was acquired. \"bulkP
urchase\" means that this group license object was created because the enterpris
e purchased licenses for this product; this is \"free\" otherwise (for free prod
ucts).", | 3012 "description": "How this group license was acquired. \"bulkP
urchase\" means that this Grouplicenses resource was created because the enterpr
ise purchased licenses for this product; otherwise, the value is \"free\" (for f
ree products).", |
3013 "type": "string" | 3013 "type": "string" |
3014 }, | 3014 }, |
3015 "approval": { | 3015 "approval": { |
3016 "description": "Whether the product to which this group lice
nse relates is currently approved by the enterprise, as either \"approved\" or \
"unapproved\". Products are approved when a group license is first created, but
this approval may be revoked by an enterprise admin via Google Play. Unapproved
products will not be visible to end users in collections and new entitlements to
them should not normally be created.", | 3016 "description": "Whether the product to which this group lice
nse relates is currently approved by the enterprise. Products are approved when
a group license is first created, but this approval may be revoked by an enterpr
ise admin via Google Play. Unapproved products will not be visible to end users
in collections, and new entitlements to them should not normally be created.", |
3017 "type": "string" | 3017 "type": "string" |
3018 }, | 3018 }, |
3019 "kind": { | 3019 "kind": { |
3020 "default": "androidenterprise#groupLicense", | 3020 "default": "androidenterprise#groupLicense", |
3021 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicense\".", | 3021 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicense\".", |
3022 "type": "string" | 3022 "type": "string" |
3023 }, | 3023 }, |
3024 "numProvisioned": { | 3024 "numProvisioned": { |
3025 "description": "The total number of provisioned licenses for
this product. Returned by read operations, but ignored in write operations.", | 3025 "description": "The total number of provisioned licenses for
this product. Returned by read operations, but ignored in write operations.", |
3026 "format": "int32", | 3026 "format": "int32", |
3027 "type": "integer" | 3027 "type": "integer" |
3028 }, | 3028 }, |
3029 "numPurchased": { | 3029 "numPurchased": { |
3030 "description": "The number of purchased licenses (possibly i
n multiple purchases). If this field is omitted then there is no limit on the nu
mber of licenses that can be provisioned (e.g. if the acquisition kind is \"free
\").", | 3030 "description": "The number of purchased licenses (possibly i
n multiple purchases). If this field is omitted, then there is no limit on the n
umber of licenses that can be provisioned (for example, if the acquisition kind
is \"free\").", |
3031 "format": "int32", | 3031 "format": "int32", |
3032 "type": "integer" | 3032 "type": "integer" |
3033 }, | 3033 }, |
3034 "productId": { | 3034 "productId": { |
3035 "description": "The ID of the product that the license is fo
r, e.g. \"app:com.google.android.gm\".", | 3035 "description": "The ID of the product that the license is fo
r. For example, \"app:com.google.android.gm\".", |
3036 "type": "string" | 3036 "type": "string" |
3037 } | 3037 } |
3038 }, | 3038 }, |
3039 "type": "object" | 3039 "type": "object" |
3040 }, | 3040 }, |
3041 "GroupLicenseUsersListResponse": { | 3041 "GroupLicenseUsersListResponse": { |
3042 "description": "The user resources for the group license.", | 3042 "description": "The user resources for the group license.", |
3043 "id": "GroupLicenseUsersListResponse", | 3043 "id": "GroupLicenseUsersListResponse", |
3044 "properties": { | 3044 "properties": { |
3045 "kind": { | 3045 "kind": { |
(...skipping 24 matching lines...) Expand all Loading... |
3070 }, | 3070 }, |
3071 "kind": { | 3071 "kind": { |
3072 "default": "androidenterprise#groupLicensesListResponse", | 3072 "default": "androidenterprise#groupLicensesListResponse", |
3073 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicensesListResponse\".", | 3073 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicensesListResponse\".", |
3074 "type": "string" | 3074 "type": "string" |
3075 } | 3075 } |
3076 }, | 3076 }, |
3077 "type": "object" | 3077 "type": "object" |
3078 }, | 3078 }, |
3079 "Install": { | 3079 "Install": { |
3080 "description": "The existence of an install resource indicates that
an app is installed on a particular device (or that an install is pending).\n\nT
he API can be used to create an install resource using the update method. This t
riggers the actual install of the app on the device. If the user does not alread
y have an entitlement for the app then an attempt is made to create one. If this
fails (e.g. because the app is not free and there is no available license) then
the creation of the install fails.\n\nThe API can also be used to update an ins
talled app. If the update method is used on an existing install then the app wil
l be updated to the latest available version.\n\nNote that it is not possible to
force the installation of a specific version of an app; the version code is rea
d-only.\n\nIf a user installs an app themselves (as permitted by the enterprise)
, then again an install resource and possibly an entitlement resource are automa
tically created.\n\nThe API can also be used to delete an install resource, whic
h triggers the removal of the app from the device. Note that deleting an install
does not automatically remove the corresponding entitlement, even if there are
no remaining installs. The install resource will also be deleted if the user uni
nstalls the app themselves.", | 3080 "description": "The existence of an Installs resource indicates that
an app is installed on a particular device (or that an install is pending).\n\n
The API can be used to create an install resource using the update method. This
triggers the actual install of the app on the device. If the user does not alrea
dy have an entitlement for the app, then an attempt is made to create one. If th
is fails (for example, because the app is not free and there is no available lic
ense), then the creation of the install fails.\n\nThe API can also be used to up
date an installed app. If the update method is used on an existing install, then
the app will be updated to the latest available version.\n\nNote that it is not
possible to force the installation of a specific version of an app: the version
code is read-only.\n\nIf a user installs an app themselves (as permitted by the
enterprise), then again an install resource and possibly an entitlement resourc
e are automatically created.\n\nThe API can also be used to delete an install re
source, which triggers the removal of the app from the device. Note that deletin
g an install does not automatically remove the corresponding entitlement, even i
f there are no remaining installs. The install resource will also be deleted if
the user uninstalls the app themselves.", |
3081 "id": "Install", | 3081 "id": "Install", |
3082 "properties": { | 3082 "properties": { |
3083 "installState": { | 3083 "installState": { |
3084 "description": "Install state. The state \"installPending\"
means that an install request has recently been made and download to the device
is in progress. The state \"installed\" means that the app has been installed. T
his field is read-only.", | 3084 "description": "Install state. The state \"installPending\"
means that an install request has recently been made and download to the device
is in progress. The state \"installed\" means that the app has been installed. T
his field is read-only.", |
3085 "type": "string" | 3085 "type": "string" |
3086 }, | 3086 }, |
3087 "kind": { | 3087 "kind": { |
3088 "default": "androidenterprise#install", | 3088 "default": "androidenterprise#install", |
3089 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#install\".", | 3089 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#install\".", |
3090 "type": "string" | 3090 "type": "string" |
3091 }, | 3091 }, |
3092 "productId": { | 3092 "productId": { |
3093 "description": "The ID of the product that the install is fo
r, e.g. \"app:com.google.android.gm\".", | 3093 "description": "The ID of the product that the install is fo
r. For example, \"app:com.google.android.gm\".", |
3094 "type": "string" | 3094 "type": "string" |
3095 }, | 3095 }, |
3096 "versionCode": { | 3096 "versionCode": { |
3097 "description": "The version of the installed product. Guaran
teed to be set only if the install state is \"installed\".", | 3097 "description": "The version of the installed product. Guaran
teed to be set only if the install state is \"installed\".", |
3098 "format": "int32", | 3098 "format": "int32", |
3099 "type": "integer" | 3099 "type": "integer" |
3100 } | 3100 } |
3101 }, | 3101 }, |
3102 "type": "object" | 3102 "type": "object" |
3103 }, | 3103 }, |
(...skipping 177 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3281 }, | 3281 }, |
3282 "NewDeviceEvent": { | 3282 "NewDeviceEvent": { |
3283 "description": "An event generated when a new device is ready to be
managed.", | 3283 "description": "An event generated when a new device is ready to be
managed.", |
3284 "id": "NewDeviceEvent", | 3284 "id": "NewDeviceEvent", |
3285 "properties": { | 3285 "properties": { |
3286 "deviceId": { | 3286 "deviceId": { |
3287 "description": "The Android ID of the device. This field wil
l always be present.", | 3287 "description": "The Android ID of the device. This field wil
l always be present.", |
3288 "type": "string" | 3288 "type": "string" |
3289 }, | 3289 }, |
3290 "managementType": { | 3290 "managementType": { |
3291 "description": "Identifies the extent to which the device is
controlled by an Android for Work EMM in various deployment configurations.\n\n
Possible values include: \n- \"managedDevice\", a device that has the EMM's devi
ce policy controller (DPC) as the device owner, \n- \"managedProfile\", a device
that has a work profile managed by the DPC (DPC is profile owner) in addition t
o a separate, personal profile that is unavailable to the DPC,", | 3291 "description": "Identifies the extent to which the device is
controlled by an Android EMM in various deployment configurations.\n\nPossible
values include: \n- \"managedDevice\", a device where the DPC is set as device o
wner, \n- \"managedProfile\", a device where the DPC is set as profile owner.", |
3292 "type": "string" | 3292 "type": "string" |
3293 }, | 3293 }, |
3294 "userId": { | 3294 "userId": { |
3295 "description": "The ID of the user. This field will always b
e present.", | 3295 "description": "The ID of the user. This field will always b
e present.", |
3296 "type": "string" | 3296 "type": "string" |
3297 } | 3297 } |
3298 }, | 3298 }, |
3299 "type": "object" | 3299 "type": "object" |
3300 }, | 3300 }, |
3301 "NewPermissionsEvent": { | 3301 "NewPermissionsEvent": { |
(...skipping 100 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3402 "type": "integer" | 3402 "type": "integer" |
3403 }, | 3403 }, |
3404 "totalResults": { | 3404 "totalResults": { |
3405 "format": "int32", | 3405 "format": "int32", |
3406 "type": "integer" | 3406 "type": "integer" |
3407 } | 3407 } |
3408 }, | 3408 }, |
3409 "type": "object" | 3409 "type": "object" |
3410 }, | 3410 }, |
3411 "Permission": { | 3411 "Permission": { |
3412 "description": "A permission represents some extra capability, to be
granted to an Android app, which requires explicit consent. An enterprise admin
must consent to these permissions on behalf of their users before an entitlemen
t for the app can be created.\n\nThe permissions collection is read-only. The in
formation provided for each permission (localized name and description) is inten
ded to be used in the EMM user interface when obtaining consent from the enterpr
ise.", | 3412 "description": "A Permissions resource represents some extra capabil
ity, to be granted to an Android app, which requires explicit consent. An enterp
rise admin must consent to these permissions on behalf of their users before an
entitlement for the app can be created.\n\nThe permissions collection is read-on
ly. The information provided for each permission (localized name and description
) is intended to be used in the MDM user interface when obtaining consent from t
he enterprise.", |
3413 "id": "Permission", | 3413 "id": "Permission", |
3414 "properties": { | 3414 "properties": { |
3415 "description": { | 3415 "description": { |
3416 "description": "A longer description of the permissions givi
ng more details of what it affects.", | 3416 "description": "A longer description of the Permissions reso
urce, giving more details of what it affects.", |
3417 "type": "string" | 3417 "type": "string" |
3418 }, | 3418 }, |
3419 "kind": { | 3419 "kind": { |
3420 "default": "androidenterprise#permission", | 3420 "default": "androidenterprise#permission", |
3421 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#permission\".", | 3421 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#permission\".", |
3422 "type": "string" | 3422 "type": "string" |
3423 }, | 3423 }, |
3424 "name": { | 3424 "name": { |
3425 "description": "The name of the permission.", | 3425 "description": "The name of the permission.", |
3426 "type": "string" | 3426 "type": "string" |
(...skipping 10 matching lines...) Expand all Loading... |
3437 "id": "Product", | 3437 "id": "Product", |
3438 "properties": { | 3438 "properties": { |
3439 "appVersion": { | 3439 "appVersion": { |
3440 "description": "App versions currently available for this pr
oduct. The returned list contains only public versions. Alpha and beta versions
are not included.", | 3440 "description": "App versions currently available for this pr
oduct. The returned list contains only public versions. Alpha and beta versions
are not included.", |
3441 "items": { | 3441 "items": { |
3442 "$ref": "AppVersion" | 3442 "$ref": "AppVersion" |
3443 }, | 3443 }, |
3444 "type": "array" | 3444 "type": "array" |
3445 }, | 3445 }, |
3446 "authorName": { | 3446 "authorName": { |
3447 "description": "The name of the author of the product (e.g.
the app developer).", | 3447 "description": "The name of the author of the product (for e
xample, the app developer).", |
3448 "type": "string" | 3448 "type": "string" |
3449 }, | 3449 }, |
3450 "detailsUrl": { | 3450 "detailsUrl": { |
3451 "description": "A link to the (consumer) Google Play details
page for the product.", | 3451 "description": "A link to the (consumer) Google Play details
page for the product.", |
3452 "type": "string" | 3452 "type": "string" |
3453 }, | 3453 }, |
3454 "distributionChannel": { | 3454 "distributionChannel": { |
3455 "description": "How and to whom the package is made availabl
e. The value publicGoogleHosted means that the package is available through the
Play store and not restricted to a specific enterprise. The value privateGoogleH
osted means that the package is a private app (restricted to an enterprise) but
hosted by Google. The value privateSelfHosted means that the package is a privat
e app (restricted to an enterprise) and is privately hosted.", | 3455 "description": "How and to whom the package is made availabl
e. The value publicGoogleHosted means that the package is available through the
Play store and not restricted to a specific enterprise. The value privateGoogleH
osted means that the package is a private app (restricted to an enterprise) but
hosted by Google. The value privateSelfHosted means that the package is a privat
e app (restricted to an enterprise) and is privately hosted.", |
3456 "type": "string" | 3456 "type": "string" |
3457 }, | 3457 }, |
(...skipping 474 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3932 "type": "array" | 3932 "type": "array" |
3933 } | 3933 } |
3934 }, | 3934 }, |
3935 "type": "object" | 3935 "type": "object" |
3936 } | 3936 } |
3937 }, | 3937 }, |
3938 "servicePath": "androidenterprise/v1/", | 3938 "servicePath": "androidenterprise/v1/", |
3939 "title": "Google Play EMM API", | 3939 "title": "Google Play EMM API", |
3940 "version": "v1" | 3940 "version": "v1" |
3941 } | 3941 } |
OLD | NEW |