Api-roll 21: 2015-08-04

discovery/googleapis/androidenterprise__v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/androidenterprise": {
                     "description": "Manage corporate Android devices"
                 }
             }
         }
     },
     "basePath": "/androidenterprise/v1/",
     "baseUrl": "https://www.googleapis.com/androidenterprise/v1/",
     "batchPath": "batch",
     "canonicalName": "Android Enterprise",
     "description": "Allows MDMs/EMMs and enterprises to manage the deployment of apps to Android for Work users.",
     "discoveryVersion": "v1",
-    "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/VkBuSy958uY6kySPppsXzchEPt4\"",
+    "documentationLink": "https://developers.google.com/play/enterprise",
+    "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/iV3v-C_yUys3U_llqVYPlrZ-gmI\"",
     "icons": {
         "x16": "https://www.google.com/images/icons/product/android-16.png",
         "x32": "https://www.google.com/images/icons/product/android-32.png"
     },
     "id": "androidenterprise:v1",
     "kind": "discovery#restDescription",
     "name": "androidenterprise",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 1284 matching lines @@
                     },
                     "path": "enterprises/{enterpriseId}/products/{productId}/approve",
                     "request": {
                         "$ref": "ProductsApproveRequest"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 },
                 "generateApprovalUrl": {
-                    "description": "Generates a URL that can be used to display an iframe to view the product's permissions (if any) and approve the product. This URL can be used to approve the product for a limited time (currently 1 hour) using the Products.approve call.",
+                    "description": "Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.\n\nAdmins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.",
                     "httpMethod": "POST",
                     "id": "androidenterprise.products.generateApprovalUrl",
                     "parameterOrder": [
                         "enterpriseId",
                         "productId"
                     ],
                     "parameters": {
                         "enterpriseId": {
                             "description": "The ID of the enterprise.",
                             "location": "path",
                             "required": true,
                             "type": "string"
                         },
                         "languageCode": {
-                            "description": "The language code that will be used for permission names and descriptions in the returned iframe.",
+                            "description": "The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance \"en-US\".",
                             "location": "query",
                             "type": "string"
                         },
                         "productId": {
                             "description": "The ID of the product.",
                             "location": "path",
                             "required": true,
                             "type": "string"
                         }
                     },
@@ skipping 195 matching lines @@
                         }
                     },
                     "path": "enterprises/{enterpriseId}/users/{userId}",
                     "response": {
                         "$ref": "User"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 },
+                "getAvailableProductSet": {
+                    "description": "Retrieves the set of products a user is entitled to access.",
+                    "httpMethod": "GET",
+                    "id": "androidenterprise.users.getAvailableProductSet",
+                    "parameterOrder": [
+                        "enterpriseId",
+                        "userId"
+                    ],
+                    "parameters": {
+                        "enterpriseId": {
+                            "description": "The ID of the enterprise.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        },
+                        "userId": {
+                            "description": "The ID of the user.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
+                    "response": {
+                        "$ref": "ProductSet"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/androidenterprise"
+                    ]
+                },
                 "list": {
                     "description": "Looks up a user by email address.",
                     "httpMethod": "GET",
                     "id": "androidenterprise.users.list",
                     "parameterOrder": [
                         "enterpriseId",
                         "email"
                     ],
                     "parameters": {
                         "email": {
@@ skipping 36 matching lines @@
                             "description": "The ID of the user.",
                             "location": "path",
                             "required": true,
                             "type": "string"
                         }
                     },
                     "path": "enterprises/{enterpriseId}/users/{userId}/token",
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
+                },
+                "setAvailableProductSet": {
+                    "description": "Modifies the set of products a user is entitled to access.",
+                    "httpMethod": "PUT",
+                    "id": "androidenterprise.users.setAvailableProductSet",
+                    "parameterOrder": [
+                        "enterpriseId",
+                        "userId"
+                    ],
+                    "parameters": {
+                        "enterpriseId": {
+                            "description": "The ID of the enterprise.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        },
+                        "userId": {
+                            "description": "The ID of the user.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
+                    "request": {
+                        "$ref": "ProductSet"
+                    },
+                    "response": {
+                        "$ref": "ProductSet"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/androidenterprise"
+                    ]
                 }
             }
         }
     },
-    "revision": "20150303",
+    "revision": "20150729",
     "rootUrl": "https://www.googleapis.com/",
     "schemas": {
         "AppRestrictionsSchema": {
             "description": "Represents the list of app restrictions available to be pre-configured for the product.",
             "id": "AppRestrictionsSchema",
             "properties": {
+                "kind": {
+                    "default": "androidenterprise#appRestrictionsSchema",
+                    "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#appRestrictionsSchema\".",
+                    "type": "string"
+                },
                 "restrictions": {
                     "description": "The set of restrictions that make up this schema.",
                     "items": {
                         "$ref": "AppRestrictionsSchemaRestriction"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
@@ skipping 63 matching lines @@
                     "type": "array"
                 },
                 "valueString": {
                     "description": "The string value - this will be present for types string, choice and hidden.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "AppVersion": {
-            "description": "App version represents a single APK version.",
+            "description": "This represents a single version of the app.",
             "id": "AppVersion",
             "properties": {
                 "versionCode": {
-                    "description": "Unique increasing identifier for the apk version.",
+                    "description": "Unique increasing identifier for the app version.",
                     "format": "int32",
                     "type": "integer"
                 },
                 "versionString": {
-                    "description": "The string used in the Play Store by the app developer to identify a version of an app. The string is not necessarily unique or localized (e.g. \"1.4\").",
+                    "description": "The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be \"1.4\").",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "ApprovalUrlInfo": {
             "description": "Information on an approval URL.",
             "id": "ApprovalUrlInfo",
             "properties": {
                 "approvalUrl": {
@@ skipping 38 matching lines @@
                             "androidenterprise.collections.update"
                         ]
                     },
                     "description": "The IDs of the products in the collection, in the order in which they should be displayed.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "visibility": {
-                    "description": "Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.",
+                    "description": "Whether this collection is visible to all users, or only to the users that have been granted access through the \"Collectionviewers\" API. With the launch of the \"setAvailableProductSet\" API, this property should always be set to \"viewersOnly\", as the \"allUsers\" option will bypass the \"availableProductSet\" for all users within a domain.\n\nThe \"allUsers\" setting is deprecated, and will be removed.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "CollectionViewersListResponse": {
             "description": "The user resources for the collection.",
             "id": "CollectionViewersListResponse",
             "properties": {
                 "kind": {
@@ skipping 182 matching lines @@
                 },
                 "kind": {
                     "default": "androidenterprise#entitlementsListResponse",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlementsListResponse\".",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "GroupLicense": {
-            "description": "A group license object indicates a product that an enterprise 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 the first bulk purchase of that product in Google Play done by the enterprise admin.\n\nThe API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, i.e. the total number of user entitlements in existence for the product.\n\nGroup license objects are never deleted; if e.g. a free app is added to a collection and then removed, the group license will remain, allowing to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.",
+            "description": "A group license object indicates a product that an enterprise 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 the 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 includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product.\n\nGroup license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.",
             "id": "GroupLicense",
             "properties": {
                 "acquisitionKind": {
                     "description": "How this group license was acquired. \"bulkPurchase\" means that this group license object was created because the enterprise purchased licenses for this product; this is \"free\" otherwise (for free products).",
                     "type": "string"
                 },
                 "approval": {
                     "description": "Whether the product to which this group license 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.",
                     "type": "string"
                 },
@@ skipping 123 matching lines @@
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "Product": {
             "description": "A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)\n\nThe information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface.",
             "id": "Product",
             "properties": {
                 "appVersion": {
-                    "description": "List of app versions available for this product. The returned list contains only public versions. E.g. alpha, beta or canary versions will not be included.",
+                    "description": "App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included.",
                     "items": {
                         "$ref": "AppVersion"
                     },
                     "type": "array"
                 },
                 "authorName": {
                     "description": "The name of the author of the product (e.g. the app developer).",
                     "type": "string"
                 },
                 "detailsUrl": {
                     "description": "A link to the (consumer) Google Play details page for the product.",
                     "type": "string"
                 },
                 "distributionChannel": {
-                    "description": "How and to whom the package is made available.",
+                    "description": "How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted 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 private app (restricted to an enterprise) and is privately hosted.",
                     "type": "string"
                 },
                 "iconUrl": {
                     "description": "A link to an image that can be used as an icon for the product.",
                     "type": "string"
                 },
                 "kind": {
                     "default": "androidenterprise#product",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#product\".",
                     "type": "string"
                 },
                 "productId": {
-                    "description": "A string of the form \"app:\n\" - e.g. \"app:com.google.android.gm\" represents the GMail app.",
+                    "description": "A string of the form app:<package name>. For example, app:com.google.android.gm represents the Gmail app.",
                     "type": "string"
                 },
                 "requiresContainerApp": {
                     "description": "Whether this app can only be installed on devices using the Android for Work container app.",
                     "type": "boolean"
                 },
                 "title": {
                     "description": "The name of the product.",
                     "type": "string"
                 },
@@ skipping 40 matching lines @@
                     },
                     "type": "array"
                 },
                 "productId": {
                     "description": "The ID of the app that the permissions relate to, e.g. \"app:com.google.android.gm\".",
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "ProductSet": {
+            "description": "A set of products.",
+            "id": "ProductSet",
+            "properties": {
+                "kind": {
+                    "default": "androidenterprise#productSet",
+                    "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
+                    "type": "string"
+                },
+                "productId": {
+                    "description": "The list of product IDs making up the set of products.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "ProductsApproveRequest": {
             "id": "ProductsApproveRequest",
             "properties": {
                 "approvalUrlInfo": {
-                    "$ref": "ApprovalUrlInfo"
+                    "$ref": "ApprovalUrlInfo",
+                    "description": "The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated."
                 }
             },
             "type": "object"
         },
         "ProductsGenerateApprovalUrlResponse": {
             "id": "ProductsGenerateApprovalUrlResponse",
             "properties": {
                 "url": {
-                    "description": "A iframe-able URL that displays a product's permissions (if any). This URL can be used to approve the product only once and for a limited time (1 hour), using the Products.approve call. If the product is not currently approved and has no permissions, this URL will point to an empty page. If the product is currently approved and all of its permissions (if any) are also approved, this field will not be populated.",
+                    "description": "A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "User": {
             "description": "A user resource represents an individual user within the enterprise's domain.\n\nNote that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.\n\nThe ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.",
             "id": "User",
             "properties": {
                 "id": {
@@ skipping 49 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "androidenterprise/v1/",
     "title": "Google Play EMM API",
     "version": "v1"
 }