googleapis
Version:
Google APIs Client Library for Node.js
1,350 lines • 864 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace androidpublisher_v3 {
export interface Options extends GlobalOptions {
version: 'v3';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Play Android Developer API
*
* Lets Android application developers access their Google Play accounts. At a high level, the expected workflow is to "insert" an Edit, make changes as necessary, and then "commit" it.
*
* @example
* ```js
* const {google} = require('googleapis');
* const androidpublisher = google.androidpublisher('v3');
* ```
*/
export class Androidpublisher {
context: APIRequestContext;
applications: Resource$Applications;
apprecovery: Resource$Apprecovery;
appstoreappsreview: Resource$Appstoreappsreview;
appstorecatalog: Resource$Appstorecatalog;
edits: Resource$Edits;
externaltransactions: Resource$Externaltransactions;
generatedapks: Resource$Generatedapks;
grants: Resource$Grants;
inappproducts: Resource$Inappproducts;
internalappsharingartifacts: Resource$Internalappsharingartifacts;
monetization: Resource$Monetization;
orders: Resource$Orders;
purchases: Resource$Purchases;
reviews: Resource$Reviews;
systemapks: Resource$Systemapks;
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents an Abi.
*/
export interface Schema$Abi {
/**
* Alias for an abi.
*/
alias?: string | null;
}
/**
* Targeting based on Abi.
*/
export interface Schema$AbiTargeting {
/**
* Targeting of other sibling directories that were in the Bundle. For main splits this is targeting of other main splits.
*/
alternatives?: Schema$Abi[];
/**
* Value of an abi.
*/
value?: Schema$Abi[];
}
/**
* Represents a targeting rule of the form: User never had {scope\} before.
*/
export interface Schema$AcquisitionTargetingRule {
/**
* Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app".
*/
scope?: Schema$TargetingRuleScope;
}
/**
* Request message for ActivateBasePlan.
*/
export interface Schema$ActivateBasePlanRequest {
/**
* Required. The unique base plan ID of the base plan to activate.
*/
basePlanId?: string | null;
/**
* Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
*/
latencyTolerance?: string | null;
/**
* Required. The parent app (package name) of the base plan to activate.
*/
packageName?: string | null;
/**
* Required. The parent subscription (ID) of the base plan to activate.
*/
productId?: string | null;
}
/**
* Request message for ActivateOneTimeProductOffer.
*/
export interface Schema$ActivateOneTimeProductOfferRequest {
/**
* Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
*/
latencyTolerance?: string | null;
/**
* Required. The offer ID of the offer to activate.
*/
offerId?: string | null;
/**
* Required. The parent app (package name) of the offer to activate.
*/
packageName?: string | null;
/**
* Required. The parent one-time product (ID) of the offer to activate.
*/
productId?: string | null;
/**
* Required. The parent purchase option (ID) of the offer to activate.
*/
purchaseOptionId?: string | null;
}
/**
* Request message for UpdatePurchaseOptionState.
*/
export interface Schema$ActivatePurchaseOptionRequest {
/**
* Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
*/
latencyTolerance?: string | null;
/**
* Required. The parent app (package name) of the purchase option to activate.
*/
packageName?: string | null;
/**
* Required. The parent one-time product (ID) of the purchase option to activate.
*/
productId?: string | null;
/**
* Required. The purchase option ID of the purchase option to activate.
*/
purchaseOptionId?: string | null;
}
/**
* Request message for ActivateSubscriptionOffer.
*/
export interface Schema$ActivateSubscriptionOfferRequest {
/**
* Required. The parent base plan (ID) of the offer to activate.
*/
basePlanId?: string | null;
/**
* Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
*/
latencyTolerance?: string | null;
/**
* Required. The unique offer ID of the offer to activate.
*/
offerId?: string | null;
/**
* Required. The parent app (package name) of the offer to activate.
*/
packageName?: string | null;
/**
* Required. The parent subscription (ID) of the offer to activate.
*/
productId?: string | null;
}
/**
* Request message for AddTargeting.
*/
export interface Schema$AddTargetingRequest {
/**
* Specifies targeting updates such as regions, android sdk versions etc.
*/
targetingUpdate?: Schema$TargetingUpdate;
}
/**
* Response message for AddTargeting.
*/
export interface Schema$AddTargetingResponse {
}
/**
* Object representation to describe all set of users.
*/
export interface Schema$AllUsers {
/**
* Required. Set to true if all set of users are needed.
*/
isAllUsersRequested?: boolean | null;
}
/**
* Android api level targeting data for app recovery action targeting.
*/
export interface Schema$AndroidSdks {
/**
* 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.
*/
sdkLevels?: string[] | null;
}
/**
* Information about an APK. The resource for ApksService.
*/
export interface Schema$Apk {
/**
* Information about the binary payload of this APK.
*/
binary?: Schema$ApkBinary;
/**
* The version code of the APK, as specified in the manifest file.
*/
versionCode?: number | null;
}
/**
* Represents the binary payload of an APK.
*/
export interface Schema$ApkBinary {
/**
* A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
*/
sha1?: string | null;
/**
* A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command.
*/
sha256?: string | null;
}
/**
* Description of the created apks.
*/
export interface Schema$ApkDescription {
/**
* Set only for asset slices.
*/
assetSliceMetadata?: Schema$SplitApkMetadata;
/**
* Set only for Instant split APKs.
*/
instantApkMetadata?: Schema$SplitApkMetadata;
/**
* Path of the Apk, will be in the following format: .apk where DownloadId is the ID used to download the apk using GeneratedApks.Download API.
*/
path?: string | null;
/**
* Set only for Split APKs.
*/
splitApkMetadata?: Schema$SplitApkMetadata;
/**
* Set only for standalone APKs.
*/
standaloneApkMetadata?: Schema$StandaloneApkMetadata;
/**
* Apk-level targeting.
*/
targeting?: Schema$ApkTargeting;
}
/**
* Request to create a new externally hosted APK.
*/
export interface Schema$ApksAddExternallyHostedRequest {
/**
* The definition of the externally-hosted APK and where it is located.
*/
externallyHostedApk?: Schema$ExternallyHostedApk;
}
/**
* Response for creating a new externally hosted APK.
*/
export interface Schema$ApksAddExternallyHostedResponse {
/**
* The definition of the externally-hosted APK and where it is located.
*/
externallyHostedApk?: Schema$ExternallyHostedApk;
}
/**
* A set of apks representing a module.
*/
export interface Schema$ApkSet {
/**
* Description of the generated apks.
*/
apkDescription?: Schema$ApkDescription[];
/**
* Metadata about the module represented by this ApkSet
*/
moduleMetadata?: Schema$ModuleMetadata;
}
/**
* Response listing all APKs.
*/
export interface Schema$ApksListResponse {
/**
* All APKs.
*/
apks?: Schema$Apk[];
/**
* The kind of this response ("androidpublisher#apksListResponse").
*/
kind?: string | null;
}
/**
* Represents a set of apk-level targetings.
*/
export interface Schema$ApkTargeting {
/**
* The abi that the apk targets
*/
abiTargeting?: Schema$AbiTargeting;
/**
* The language that the apk targets
*/
languageTargeting?: Schema$LanguageTargeting;
/**
* Multi-api-level targeting.
*/
multiAbiTargeting?: Schema$MultiAbiTargeting;
/**
* The screen density that this apk supports.
*/
screenDensityTargeting?: Schema$ScreenDensityTargeting;
/**
* The sdk version that the apk targets
*/
sdkVersionTargeting?: Schema$SdkVersionTargeting;
/**
* Texture-compression-format-level targeting
*/
textureCompressionFormatTargeting?: Schema$TextureCompressionFormatTargeting;
}
/**
* Contact information for the app.
*/
export interface Schema$AppContactInformation {
/**
* The contact email for this app. Always set.
*/
contactEmail?: string | null;
/**
* The contact phone for this app. Optionally provided by the developer.
*/
phoneNumber?: string | null;
/**
* The contact website url for this app. Optionally provided by the developer.
*/
websiteUrl?: string | null;
}
/**
* The app details. The resource for DetailsService.
*/
export interface Schema$AppDetails {
/**
* The user-visible support email for this app.
*/
contactEmail?: string | null;
/**
* The user-visible support telephone number for this app.
*/
contactPhone?: string | null;
/**
* The user-visible website for this app.
*/
contactWebsite?: string | null;
/**
* Default language code, in BCP 47 format (eg "en-US").
*/
defaultLanguage?: string | null;
}
/**
* An app edit. The resource for EditsService.
*/
export interface Schema$AppEdit {
/**
* Output only. The time (as seconds since Epoch) at which the edit will expire and will be no longer valid for use.
*/
expiryTimeSeconds?: string | null;
/**
* Output only. Identifier of the edit. Can be used in subsequent API calls.
*/
id?: string | null;
}
/**
* Information about an app recovery action.
*/
export interface Schema$AppRecoveryAction {
/**
* ID corresponding to the app recovery action.
*/
appRecoveryId?: string | null;
/**
* Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
*/
cancelTime?: string | null;
/**
* Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
*/
createTime?: string | null;
/**
* Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
*/
deployTime?: string | null;
/**
* 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.
*/
lastUpdateTime?: string | null;
/**
* 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.
*/
remoteInAppUpdateData?: Schema$RemoteInAppUpdateData;
/**
* The status of the recovery action.
*/
status?: string | null;
/**
* Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc.
*/
targeting?: Schema$Targeting;
}
/**
* Information about active APKs of an app store hosted app.
*/
export interface Schema$AppStoreAppActiveApks {
/**
* Required. List specifying which APK sets are distributed together. This list should contain all APKs that you're distributing for this app. Add an entry for each individual installable set of APKs.
*/
activeApkSets?: Schema$AppStoreAppActiveApkSet[];
}
/**
* An installable set of active APKs. A set of APKs might only contain 1 APK if the app in question publishes using APKs. If the app uses app bundles (or a similar technology), this set should contain all APKs (even optional ones) that might be installed for this app. A set of APKs should be installable together. If certain APKs are exclusive to one another and cannot be installed together, then a separate AppStoreAppActiveApkSet should be created.
*/
export interface Schema$AppStoreAppActiveApkSet {
/**
* Required. The ID for the main base application module. Example: base.apk or app.apk.
*/
baseApkId?: string | null;
/**
* Optional. IDs for split modules that might be installed in combination with the base APK. Can be empty if app bundles (or a similar technology) are not used. Example: config.en.apk.
*/
splitApkId?: string[] | null;
}
/**
* Details about the app.
*/
export interface Schema$AppStoreAppDetails {
/**
* Required. The app developer's contact email address.
*/
contactEmail?: string | null;
/**
* Required. The app developer's name.
*/
developerName?: string | null;
/**
* Optional. Website link for the developer or app.
*/
developerWebsite?: string | null;
}
/**
* A policy declaration with its responses.
*/
export interface Schema$AppStoreAppPolicyDeclaration {
/**
* Required. ID of the policy declaration.
*/
declarationId?: string | null;
/**
* Required. Responses provided for this declaration.
*/
responses?: Schema$PolicyResponse[];
}
/**
* A localized store listing. These are the details about the app as shown in your app store.
*/
export interface Schema$AppStoreAppStoreListing {
/**
* Required. Image ID generated from UploadImage for the main app icon.
*/
appIconId?: string | null;
/**
* Required. The title of the app.
*/
appName?: string | null;
/**
* Required. Comprehensive description text about the app.
*/
fullDescription?: string | null;
/**
* Required. Language code (e.g., "en-US") of the listing.
*/
languageCode?: string | null;
/**
* Required. Multiple image IDs for screenshot galleries.
*/
screenshotId?: string[] | null;
/**
* Optional. Quick summary about the app.
*/
shortDescription?: string | null;
/**
* Optional. Link to a video about the app.
*/
videoLink?: string | null;
}
/**
* Data format for a list of app versions.
*/
export interface Schema$AppVersionList {
/**
* List of app version codes.
*/
versionCodes?: string[] | null;
}
/**
* Data format for a continuous range of app versions.
*/
export interface Schema$AppVersionRange {
/**
* Highest app version in the range, inclusive.
*/
versionCodeEnd?: string | null;
/**
* Lowest app version in the range, inclusive.
*/
versionCodeStart?: string | null;
}
/**
* Deprecated: subscription archiving is not supported.
*/
export interface Schema$ArchiveSubscriptionRequest {
}
/**
* Summary of an artifact.
*/
export interface Schema$ArtifactSummary {
/**
* Artifact's version code
*/
versionCode?: number | null;
}
/**
* Metadata of an asset module.
*/
export interface Schema$AssetModuleMetadata {
/**
* Indicates the delivery type for persistent install.
*/
deliveryType?: string | null;
/**
* Module name.
*/
name?: string | null;
}
/**
* Set of asset slices belonging to a single asset module.
*/
export interface Schema$AssetSliceSet {
/**
* Asset slices.
*/
apkDescription?: Schema$ApkDescription[];
/**
* Module level metadata.
*/
assetModuleMetadata?: Schema$AssetModuleMetadata;
}
/**
* Represents a base plan that automatically renews at the end of its subscription period.
*/
export interface Schema$AutoRenewingBasePlanType {
/**
* Optional. Custom account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. An empty field represents a recommended account hold, calculated as 60 days minus grace period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
*/
accountHoldDuration?: string | null;
/**
* Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
*/
billingPeriodDuration?: string | null;
/**
* Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
*/
gracePeriodDuration?: string | null;
/**
* Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
*/
legacyCompatible?: boolean | null;
/**
* Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
*/
legacyCompatibleSubscriptionOfferId?: string | null;
/**
* The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
*/
prorationMode?: string | null;
/**
* Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
*/
resubscribeState?: string | null;
}
/**
* Information related to an auto renewing plan.
*/
export interface Schema$AutoRenewingPlan {
/**
* If the subscription is currently set to auto-renew, e.g. the user has not canceled the subscription
*/
autoRenewEnabled?: boolean | null;
/**
* The installment plan commitment and state related info for the auto renewing plan.
*/
installmentDetails?: Schema$InstallmentPlan;
/**
* The information of the last price change for the item since subscription signup.
*/
priceChangeDetails?: Schema$SubscriptionItemPriceChangeDetails;
/**
* The information of the latest price step-up consent.
*/
priceStepUpConsentDetails?: Schema$PriceStepUpConsentDetails;
/**
* The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes. For tax-exclusive pricing, please call orders.get API instead if transaction details are needed.
*/
recurringPrice?: Schema$Money;
}
/**
* Details of a base price pricing phase.
*/
export interface Schema$BaseDetails {
}
/**
* A single base plan for a subscription.
*/
export interface Schema$BasePlan {
/**
* Set when the base plan automatically renews at a regular interval.
*/
autoRenewingBasePlanType?: Schema$AutoRenewingBasePlanType;
/**
* Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.
*/
basePlanId?: string | null;
/**
* Set for installments base plans where a user is committed to a specified number of payments.
*/
installmentsBasePlanType?: Schema$InstallmentsBasePlanType;
/**
* List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.
*/
offerTags?: Schema$OfferTag[];
/**
* Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.
*/
otherRegionsConfig?: Schema$OtherRegionsBasePlanConfig;
/**
* Set when the base plan does not automatically renew at the end of the billing period.
*/
prepaidBasePlanType?: Schema$PrepaidBasePlanType;
/**
* Region-specific information for this base plan.
*/
regionalConfigs?: Schema$RegionalBasePlanConfig[];
/**
* Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
*/
state?: string | null;
}
/**
* Details about base price offer phase.
*/
export interface Schema$BasePriceOfferPhase {
}
/**
* Request message for BatchDeleteOneTimeProductOffers.
*/
export interface Schema$BatchDeleteOneTimeProductOffersRequest {
/**
* Required. A list of update requests of up to 100 elements. All requests must correspond to different offers.
*/
requests?: Schema$DeleteOneTimeProductOfferRequest[];
}
/**
* Request message for BatchDeleteOneTimeProduct.
*/
export interface Schema$BatchDeleteOneTimeProductsRequest {
/**
* Required. A list of delete requests of up to 100 elements. All requests must delete different one-time products.
*/
requests?: Schema$DeleteOneTimeProductRequest[];
}
/**
* Request message for BatchDeletePurchaseOption.
*/
export interface Schema$BatchDeletePurchaseOptionsRequest {
/**
* Required. A list of delete requests of up to 100 elements. All requests must delete purchase options from different one-time products.
*/
requests?: Schema$DeletePurchaseOptionRequest[];
}
/**
* Request message for the BatchGetOneTimeProductOffers endpoint.
*/
export interface Schema$BatchGetOneTimeProductOffersRequest {
/**
* Required. A list of get requests of up to 100 elements. All requests must retrieve different offers.
*/
requests?: Schema$GetOneTimeProductOfferRequest[];
}
/**
* Response message for the BatchGetOneTimeProductOffers endpoint.
*/
export interface Schema$BatchGetOneTimeProductOffersResponse {
/**
* The list of updated one-time product offers, in the same order as the request.
*/
oneTimeProductOffers?: Schema$OneTimeProductOffer[];
}
/**
* Response message for the BatchGetOneTimeProducts endpoint.
*/
export interface Schema$BatchGetOneTimeProductsResponse {
/**
* The list of requested one-time products, in the same order as the request.
*/
oneTimeProducts?: Schema$OneTimeProduct[];
}
/**
* Response for the orders.batchGet API.
*/
export interface Schema$BatchGetOrdersResponse {
/**
* Details for the requested order IDs.
*/
orders?: Schema$Order[];
}
/**
* Request message for BatchGetSubscriptionOffers endpoint.
*/
export interface Schema$BatchGetSubscriptionOffersRequest {
/**
* Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.
*/
requests?: Schema$GetSubscriptionOfferRequest[];
}
/**
* Response message for BatchGetSubscriptionOffers endpoint.
*/
export interface Schema$BatchGetSubscriptionOffersResponse {
subscriptionOffers?: Schema$SubscriptionOffer[];
}
/**
* Response message for BatchGetSubscriptions endpoint.
*/
export interface Schema$BatchGetSubscriptionsResponse {
/**
* The list of requested subscriptions, in the same order as the request.
*/
subscriptions?: Schema$Subscription[];
}
/**
* Request message for BatchMigrateBasePlanPrices.
*/
export interface Schema$BatchMigrateBasePlanPricesRequest {
/**
* Required. Up to 100 price migration requests. All requests must update different base plans.
*/
requests?: Schema$MigrateBasePlanPricesRequest[];
}
/**
* Response message for BatchMigrateBasePlanPrices.
*/
export interface Schema$BatchMigrateBasePlanPricesResponse {
/**
* Contains one response per requested price migration, in the same order as the request.
*/
responses?: Schema$MigrateBasePlanPricesResponse[];
}
/**
* Request message for BatchUpdateBasePlanStates.
*/
export interface Schema$BatchUpdateBasePlanStatesRequest {
/**
* Required. The update request list of up to 100 elements. All requests must update different base plans.
*/
requests?: Schema$UpdateBasePlanStateRequest[];
}
/**
* Response message for BatchUpdateBasePlanStates.
*/
export interface Schema$BatchUpdateBasePlanStatesResponse {
/**
* The list of updated subscriptions. This list will match the requests one to one, in the same order.
*/
subscriptions?: Schema$Subscription[];
}
/**
* Request message for BatchUpdateOneTimeProductOffers.
*/
export interface Schema$BatchUpdateOneTimeProductOffersRequest {
/**
* Required. A list of update requests of up to 100 elements. All requests must update different offers.
*/
requests?: Schema$UpdateOneTimeProductOfferRequest[];
}
/**
* Response message for BatchUpdateOneTimeProductOffers.
*/
export interface Schema$BatchUpdateOneTimeProductOffersResponse {
/**
* The list of updated one-time product offers, in the same order as the request.
*/
oneTimeProductOffers?: Schema$OneTimeProductOffer[];
}
/**
* Request message for BatchUpdateOneTimeProductOfferStates.
*/
export interface Schema$BatchUpdateOneTimeProductOfferStatesRequest {
/**
* Required. The update request list of up to 100 elements. All requests must update different offers.
*/
requests?: Schema$UpdateOneTimeProductOfferStateRequest[];
}
/**
* Response message for BatchUpdateOneTimeProductOfferStates.
*/
export interface Schema$BatchUpdateOneTimeProductOfferStatesResponse {
/**
* The updated one-time product offers list, in the same order as the request.
*/
oneTimeProductOffers?: Schema$OneTimeProductOffer[];
}
/**
* Request message for BatchUpdateOneTimeProduct.
*/
export interface Schema$BatchUpdateOneTimeProductsRequest {
/**
* Required. A list of update requests of up to 100 elements. All requests must update different one-time products.
*/
requests?: Schema$UpdateOneTimeProductRequest[];
}
/**
* Response message for BatchUpdateOneTimeProduct.
*/
export interface Schema$BatchUpdateOneTimeProductsResponse {
/**
* The list of updated one-time products list, in the same order as the request.
*/
oneTimeProducts?: Schema$OneTimeProduct[];
}
/**
* Request message for BatchUpdatePurchaseOptionStates.
*/
export interface Schema$BatchUpdatePurchaseOptionStatesRequest {
/**
* Required. The update request list of up to 100 elements. All requests must update different purchase options.
*/
requests?: Schema$UpdatePurchaseOptionStateRequest[];
}
/**
* Response message for BatchUpdatePurchaseOptionStates.
*/
export interface Schema$BatchUpdatePurchaseOptionStatesResponse {
/**
* The list of updated one-time products. This list will match the requests one to one, in the same order.
*/
oneTimeProducts?: Schema$OneTimeProduct[];
}
/**
* Request message for BatchUpdateSubscriptionOffers.
*/
export interface Schema$BatchUpdateSubscriptionOffersRequest {
/**
* Required. A list of update requests of up to 100 elements. All requests must update different subscription offers.
*/
requests?: Schema$UpdateSubscriptionOfferRequest[];
}
/**
* Response message for BatchUpdateSubscriptionOffers.
*/
export interface Schema$BatchUpdateSubscriptionOffersResponse {
/**
* The updated subscription offers list.
*/
subscriptionOffers?: Schema$SubscriptionOffer[];
}
/**
* Request message for BatchUpdateSubscriptionOfferStates.
*/
export interface Schema$BatchUpdateSubscriptionOfferStatesRequest {
/**
* Required. The update request list of up to 100 elements. All requests must update different offers.
*/
requests?: Schema$UpdateSubscriptionOfferStateRequest[];
}
/**
* Response message for BatchUpdateSubscriptionOfferStates.
*/
export interface Schema$BatchUpdateSubscriptionOfferStatesResponse {
/**
* The updated subscription offers list.
*/
subscriptionOffers?: Schema$SubscriptionOffer[];
}
/**
* Request message for BatchUpdateSubscription.
*/
export interface Schema$BatchUpdateSubscriptionsRequest {
/**
* Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.
*/
requests?: Schema$UpdateSubscriptionRequest[];
}
/**
* Response message for BatchUpdateSubscription.
*/
export interface Schema$BatchUpdateSubscriptionsResponse {
/**
* The updated subscriptions list.
*/
subscriptions?: Schema$Subscription[];
}
/**
* Information about an app bundle. The resource for BundlesService.
*/
export interface Schema$Bundle {
/**
* A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command.
*/
sha1?: string | null;
/**
* A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command.
*/
sha256?: string | null;
/**
* The version code of the Android App Bundle, as specified in the Android App Bundle's base module APK manifest file.
*/
versionCode?: number | null;
}
/**
* Response listing all app bundles.
*/
export interface Schema$BundlesListResponse {
/**
* All app bundles.
*/
bundles?: Schema$Bundle[];
/**
* The kind of this response ("androidpublisher#bundlesListResponse").
*/
kind?: string | null;
}
/**
* Address information for the customer, for use in tax computation.
*/
export interface Schema$BuyerAddress {
/**
* Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes).
*/
buyerCountry?: string | null;
/**
* Postal code of an address. When Google is the Merchant of Record for the order, this information is not included.
*/
buyerPostcode?: string | null;
/**
* Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included.
*/
buyerState?: string | null;
}
/**
* Request message for CancelAppRecovery.
*/
export interface Schema$CancelAppRecoveryRequest {
}
/**
* Response message for CancelAppRecovery.
*/
export interface Schema$CancelAppRecoveryResponse {
}
/**
* Information specific to a subscription in the SUBSCRIPTION_STATE_CANCELED or SUBSCRIPTION_STATE_EXPIRED state.
*/
export interface Schema$CanceledStateContext {
/**
* Subscription was canceled by the developer.
*/
developerInitiatedCancellation?: Schema$DeveloperInitiatedCancellation;
/**
* Subscription was replaced by a new subscription.
*/
replacementCancellation?: Schema$ReplacementCancellation;
/**
* Subscription was canceled by the system, for example because of a billing problem.
*/
systemInitiatedCancellation?: Schema$SystemInitiatedCancellation;
/**
* Subscription was canceled by user.
*/
userInitiatedCancellation?: Schema$UserInitiatedCancellation;
}
/**
* Cancellation context of the purchases.subscriptionsv2.cancel API.
*/
export interface Schema$CancellationContext {
/**
* Required. The type of cancellation for the purchased subscription.
*/
cancellationType?: string | null;
}
/**
* Details of when the order was canceled.
*/
export interface Schema$CancellationEvent {
/**
* The time when the order was canceled.
*/
eventTime?: string | null;
}
/**
* Request message for CancelOneTimeProductOffer.
*/
export interface Schema$CancelOneTimeProductOfferRequest {
/**
* Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
*/
latencyTolerance?: string | null;
/**
* Required. The offer ID of the offer to cancel.
*/
offerId?: string | null;
/**
* Required. The parent app (package name) of the offer to cancel.
*/
packageName?: string | null;
/**
* Required. The parent one-time product (ID) of the offer to cancel.
*/
productId?: string | null;
/**
* Required. The parent purchase option (ID) of the offer to cancel.
*/
purchaseOptionId?: string | null;
}
/**
* Request for the purchases.subscriptionsv2.cancel API.
*/
export interface Schema$CancelSubscriptionPurchaseRequest {
/**
* Required. Additional details around the subscription revocation.
*/
cancellationContext?: Schema$CancellationContext;
}
/**
* Response for the purchases.subscriptionsv2.cancel API.
*/
export interface Schema$CancelSubscriptionPurchaseResponse {
}
/**
* Result of the cancel survey when the subscription was canceled by the user.
*/
export interface Schema$CancelSurveyResult {
/**
* The reason the user selected in the cancel survey.
*/
reason?: string | null;
/**
* Only set for CANCEL_SURVEY_REASON_OTHERS. This is the user's freeform response to the survey.
*/
reasonUserInput?: string | null;
}
/**
* LINT.IfChange A view of a Google Play app within the Catalog Export for app stores.
*/
export interface Schema$CatalogAppView {
/**
* Active versions of the app mapped from `android:versionName` manifest attributes.
*/
activeVersionNames?: string[] | null;
/**
* The category of the app.
*/
appCategory?: string | null;
/**
* Developer-provided contact information for the app.
*/
appContactInformation?: Schema$AppContactInformation;
/**
* The subcategory of the app e.g. "GAME_ACTION".
*/
appSubcategory?: string | null;
/**
* The token used for delivery of the app with the Google Play Inline Install API.
*/
deliveryToken?: string | null;
/**
* The developer details of the app.
*/
developerDetails?: Schema$DeveloperDetails;
/**
* The app may specify multiple sets of device compatibility requirements, and a device is considered compatible with the app if it satisfies at least one of `DeviceCompatibilityRequirements`.
*/
deviceCompatibilityRequirements?: Schema$DeviceCompatibilityRequirements[];
/**
* List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. These are OR-ed, i.e. a device is excluded if it matches any of the identifiers.
*/
excludedDevicesByIdentifier?: Schema$DeviceIdentifier[];
/**
* List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. A device is excluded if it matches any of given the selectors.
*/
excludedDevicesBySelector?: Schema$CatalogDeviceSelector[];
/**
* The date when the app was first released.
*/
firstReleaseDate?: Schema$Date;
/**
* Whether the app has ads.
*/
hasInAppAds?: boolean | null;
/**
* Whether the app has in-app purchases through Google Play.
*/
hasInAppPurchases?: boolean | null;
/**
* The IARC certificate ID for the app.
*/
iarcCertificateId?: string | null;
/**
* Whether the app is targeted to an adult-only (18+) audience.
*/
isAdultOnlyAudience?: boolean | null;
/**
* The timestamp when the app was last published.
*/
lastPublishTime?: string | null;
/**
* The localized store listings of the app which are shown on Google Play.
*/
localizedStoreListings?: Schema$LocalizedStoreListings;
/**
* The package name of the app.
*/
packageName?: string | null;
/**
* Required permissions declared by the app which apply for all Android SDK versions.
*/
permissions?: Schema$CatalogPermission[];
/**
* Required permissions declared by the app which apply for Android SDK versions SDK 23 and above.
*/
permissionsSdk23?: Schema$CatalogPermission[];
/**
* The price of the app in the United States. Empty if the app is free.
*/
priceInTheUnitedStates?: Schema$Money;
/**
* The URL of the app's privacy policy.
*/
privacyPolicyUrl?: string | null;
/**
* The sale price of the app in the United States. Only populated for paid apps with an active US sale.
*/
salePriceInTheUnitedStates?: Schema$Money;
}
/**
* Defines a device selector for a device. A device is considered matched if it matches any of given the selectors.
*/
export interface Schema$CatalogDeviceSelector {
/**
* The device type selector.
*/
deviceTypeSelector?: string | null;
/**
* Defines a RAM selector for a device.
*/
ramSelector?: Schema$RamSelector;
/**
* The SOC selectors. A device matches the device selector if it matches any of the SOC selectors.
*/
socSelectors?: Schema$SocSelector[];
}
/**
* A permission declared by an app.
*/
export interface Schema$CatalogPermission {
/**
* The `maxSdkVersion` attribute indicating up to which Android SDK version the permission is requested.
*/
maxSdkVersion?: number | null;
/**
* The `name` attribute indicating the permission name.
*/
name?: string | null;
}
/**
* Defines a range of SDK versions. A device is considered compatible uf its\ SDK version falls within the min_sdk_version and max_sdk_version range.
*/
export interface Schema$CatalogSdkVersion {
/**
* The maximum SDK version required for the app (inclusive).
*/
maxSdkVersion?: string | null;
/**
* The minimum SDK version required for the app (inclusive).
*/
minSdkVersion?: string | null;
/**
* The target SDK version for the app.
*/
targetSdkVersion?: string | null;
}
/**
* Coarse Geographic location details for where the consumption happened.
*/
export interface Schema$CoarseLocation {
/**
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
*/
administrativeArea?: string | null;
/**
* Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty.
*/
locality?: string | null;
/**
* Required. [CLDR region code](https://cldr.unicode.org/) of the country/region of the address. This value is never inferred and you must ensure the value is correct. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
/**
* Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. For most addresses, you can omit this.
*/
sublocality?: string | null;
}
/**
* An entry of conversation between user and developer.
*/
export interface Schema$Comment {
/**
* A comment from a developer.
*/
developerComment?: Schema$DeveloperComment;
/**
* A comment from a user.
*/
userComment?: Schema$UserComment;
}
/**
* Compatible screens as listed in the `compatible-screens` Manifest tag.
*/
export interface Schema$CompatibleScreen {
/**
* Screen density.
*/
density?: string | null;
/**
* The screen size.
*/
screenSize?: string | null;
}
/**
* List of events, each representing an instance where the user consumed or used the purchased item or service.
*/
export interface Schema$ConsumptionUsageEvent {
/**
* Optional. Free form text that allows developers to provide more info on the item consumed. Maximum length is 5000 characters.
*/
consumptionItemDescription?: string | null;
/**
* Optional. Time when the user consumed, used, downloaded, opened, or streamed the content.
*/
consumptionTime?: string | null;
/**
* Optional. The IP address from which the consumption occurred.
*/
ipAddress?: string | null;
/**
* Optional. Geographic location where the consumption occurred.
*/
location?: Schema$CoarseLocation;
/**
* Optional. Obfuscated string that is uniquely associated with the purchaser's user account in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedAccountId(java.lang.String)
*/
obfuscatedAccountId?: string | null;
/**
* Optional. Obfuscated string that is uniquely associated with the purchaser's user profile in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedProfileId(java.lang.String)
*/
obfuscatedProfileId?: string | null;
}
/**
* Converted other regions prices.
*/
export interface Schema$ConvertedOtherRegionsPrice {
/**
* Price in EUR to use for the "Other regions" location exclusive of taxes.
*/
eurPrice?: Schema$Money;
/**
* Price in USD to use for the "Other regions" location exclusive of taxes.
*/
usdPrice?: Schema$Money;
}
/**
* A converted region price.
*/
export interface Schema$ConvertedRegionPrice {
/**
* The converted price tax inclusive.
*/
price?: Schema$Money;
/**
* The region code of the region.
*/
regionCode?: string | null;
/**
* The tax amount of th