| 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="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.apprecovery.html">apprecovery</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#addTargeting">addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None)</a></code></p> |
| 79 |
<p class="firstline">Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#cancel">cancel(packageName, appRecoveryId, body=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#close">close()</a></code></p> |
| 85 |
<p class="firstline">Close httplib2 connections.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#create">create(packageName, body=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#deploy">deploy(packageName, appRecoveryId, body=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE.</p> |
| 92 |
<p class="toc_element"> |
| 93 |
<code><a href="#list">list(packageName, versionCode=None, x__xgafv=None)</a></code></p> |
| 94 |
<p class="firstline">List all app recovery action resources associated with a particular package name and app version.</p> |
| 95 |
<h3>Method Details</h3> |
| 96 |
<div class="method"> |
| 97 |
<code class="details" id="addTargeting">addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None)</code> |
| 98 |
<pre>Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded. |
| 99 |
|
| 100 |
Args: |
| 101 |
packageName: string, Required. Package name of the app for which recovery action is to be updated. (required) |
| 102 |
appRecoveryId: string, Required. ID corresponding to the app recovery action. (required) |
| 103 |
body: object, The request body. |
| 104 |
The object takes the form of: |
| 105 |
|
| 106 |
{ # Request message for AddTargeting. |
| 107 |
"targetingUpdate": { # Update type for targeting. Note it is always a subset Targeting. # Specifies targeting updates such as regions, android sdk versions etc. |
| 108 |
"allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| 109 |
"isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| 110 |
}, |
| 111 |
"androidSdks": { # Android api level targeting data for app recovery action targeting. # Additional android sdk levels are targeted by the recovery action. |
| 112 |
"sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android. |
| 113 |
"A String", |
| 114 |
], |
| 115 |
}, |
| 116 |
"regions": { # Region targeting data for app recovery action targeting. # Additional regions are targeted by the recovery action. |
| 117 |
"regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes. |
| 118 |
"A String", |
| 119 |
], |
| 120 |
}, |
| 121 |
}, |
| 122 |
} |
| 123 |
|
| 124 |
x__xgafv: string, V1 error format. |
| 125 |
Allowed values |
| 126 |
1 - v1 error format |
| 127 |
2 - v2 error format |
| 128 |
|
| 129 |
Returns: |
| 130 |
An object of the form: |
| 131 |
|
| 132 |
{ # Response message for AddTargeting. |
| 133 |
}</pre> |
| 134 |
</div> |
| 135 |
|
| 136 |
<div class="method"> |
| 137 |
<code class="details" id="cancel">cancel(packageName, appRecoveryId, body=None, x__xgafv=None)</code> |
| 138 |
<pre>Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED. |
| 139 |
|
| 140 |
Args: |
| 141 |
packageName: string, Required. Package name of the app for which recovery action cancellation is requested. (required) |
| 142 |
appRecoveryId: string, Required. ID corresponding to the app recovery action. (required) |
| 143 |
body: object, The request body. |
| 144 |
The object takes the form of: |
| 145 |
|
| 146 |
{ # Request message for CancelAppRecovery. |
| 147 |
} |
| 148 |
|
| 149 |
x__xgafv: string, V1 error format. |
| 150 |
Allowed values |
| 151 |
1 - v1 error format |
| 152 |
2 - v2 error format |
| 153 |
|
| 154 |
Returns: |
| 155 |
An object of the form: |
| 156 |
|
| 157 |
{ # Response message for CancelAppRecovery. |
| 158 |
}</pre> |
| 159 |
</div> |
| 160 |
|
| 161 |
<div class="method"> |
| 162 |
<code class="details" id="close">close()</code> |
| 163 |
<pre>Close httplib2 connections.</pre> |
| 164 |
</div> |
| 165 |
|
| 166 |
<div class="method"> |
| 167 |
<code class="details" id="create">create(packageName, body=None, x__xgafv=None)</code> |
| 168 |
<pre>Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action. |
| 169 |
|
| 170 |
Args: |
| 171 |
packageName: string, Required. Package name of the app on which recovery action is performed. (required) |
| 172 |
body: object, The request body. |
| 173 |
The object takes the form of: |
| 174 |
|
| 175 |
{ # Request message for CreateDraftAppRecovery. |
| 176 |
"remoteInAppUpdate": { # Object representation for Remote in-app update action type. # Action type is remote in-app update. As a consequence of this action, a downloadable recovery module is also created for testing purposes. |
| 177 |
"isRemoteInAppUpdateRequested": True or False, # Required. Set to true if Remote In-App Update action type is needed. |
| 178 |
}, |
| 179 |
"targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc. |
| 180 |
"allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| 181 |
"isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| 182 |
}, |
| 183 |
"androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices. |
| 184 |
"sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android. |
| 185 |
"A String", |
| 186 |
], |
| 187 |
}, |
| 188 |
"regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region. |
| 189 |
"regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes. |
| 190 |
"A String", |
| 191 |
], |
| 192 |
}, |
| 193 |
"versionList": { # Data format for a list of app versions. # Target version codes as a list. |
| 194 |
"versionCodes": [ # List of app version codes. |
| 195 |
"A String", |
| 196 |
], |
| 197 |
}, |
| 198 |
"versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range. |
| 199 |
"versionCodeEnd": "A String", # Highest app version in the range, inclusive. |
| 200 |
"versionCodeStart": "A String", # Lowest app version in the range, inclusive. |
| 201 |
}, |
| 202 |
}, |
| 203 |
} |
| 204 |
|
| 205 |
x__xgafv: string, V1 error format. |
| 206 |
Allowed values |
| 207 |
1 - v1 error format |
| 208 |
2 - v2 error format |
| 209 |
|
| 210 |
Returns: |
| 211 |
An object of the form: |
| 212 |
|
| 213 |
{ # Information about an app recovery action. |
| 214 |
"appRecoveryId": "A String", # ID corresponding to the app recovery action. |
| 215 |
"cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled. |
| 216 |
"createTime": "A String", # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action. |
| 217 |
"deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed. |
| 218 |
"lastUpdateTime": "A String", # Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action. |
| 219 |
"remoteInAppUpdateData": { # Data related to Remote In-App Update action such as recovered user count, affected user count etc. # Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update. |
| 220 |
"remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level. |
| 221 |
{ # Data related to the recovery action at bundle level. |
| 222 |
"recoveredDeviceCount": "A String", # Total number of devices which have been rescued. |
| 223 |
"totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app. |
| 224 |
"versionCode": "A String", # Version Code corresponding to the target bundle. |
| 225 |
}, |
| 226 |
], |
| 227 |
}, |
| 228 |
"status": "A String", # The status of the recovery action. |
| 229 |
"targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc. |
| 230 |
"allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| 231 |
"isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| 232 |
}, |
| 233 |
"androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices. |
| 234 |
"sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android. |
| 235 |
"A String", |
| 236 |
], |
| 237 |
}, |
| 238 |
"regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region. |
| 239 |
"regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes. |
| 240 |
"A String", |
| 241 |
], |
| 242 |
}, |
| 243 |
"versionList": { # Data format for a list of app versions. # Target version codes as a list. |
| 244 |
"versionCodes": [ # List of app version codes. |
| 245 |
"A String", |
| 246 |
], |
| 247 |
}, |
| 248 |
"versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range. |
| 249 |
"versionCodeEnd": "A String", # Highest app version in the range, inclusive. |
| 250 |
"versionCodeStart": "A String", # Lowest app version in the range, inclusive. |
| 251 |
}, |
| 252 |
}, |
| 253 |
}</pre> |
| 254 |
</div> |
| 255 |
|
| 256 |
<div class="method"> |
| 257 |
<code class="details" id="deploy">deploy(packageName, appRecoveryId, body=None, x__xgafv=None)</code> |
| 258 |
<pre>Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE. |
| 259 |
|
| 260 |
Args: |
| 261 |
packageName: string, Required. Package name of the app for which recovery action is deployed. (required) |
| 262 |
appRecoveryId: string, Required. ID corresponding to the app recovery action to deploy. (required) |
| 263 |
body: object, The request body. |
| 264 |
The object takes the form of: |
| 265 |
|
| 266 |
{ # Request message for DeployAppRecovery. |
| 267 |
} |
| 268 |
|
| 269 |
x__xgafv: string, V1 error format. |
| 270 |
Allowed values |
| 271 |
1 - v1 error format |
| 272 |
2 - v2 error format |
| 273 |
|
| 274 |
Returns: |
| 275 |
An object of the form: |
| 276 |
|
| 277 |
{ # Response message for DeployAppRecovery. |
| 278 |
}</pre> |
| 279 |
</div> |
| 280 |
|
| 281 |
<div class="method"> |
| 282 |
<code class="details" id="list">list(packageName, versionCode=None, x__xgafv=None)</code> |
| 283 |
<pre>List all app recovery action resources associated with a particular package name and app version. |
| 284 |
|
| 285 |
Args: |
| 286 |
packageName: string, Required. Package name of the app for which list of recovery actions is requested. (required) |
| 287 |
versionCode: string, Required. Version code targeted by the list of recovery actions. |
| 288 |
x__xgafv: string, V1 error format. |
| 289 |
Allowed values |
| 290 |
1 - v1 error format |
| 291 |
2 - v2 error format |
| 292 |
|
| 293 |
Returns: |
| 294 |
An object of the form: |
| 295 |
|
| 296 |
{ # Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled |
| 297 |
"recoveryActions": [ # List of recovery actions associated with the requested package name. |
| 298 |
{ # Information about an app recovery action. |
| 299 |
"appRecoveryId": "A String", # ID corresponding to the app recovery action. |
| 300 |
"cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled. |
| 301 |
"createTime": "A String", # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action. |
| 302 |
"deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed. |
| 303 |
"lastUpdateTime": "A String", # Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action. |
| 304 |
"remoteInAppUpdateData": { # Data related to Remote In-App Update action such as recovered user count, affected user count etc. # Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update. |
| 305 |
"remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level. |
| 306 |
{ # Data related to the recovery action at bundle level. |
| 307 |
"recoveredDeviceCount": "A String", # Total number of devices which have been rescued. |
| 308 |
"totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app. |
| 309 |
"versionCode": "A String", # Version Code corresponding to the target bundle. |
| 310 |
}, |
| 311 |
], |
| 312 |
}, |
| 313 |
"status": "A String", # The status of the recovery action. |
| 314 |
"targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc. |
| 315 |
"allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| 316 |
"isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| 317 |
}, |
| 318 |
"androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices. |
| 319 |
"sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android. |
| 320 |
"A String", |
| 321 |
], |
| 322 |
}, |
| 323 |
"regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region. |
| 324 |
"regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes. |
| 325 |
"A String", |
| 326 |
], |
| 327 |
}, |
| 328 |
"versionList": { # Data format for a list of app versions. # Target version codes as a list. |
| 329 |
"versionCodes": [ # List of app version codes. |
| 330 |
"A String", |
| 331 |
], |
| 332 |
}, |
| 333 |
"versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range. |
| 334 |
"versionCodeEnd": "A String", # Highest app version in the range, inclusive. |
| 335 |
"versionCodeStart": "A String", # Lowest app version in the range, inclusive. |
| 336 |
}, |
| 337 |
}, |
| 338 |
}, |
| 339 |
], |
| 340 |
}</pre> |
| 341 |
</div> |
| 342 |
|
| 343 |
</body></html> |