Skip to content

Commit

Permalink
feat(androidpublisher): update the api
Browse files Browse the repository at this point in the history
#### androidpublisher:v3

The following keys were added:
- resources.apprecovery.methods.addTargeting (Total Keys: 15)
- resources.apprecovery.methods.appRecoveries (Total Keys: 13)
- resources.apprecovery.methods.cancel (Total Keys: 15)
- resources.apprecovery.methods.create (Total Keys: 11)
- resources.apprecovery.methods.deploy (Total Keys: 15)
- resources.purchases.resources.subscriptionsv2.methods.revoke (Total Keys: 14)
- schemas.AddTargetingRequest (Total Keys: 3)
- schemas.AddTargetingResponse (Total Keys: 2)
- schemas.AllUsers (Total Keys: 3)
- schemas.AndroidSdks (Total Keys: 5)
- schemas.AppRecoveryAction (Total Keys: 15)
- schemas.AppVersionList (Total Keys: 5)
- schemas.AppVersionRange (Total Keys: 6)
- schemas.CancelAppRecoveryRequest (Total Keys: 2)
- schemas.CancelAppRecoveryResponse (Total Keys: 2)
- schemas.CreateDraftAppRecoveryRequest (Total Keys: 4)
- schemas.DeployAppRecoveryRequest (Total Keys: 2)
- schemas.DeployAppRecoveryResponse (Total Keys: 2)
- schemas.GeneratedApksPerSigningKey.properties.generatedRecoveryModules (Total Keys: 2)
- schemas.GeneratedRecoveryApk (Total Keys: 7)
- schemas.ListAppRecoveriesResponse (Total Keys: 4)
- schemas.Regions (Total Keys: 4)
- schemas.RemoteInAppUpdate (Total Keys: 15)
- schemas.RevocationContext (Total Keys: 5)
- schemas.RevokeSubscriptionPurchaseRequest (Total Keys: 3)
- schemas.RevokeSubscriptionPurchaseResponse (Total Keys: 2)
- schemas.Targeting (Total Keys: 12)
  • Loading branch information
yoshi-automation committed Jan 16, 2024
1 parent 143270d commit 9c188bf
Show file tree
Hide file tree
Showing 5 changed files with 957 additions and 1 deletion.
343 changes: 343 additions & 0 deletions docs/dyn/androidpublisher_v3.apprecovery.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,343 @@
<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="#appRecoveries">appRecoveries(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>
<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>
<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.
&quot;targetingUpdate&quot;: { # Update type for targeting. Note it is always a subset Targeting. # Specifies targeting updates such as regions, android sdk versions etc.
&quot;allUsers&quot;: { # Object representation to describe all set of users. # All users are targeted.
&quot;isAllUsersRequested&quot;: True or False, # Required. Set to true if all set of users are needed.
},
&quot;androidSdks&quot;: { # Android api level targeting data for app recovery action targeting. # Additional android sdk levels are targeted by the recovery action.
&quot;sdkLevels&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;regions&quot;: { # Region targeting data for app recovery action targeting. # Additional regions are targeted by the recovery action.
&quot;regionCode&quot;: [ # 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.
&quot;A String&quot;,
],
},
},
}

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="appRecoveries">appRecoveries(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
&quot;recoveryActions&quot;: [ # List of recovery actions associated with the requested package name.
{ # Information about an app recovery action.
&quot;appRecoveryId&quot;: &quot;A String&quot;, # ID corresponding to the app recovery action.
&quot;cancelTime&quot;: &quot;A String&quot;, # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
&quot;createTime&quot;: &quot;A String&quot;, # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
&quot;deployTime&quot;: &quot;A String&quot;, # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
&quot;lastUpdateTime&quot;: &quot;A String&quot;, # 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.
&quot;remoteInAppUpdateData&quot;: { # 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.
&quot;remoteAppUpdateDataPerBundle&quot;: [ # Data related to the recovery action at bundle level.
{ # Data related to the recovery action at bundle level.
&quot;recoveredDeviceCount&quot;: &quot;A String&quot;, # Total number of devices which have been rescued.
&quot;totalDeviceCount&quot;: &quot;A String&quot;, # Total number of devices affected by this recovery action associated with bundle of the app.
&quot;versionCode&quot;: &quot;A String&quot;, # Version Code corresponding to the target bundle.
},
],
},
&quot;status&quot;: &quot;A String&quot;, # The status of the recovery action.
&quot;targeting&quot;: { # 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.
&quot;allUsers&quot;: { # Object representation to describe all set of users. # All users are targeted.
&quot;isAllUsersRequested&quot;: True or False, # Required. Set to true if all set of users are needed.
},
&quot;androidSdks&quot;: { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
&quot;sdkLevels&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;regions&quot;: { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
&quot;regionCode&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;versionList&quot;: { # Data format for a list of app versions. Only one app version is supported for now. # Target version codes as a list.
&quot;versionCodes&quot;: [ # List of app version codes.
&quot;A String&quot;,
],
},
&quot;versionRange&quot;: { # Data format for a continuous range of app versions. # Target version codes as a range.
&quot;versionCodeEnd&quot;: &quot;A String&quot;, # Highest app version in the range, inclusive.
&quot;versionCodeStart&quot;: &quot;A String&quot;, # Lowest app version in the range, inclusive.
},
},
},
],
}</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.
&quot;remoteInAppUpdate&quot;: { # 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.
&quot;isRemoteInAppUpdateRequested&quot;: True or False, # Required. Set to true if Remote In-App Update action type is needed.
},
&quot;targeting&quot;: { # 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.
&quot;allUsers&quot;: { # Object representation to describe all set of users. # All users are targeted.
&quot;isAllUsersRequested&quot;: True or False, # Required. Set to true if all set of users are needed.
},
&quot;androidSdks&quot;: { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
&quot;sdkLevels&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;regions&quot;: { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
&quot;regionCode&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;versionList&quot;: { # Data format for a list of app versions. Only one app version is supported for now. # Target version codes as a list.
&quot;versionCodes&quot;: [ # List of app version codes.
&quot;A String&quot;,
],
},
&quot;versionRange&quot;: { # Data format for a continuous range of app versions. # Target version codes as a range.
&quot;versionCodeEnd&quot;: &quot;A String&quot;, # Highest app version in the range, inclusive.
&quot;versionCodeStart&quot;: &quot;A String&quot;, # 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.
&quot;appRecoveryId&quot;: &quot;A String&quot;, # ID corresponding to the app recovery action.
&quot;cancelTime&quot;: &quot;A String&quot;, # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
&quot;createTime&quot;: &quot;A String&quot;, # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
&quot;deployTime&quot;: &quot;A String&quot;, # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
&quot;lastUpdateTime&quot;: &quot;A String&quot;, # 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.
&quot;remoteInAppUpdateData&quot;: { # 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.
&quot;remoteAppUpdateDataPerBundle&quot;: [ # Data related to the recovery action at bundle level.
{ # Data related to the recovery action at bundle level.
&quot;recoveredDeviceCount&quot;: &quot;A String&quot;, # Total number of devices which have been rescued.
&quot;totalDeviceCount&quot;: &quot;A String&quot;, # Total number of devices affected by this recovery action associated with bundle of the app.
&quot;versionCode&quot;: &quot;A String&quot;, # Version Code corresponding to the target bundle.
},
],
},
&quot;status&quot;: &quot;A String&quot;, # The status of the recovery action.
&quot;targeting&quot;: { # 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.
&quot;allUsers&quot;: { # Object representation to describe all set of users. # All users are targeted.
&quot;isAllUsersRequested&quot;: True or False, # Required. Set to true if all set of users are needed.
},
&quot;androidSdks&quot;: { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
&quot;sdkLevels&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;regions&quot;: { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
&quot;regionCode&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;versionList&quot;: { # Data format for a list of app versions. Only one app version is supported for now. # Target version codes as a list.
&quot;versionCodes&quot;: [ # List of app version codes.
&quot;A String&quot;,
],
},
&quot;versionRange&quot;: { # Data format for a continuous range of app versions. # Target version codes as a range.
&quot;versionCodeEnd&quot;: &quot;A String&quot;, # Highest app version in the range, inclusive.
&quot;versionCodeStart&quot;: &quot;A String&quot;, # 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>

</body></html>
8 changes: 8 additions & 0 deletions docs/dyn/androidpublisher_v3.generatedapks.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,14 @@ <h3>Method Details</h3>
&quot;version&quot;: &quot;A String&quot;, # Asset module version.
},
],
&quot;generatedRecoveryModules&quot;: [ # Generated recovery apks for recovery actions signed with a key corresponding to certificate_sha256_hash. This includes all generated recovery APKs, also those in draft or cancelled state. This field is not set if no recovery actions were created for this signing key.
{ # Download metadata for an app recovery module.
&quot;downloadId&quot;: &quot;A String&quot;, # Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method.
&quot;moduleName&quot;: &quot;A String&quot;, # Name of the module which recovery apk belongs to.
&quot;recoveryId&quot;: &quot;A String&quot;, # ID of the recovery action.
&quot;recoveryStatus&quot;: &quot;A String&quot;, # The status of the recovery action corresponding to the recovery apk.
},
],
&quot;generatedSplitApks&quot;: [ # List of generated split APKs, signed with a key corresponding to certificate_sha256_hash.
{ # Download metadata for a split APK.
&quot;downloadId&quot;: &quot;A String&quot;, # Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method.
Expand Down
5 changes: 5 additions & 0 deletions docs/dyn/androidpublisher_v3.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the applications Resource.</p>

<p class="toc_element">
<code><a href="androidpublisher_v3.apprecovery.html">apprecovery()</a></code>
</p>
<p class="firstline">Returns the apprecovery Resource.</p>

<p class="toc_element">
<code><a href="androidpublisher_v3.edits.html">edits()</a></code>
</p>
Expand Down

0 comments on commit 9c188bf

Please sign in to comment.