1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.entitlements.html">entitlements</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(enterpriseId, userId, entitlementId)</a></code></p> 79 <p class="firstline">Removes an entitlement to an app for a user.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(enterpriseId, userId, entitlementId)</a></code></p> 82 <p class="firstline">Retrieves details of an entitlement.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(enterpriseId, userId)</a></code></p> 85 <p class="firstline">Lists all entitlements for the specified user. Only the ID is set.</p> 86 <p class="toc_element"> 87 <code><a href="#patch">patch(enterpriseId, userId, entitlementId, body, install=None)</a></code></p> 88 <p class="firstline">Adds or updates an entitlement to an app for a user. This method supports patch semantics.</p> 89 <p class="toc_element"> 90 <code><a href="#update">update(enterpriseId, userId, entitlementId, body, install=None)</a></code></p> 91 <p class="firstline">Adds or updates an entitlement to an app for a user.</p> 92 <h3>Method Details</h3> 93 <div class="method"> 94 <code class="details" id="delete">delete(enterpriseId, userId, entitlementId)</code> 95 <pre>Removes an entitlement to an app for a user. 96 97 Args: 98 enterpriseId: string, The ID of the enterprise. (required) 99 userId: string, The ID of the user. (required) 100 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required) 101 </pre> 102 </div> 103 104 <div class="method"> 105 <code class="details" id="get">get(enterpriseId, userId, entitlementId)</code> 106 <pre>Retrieves details of an entitlement. 107 108 Args: 109 enterpriseId: string, The ID of the enterprise. (required) 110 userId: string, The ID of the user. (required) 111 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required) 112 113 Returns: 114 An object of the form: 115 116 { # The presence of an Entitlements resource indicates that 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 install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. 117 # 118 # The 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 entitlement is created. 119 # 120 # If the app is free, creating the entitlement also creates 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 created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. 121 # 122 # If an entitlement 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 entitlement. 123 # 124 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. 125 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". 126 "reason": "A String", # 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. 127 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". 128 }</pre> 129 </div> 130 131 <div class="method"> 132 <code class="details" id="list">list(enterpriseId, userId)</code> 133 <pre>Lists all entitlements for the specified user. Only the ID is set. 134 135 Args: 136 enterpriseId: string, The ID of the enterprise. (required) 137 userId: string, The ID of the user. (required) 138 139 Returns: 140 An object of the form: 141 142 { # The entitlement resources for the user. 143 "kind": "androidenterprise#entitlementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse". 144 "entitlement": [ # 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 they have been allocated a license to. 145 { # The presence of an Entitlements resource indicates that 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 install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. 146 # 147 # The 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 entitlement is created. 148 # 149 # If the app is free, creating the entitlement also creates 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 created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. 150 # 151 # If an entitlement 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 entitlement. 152 # 153 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. 154 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". 155 "reason": "A String", # 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. 156 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". 157 }, 158 ], 159 }</pre> 160 </div> 161 162 <div class="method"> 163 <code class="details" id="patch">patch(enterpriseId, userId, entitlementId, body, install=None)</code> 164 <pre>Adds or updates an entitlement to an app for a user. This method supports patch semantics. 165 166 Args: 167 enterpriseId: string, The ID of the enterprise. (required) 168 userId: string, The ID of the user. (required) 169 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required) 170 body: object, The request body. (required) 171 The object takes the form of: 172 173 { # The presence of an Entitlements resource indicates that 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 install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. 174 # 175 # The 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 entitlement is created. 176 # 177 # If the app is free, creating the entitlement also creates 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 created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. 178 # 179 # If an entitlement 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 entitlement. 180 # 181 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. 182 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". 183 "reason": "A String", # 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. 184 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". 185 } 186 187 install: boolean, Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. 188 189 Returns: 190 An object of the form: 191 192 { # The presence of an Entitlements resource indicates that 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 install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. 193 # 194 # The 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 entitlement is created. 195 # 196 # If the app is free, creating the entitlement also creates 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 created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. 197 # 198 # If an entitlement 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 entitlement. 199 # 200 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. 201 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". 202 "reason": "A String", # 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. 203 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". 204 }</pre> 205 </div> 206 207 <div class="method"> 208 <code class="details" id="update">update(enterpriseId, userId, entitlementId, body, install=None)</code> 209 <pre>Adds or updates an entitlement to an app for a user. 210 211 Args: 212 enterpriseId: string, The ID of the enterprise. (required) 213 userId: string, The ID of the user. (required) 214 entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required) 215 body: object, The request body. (required) 216 The object takes the form of: 217 218 { # The presence of an Entitlements resource indicates that 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 install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. 219 # 220 # The 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 entitlement is created. 221 # 222 # If the app is free, creating the entitlement also creates 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 created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. 223 # 224 # If an entitlement 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 entitlement. 225 # 226 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. 227 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". 228 "reason": "A String", # 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. 229 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". 230 } 231 232 install: boolean, Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. 233 234 Returns: 235 An object of the form: 236 237 { # The presence of an Entitlements resource indicates that 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 install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. 238 # 239 # The 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 entitlement is created. 240 # 241 # If the app is free, creating the entitlement also creates 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 created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. 242 # 243 # If an entitlement 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 entitlement. 244 # 245 # Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. 246 "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". 247 "reason": "A String", # 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. 248 "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". 249 }</pre> 250 </div> 251 252 </body></html>
