@gpc-cli/api 1.0.36 → 1.0.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -26
- package/dist/index.d.ts +20 -2
- package/dist/index.js +281 -181
- package/dist/index.js.map +1 -1
- package/package.json +22 -15
- package/LICENSE +0 -21
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Typed Google Play Developer API v3 client for TypeScript. Part of [GPC](https://github.com/yasserstudio/gpc).
|
|
4
4
|
|
|
5
|
-
217 endpoints across edits, releases, tracks, listings, subscriptions, in-app products, purchases, reviews, vitals, reports, users, testers, and **Managed Google Play private app publishing** (Play Custom App Publishing API, v0.9.
|
|
5
|
+
217 endpoints across edits, releases, tracks, listings, subscriptions, in-app products, purchases, reviews, vitals, reports, users, testers, and **Managed Google Play private app publishing** (Play Custom App Publishing API, v0.9.64+ — first Android publishing SDK to support this). Built-in rate limiting, retry logic, resumable uploads, and pagination.
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -92,31 +92,39 @@ await client.purchases.acknowledgeProduct("com.example.app", "coins_100", token)
|
|
|
92
92
|
|
|
93
93
|
## All API Modules
|
|
94
94
|
|
|
95
|
-
| Module | Methods
|
|
96
|
-
| ----------------------------- |
|
|
97
|
-
| `client.edits` | insert, get, validate, commit, delete
|
|
98
|
-
| `client.
|
|
99
|
-
| `client.
|
|
100
|
-
| `client.
|
|
101
|
-
| `client.
|
|
102
|
-
| `client.
|
|
103
|
-
| `client.
|
|
104
|
-
| `client.
|
|
105
|
-
| `client.
|
|
106
|
-
| `client.
|
|
107
|
-
| `client.
|
|
108
|
-
| `client.
|
|
109
|
-
| `client.
|
|
110
|
-
| `client.
|
|
111
|
-
| `client.
|
|
112
|
-
| `client.
|
|
113
|
-
| `client.
|
|
114
|
-
| `client.
|
|
115
|
-
| `client.
|
|
116
|
-
| `client.
|
|
117
|
-
| `client.
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
95
|
+
| Module | Methods |
|
|
96
|
+
| ----------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
97
|
+
| `client.edits` | insert, get, validate, commit, delete |
|
|
98
|
+
| `client.details` | get, update, patch |
|
|
99
|
+
| `client.bundles` | upload, list |
|
|
100
|
+
| `client.apks` | upload, list |
|
|
101
|
+
| `client.tracks` | list, get, update, patch, create, delete |
|
|
102
|
+
| `client.releases` | get, update |
|
|
103
|
+
| `client.countryAvailability` | get, list |
|
|
104
|
+
| `client.listings` | list, get, update, delete, deleteAll |
|
|
105
|
+
| `client.images` | list, upload, delete, deleteAll |
|
|
106
|
+
| `client.subscriptions` | list, get, create, patch, archive, activate/deactivate base plans and offers |
|
|
107
|
+
| `client.inappproducts` | list, get, create, update, delete, batchGet, batchUpdate, batchDelete |
|
|
108
|
+
| `client.oneTimeProducts` | list, get, create, patch, delete, batchGet, batchUpdate, batchDelete, activateOffer, deactivateOffer |
|
|
109
|
+
| `client.purchases` | getProduct, acknowledgeProduct, getSubscriptionV2, revokeSubscriptionV2, refund, listVoided, consumeProduct |
|
|
110
|
+
| `client.orders` | get, refund |
|
|
111
|
+
| `client.reviews` | list, get, reply |
|
|
112
|
+
| `client.testers` | get, update |
|
|
113
|
+
| `client.reports` | list |
|
|
114
|
+
| `client.monetization` | convertRegionPrices |
|
|
115
|
+
| `client.deobfuscation` | upload |
|
|
116
|
+
| `client.expansionFiles` | get, update, patch, upload |
|
|
117
|
+
| `client.dataSafety` | update |
|
|
118
|
+
| `client.deviceTiers` | list, get, create |
|
|
119
|
+
| `client.internalAppSharing` | uploadBundle, uploadApk |
|
|
120
|
+
| `client.generatedApks` | list, download |
|
|
121
|
+
| `client.systemApks` | list, variants |
|
|
122
|
+
| `client.externalTransactions` | create, get, refund |
|
|
123
|
+
| `client.appRecovery` | create, deploy, cancel, list |
|
|
124
|
+
| `reporting.*` | queryMetricSet, getAnomalies, searchErrorIssues, searchErrorReports |
|
|
125
|
+
| `users.*` | list, get, create, patch, delete, listGrants, createGrant, patchGrant, deleteGrant |
|
|
126
|
+
|
|
127
|
+
**Supported metric sets** (pass to `reporting.queryMetricSet`): `crashRateMetricSet`, `anrRateMetricSet`, `lmkRateMetricSet`, `excessiveWakeupRateMetricSet`, `slowStartRateMetricSet`, `slowRenderingRateMetricSet`, `stuckBackgroundWakelockRateMetricSet`, `errorCountMetricSet`.
|
|
120
128
|
|
|
121
129
|
## Pagination
|
|
122
130
|
|
|
@@ -181,6 +189,11 @@ import type {
|
|
|
181
189
|
ErrorIssue,
|
|
182
190
|
User,
|
|
183
191
|
Grant,
|
|
192
|
+
AppLevelPermission,
|
|
193
|
+
DeveloperLevelPermission,
|
|
194
|
+
SubscriptionState,
|
|
195
|
+
OneTimeOfferState,
|
|
196
|
+
OneTimeProductAvailability,
|
|
184
197
|
ImageType,
|
|
185
198
|
Money,
|
|
186
199
|
} from "@gpc-cli/api";
|
package/dist/index.d.ts
CHANGED
|
@@ -295,6 +295,23 @@ interface Anomaly {
|
|
|
295
295
|
interface AnomalyDetectionResponse {
|
|
296
296
|
anomalies: Anomaly[];
|
|
297
297
|
}
|
|
298
|
+
interface FreshnessResponse {
|
|
299
|
+
name: string;
|
|
300
|
+
freshnessInfo: {
|
|
301
|
+
freshnesses: Array<{
|
|
302
|
+
aggregationPeriod: ReportingAggregation;
|
|
303
|
+
latestEndTime: {
|
|
304
|
+
year: number;
|
|
305
|
+
month: number;
|
|
306
|
+
day: number;
|
|
307
|
+
hours?: number;
|
|
308
|
+
timeZone?: {
|
|
309
|
+
id: string;
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
}>;
|
|
313
|
+
};
|
|
314
|
+
}
|
|
298
315
|
interface ErrorIssue {
|
|
299
316
|
name: string;
|
|
300
317
|
type: string;
|
|
@@ -1400,9 +1417,10 @@ declare function createApiClient(options: ApiClientOptions): PlayApiClient;
|
|
|
1400
1417
|
|
|
1401
1418
|
interface ReportingApiClient {
|
|
1402
1419
|
queryMetricSet(packageName: string, metricSet: VitalsMetricSet, query: MetricSetQuery): Promise<MetricSetResponse>;
|
|
1420
|
+
getMetricSetFreshness(packageName: string, metricSet: VitalsMetricSet): Promise<FreshnessResponse>;
|
|
1403
1421
|
getAnomalies(packageName: string): Promise<AnomalyDetectionResponse>;
|
|
1404
1422
|
searchErrorIssues(packageName: string, filter?: string, pageSize?: number, pageToken?: string): Promise<ErrorIssuesResponse>;
|
|
1405
|
-
searchErrorReports(packageName: string,
|
|
1423
|
+
searchErrorReports(packageName: string, issueId: string, pageSize?: number, pageToken?: string): Promise<ErrorReportsResponse>;
|
|
1406
1424
|
}
|
|
1407
1425
|
declare function createReportingClient(options: ApiClientOptions): ReportingApiClient;
|
|
1408
1426
|
|
|
@@ -1599,4 +1617,4 @@ declare class PlayApiError extends Error {
|
|
|
1599
1617
|
/** Files below this threshold use simple upload instead. */
|
|
1600
1618
|
declare const RESUMABLE_THRESHOLD: number;
|
|
1601
1619
|
|
|
1602
|
-
export { type Achievement, type AcknowledgeSubscriptionRequest, type Anomaly, type AnomalyDetectionResponse, type ApiClientOptions, type ApiResponse, type ApkInfo, type ApksListResponse, type AppDetails, type AppEdit, type AppLevelPermission, type AppRecoveriesListResponse, type AppRecoveryAction, type AppRecoveryTargeting, type BasePlan, type BasePlanMigratePricesRequest, type BatchGetOrdersResponse, type BatchMigratePricesRequest, type BatchMigratePricesResponse, type Bundle, type BundleListResponse, type ChangesInReviewBehavior, type ConvertRegionPricesRequest, type ConvertRegionPricesResponse, type ConvertedRegionPrice, type CountryAvailability, type CreateAppRecoveryActionRequest, type CustomApp, type CustomAppCreateMetadata, type DataSafety, type DataSafetyDataType, type DataSafetyPurpose, type DeobfuscationFile, type DeobfuscationFileType, type DeobfuscationUploadResponse, type DeveloperComment, type DeveloperLevelPermission, type DeveloperPermission, type DeviceGroup, type DeviceSelector, type DeviceTier, type DeviceTierConfig, type DeviceTierConfigsListResponse, type EditCommitOptions, type EnterpriseApiClient, type ErrorIssue, type ErrorIssuesResponse, type ErrorReport, type ErrorReportsResponse, type ExpansionFile, type ExpansionFileType, type ExternalTransaction, type ExternalTransactionAmount, type ExternalTransactionRefund, type ExternallyHostedApk, type ExternallyHostedApkResponse, type GameEvent, type GamesApiClient, type GeneratedApk, type GeneratedApksPerVersion, type Grant, type GrantsListResponse, type HttpClient, type Image, type ImageType, type ImageUploadResponse, type ImagesDeleteAllResponse, type ImagesListResponse, type InAppProduct, type InAppProductListing, type InAppProductsBatchDeleteRequest, type InAppProductsBatchGetRequest, type InAppProductsBatchUpdateRequest, type InAppProductsBatchUpdateResponse, type InAppProductsListResponse, type InternalAppSharingArtifact, type Leaderboard, type LeaderboardScore, type Listing, type ListingsListResponse, type MetricRow, type MetricSetQuery, type MetricSetResponse, type Money, type MutationOptions, type OffersListResponse, type OneTimeOffer, type OneTimeOfferRegionalConfig, type OneTimeOfferState, type OneTimeOffersListResponse, type OneTimeProduct, type OneTimeProductAvailability, type OneTimeProductListing, type OneTimeProductsListResponse, type Order, type OrderLineItem, type PagedResponse, type PaginateOptions, type PlayApiClient, PlayApiError, type ProductPurchase, type ProductPurchaseLineItem, type ProductPurchaseV2, type ProductUpdateLatencyTolerance, RATE_LIMIT_BUCKETS, RESUMABLE_THRESHOLD, type RateLimitBucket, type RateLimiter, type RegionalBasePlanConfig, type Release, type ReleaseNote, type ReleaseStatus, type ReleaseSummary, type ReleasesListResponse, type ReportBucket, type ReportType, type ReportingAggregation, type ReportingApiClient, type ReportingDimension, type ReportsListResponse, type ResumableUploadOptions, type RetryLogEntry, type Review, type ReviewComment, type ReviewReplyRequest, type ReviewReplyResponse, type ReviewsListOptions, type ReviewsListResponse, type RevokeSubscriptionV2Request, type StatsDimension, type Subscription, type SubscriptionDeferRequest, type SubscriptionDeferResponse, type SubscriptionListing, type SubscriptionOffer, type SubscriptionOfferPhase, type SubscriptionPurchase, type SubscriptionPurchaseLineItem, type SubscriptionPurchaseV2, type SubscriptionState, type SubscriptionsBatchGetRequest, type SubscriptionsBatchGetResponse, type SubscriptionsBatchUpdateRequest, type SubscriptionsBatchUpdateResponse, type SubscriptionsListResponse, type SubscriptionsV2CancelRequest, type SubscriptionsV2DeferRequest, type SubscriptionsV2DeferResponse, type SystemApkDeviceSpec, type SystemApkOptions, type SystemApkVariant, type TaxAndComplianceSettings, type Testers, type TokenPagination, type Track, type TrackListResponse, type UploadProgressEvent, type UploadResponse, type User, type UserComment, type UsersApiClient, type UsersListResponse, type VitalsMetricSet, type VoidedPurchase, type VoidedPurchasesListResponse, createApiClient, createEnterpriseClient, createGamesClient, createHttpClient, createRateLimiter, createReportingClient, createUsersClient, paginate, paginateAll, paginateParallel, resolveBucket };
|
|
1620
|
+
export { type Achievement, type AcknowledgeSubscriptionRequest, type Anomaly, type AnomalyDetectionResponse, type ApiClientOptions, type ApiResponse, type ApkInfo, type ApksListResponse, type AppDetails, type AppEdit, type AppLevelPermission, type AppRecoveriesListResponse, type AppRecoveryAction, type AppRecoveryTargeting, type BasePlan, type BasePlanMigratePricesRequest, type BatchGetOrdersResponse, type BatchMigratePricesRequest, type BatchMigratePricesResponse, type Bundle, type BundleListResponse, type ChangesInReviewBehavior, type ConvertRegionPricesRequest, type ConvertRegionPricesResponse, type ConvertedRegionPrice, type CountryAvailability, type CreateAppRecoveryActionRequest, type CustomApp, type CustomAppCreateMetadata, type DataSafety, type DataSafetyDataType, type DataSafetyPurpose, type DeobfuscationFile, type DeobfuscationFileType, type DeobfuscationUploadResponse, type DeveloperComment, type DeveloperLevelPermission, type DeveloperPermission, type DeviceGroup, type DeviceSelector, type DeviceTier, type DeviceTierConfig, type DeviceTierConfigsListResponse, type EditCommitOptions, type EnterpriseApiClient, type ErrorIssue, type ErrorIssuesResponse, type ErrorReport, type ErrorReportsResponse, type ExpansionFile, type ExpansionFileType, type ExternalTransaction, type ExternalTransactionAmount, type ExternalTransactionRefund, type ExternallyHostedApk, type ExternallyHostedApkResponse, type FreshnessResponse, type GameEvent, type GamesApiClient, type GeneratedApk, type GeneratedApksPerVersion, type Grant, type GrantsListResponse, type HttpClient, type Image, type ImageType, type ImageUploadResponse, type ImagesDeleteAllResponse, type ImagesListResponse, type InAppProduct, type InAppProductListing, type InAppProductsBatchDeleteRequest, type InAppProductsBatchGetRequest, type InAppProductsBatchUpdateRequest, type InAppProductsBatchUpdateResponse, type InAppProductsListResponse, type InternalAppSharingArtifact, type Leaderboard, type LeaderboardScore, type Listing, type ListingsListResponse, type MetricRow, type MetricSetQuery, type MetricSetResponse, type Money, type MutationOptions, type OffersListResponse, type OneTimeOffer, type OneTimeOfferRegionalConfig, type OneTimeOfferState, type OneTimeOffersListResponse, type OneTimeProduct, type OneTimeProductAvailability, type OneTimeProductListing, type OneTimeProductsListResponse, type Order, type OrderLineItem, type PagedResponse, type PaginateOptions, type PlayApiClient, PlayApiError, type ProductPurchase, type ProductPurchaseLineItem, type ProductPurchaseV2, type ProductUpdateLatencyTolerance, RATE_LIMIT_BUCKETS, RESUMABLE_THRESHOLD, type RateLimitBucket, type RateLimiter, type RegionalBasePlanConfig, type Release, type ReleaseNote, type ReleaseStatus, type ReleaseSummary, type ReleasesListResponse, type ReportBucket, type ReportType, type ReportingAggregation, type ReportingApiClient, type ReportingDimension, type ReportsListResponse, type ResumableUploadOptions, type RetryLogEntry, type Review, type ReviewComment, type ReviewReplyRequest, type ReviewReplyResponse, type ReviewsListOptions, type ReviewsListResponse, type RevokeSubscriptionV2Request, type StatsDimension, type Subscription, type SubscriptionDeferRequest, type SubscriptionDeferResponse, type SubscriptionListing, type SubscriptionOffer, type SubscriptionOfferPhase, type SubscriptionPurchase, type SubscriptionPurchaseLineItem, type SubscriptionPurchaseV2, type SubscriptionState, type SubscriptionsBatchGetRequest, type SubscriptionsBatchGetResponse, type SubscriptionsBatchUpdateRequest, type SubscriptionsBatchUpdateResponse, type SubscriptionsListResponse, type SubscriptionsV2CancelRequest, type SubscriptionsV2DeferRequest, type SubscriptionsV2DeferResponse, type SystemApkDeviceSpec, type SystemApkOptions, type SystemApkVariant, type TaxAndComplianceSettings, type Testers, type TokenPagination, type Track, type TrackListResponse, type UploadProgressEvent, type UploadResponse, type User, type UserComment, type UsersApiClient, type UsersListResponse, type VitalsMetricSet, type VoidedPurchase, type VoidedPurchasesListResponse, createApiClient, createEnterpriseClient, createGamesClient, createHttpClient, createRateLimiter, createReportingClient, createUsersClient, paginate, paginateAll, paginateParallel, resolveBucket };
|