| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.apprecovery.html">apprecovery</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#addTargeting">addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None)</a></code></p> |
| <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> |
| <p class="toc_element"> |
| <code><a href="#cancel">cancel(packageName, appRecoveryId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(packageName, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action.</p> |
| <p class="toc_element"> |
| <code><a href="#deploy">deploy(packageName, appRecoveryId, body=None, x__xgafv=None)</a></code></p> |
| <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> |
| <p class="toc_element"> |
| <code><a href="#list">list(packageName, versionCode=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List all app recovery action resources associated with a particular package name and app version.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="addTargeting">addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None)</code> |
| <pre>Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded. |
| |
| Args: |
| packageName: string, Required. Package name of the app for which recovery action is to be updated. (required) |
| appRecoveryId: string, Required. ID corresponding to the app recovery action. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for AddTargeting. |
| "targetingUpdate": { # Update type for targeting. Note it is always a subset Targeting. # Specifies targeting updates such as regions, android sdk versions etc. |
| "allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| }, |
| "androidSdks": { # Android api level targeting data for app recovery action targeting. # Additional android sdk levels are targeted by the recovery action. |
| "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. |
| "A String", |
| ], |
| }, |
| "regions": { # Region targeting data for app recovery action targeting. # Additional regions are targeted by the recovery action. |
| "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. |
| "A String", |
| ], |
| }, |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for AddTargeting. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="cancel">cancel(packageName, appRecoveryId, body=None, x__xgafv=None)</code> |
| <pre>Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED. |
| |
| Args: |
| packageName: string, Required. Package name of the app for which recovery action cancellation is requested. (required) |
| appRecoveryId: string, Required. ID corresponding to the app recovery action. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CancelAppRecovery. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for CancelAppRecovery. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(packageName, body=None, x__xgafv=None)</code> |
| <pre>Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action. |
| |
| Args: |
| packageName: string, Required. Package name of the app on which recovery action is performed. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CreateDraftAppRecovery. |
| "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. |
| "isRemoteInAppUpdateRequested": True or False, # Required. Set to true if Remote In-App Update action type is needed. |
| }, |
| "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. |
| "allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| }, |
| "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices. |
| "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. |
| "A String", |
| ], |
| }, |
| "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region. |
| "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. |
| "A String", |
| ], |
| }, |
| "versionList": { # Data format for a list of app versions. # Target version codes as a list. |
| "versionCodes": [ # List of app version codes. |
| "A String", |
| ], |
| }, |
| "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range. |
| "versionCodeEnd": "A String", # Highest app version in the range, inclusive. |
| "versionCodeStart": "A String", # Lowest app version in the range, inclusive. |
| }, |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Information about an app recovery action. |
| "appRecoveryId": "A String", # ID corresponding to the app recovery action. |
| "cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled. |
| "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. |
| "deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed. |
| "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. |
| "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. |
| "remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level. |
| { # Data related to the recovery action at bundle level. |
| "recoveredDeviceCount": "A String", # Total number of devices which have been rescued. |
| "totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app. |
| "versionCode": "A String", # Version Code corresponding to the target bundle. |
| }, |
| ], |
| }, |
| "status": "A String", # The status of the recovery action. |
| "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. |
| "allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| }, |
| "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices. |
| "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. |
| "A String", |
| ], |
| }, |
| "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region. |
| "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. |
| "A String", |
| ], |
| }, |
| "versionList": { # Data format for a list of app versions. # Target version codes as a list. |
| "versionCodes": [ # List of app version codes. |
| "A String", |
| ], |
| }, |
| "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range. |
| "versionCodeEnd": "A String", # Highest app version in the range, inclusive. |
| "versionCodeStart": "A String", # Lowest app version in the range, inclusive. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deploy">deploy(packageName, appRecoveryId, body=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| packageName: string, Required. Package name of the app for which recovery action is deployed. (required) |
| appRecoveryId: string, Required. ID corresponding to the app recovery action to deploy. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for DeployAppRecovery. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for DeployAppRecovery. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(packageName, versionCode=None, x__xgafv=None)</code> |
| <pre>List all app recovery action resources associated with a particular package name and app version. |
| |
| Args: |
| packageName: string, Required. Package name of the app for which list of recovery actions is requested. (required) |
| versionCode: string, Required. Version code targeted by the list of recovery actions. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled |
| "recoveryActions": [ # List of recovery actions associated with the requested package name. |
| { # Information about an app recovery action. |
| "appRecoveryId": "A String", # ID corresponding to the app recovery action. |
| "cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled. |
| "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. |
| "deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed. |
| "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. |
| "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. |
| "remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level. |
| { # Data related to the recovery action at bundle level. |
| "recoveredDeviceCount": "A String", # Total number of devices which have been rescued. |
| "totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app. |
| "versionCode": "A String", # Version Code corresponding to the target bundle. |
| }, |
| ], |
| }, |
| "status": "A String", # The status of the recovery action. |
| "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. |
| "allUsers": { # Object representation to describe all set of users. # All users are targeted. |
| "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed. |
| }, |
| "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices. |
| "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. |
| "A String", |
| ], |
| }, |
| "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region. |
| "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. |
| "A String", |
| ], |
| }, |
| "versionList": { # Data format for a list of app versions. # Target version codes as a list. |
| "versionCodes": [ # List of app version codes. |
| "A String", |
| ], |
| }, |
| "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range. |
| "versionCodeEnd": "A String", # Highest app version in the range, inclusive. |
| "versionCodeStart": "A String", # Lowest app version in the range, inclusive. |
| }, |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |