v2.d.ts
16.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace androidpublisher_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | GoogleAuth;
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Google Play Developer API
*
* Accesses Android application developers' Google Play accounts.
*
* @example
* const {google} = require('googleapis');
* const androidpublisher = google.androidpublisher('v2');
*
* @namespace androidpublisher
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Androidpublisher
*/
export class Androidpublisher {
context: APIRequestContext;
purchases: Resource$Purchases;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$PageInfo {
resultPerPage?: number | null;
startIndex?: number | null;
totalResults?: number | null;
}
/**
* A ProductPurchase resource indicates the status of a user's inapp product purchase.
*/
export interface Schema$ProductPurchase {
/**
* The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed
*/
consumptionState?: number | null;
/**
* A developer-specified string that contains supplemental information about an order.
*/
developerPayload?: string | null;
/**
* This kind represents an inappPurchase object in the androidpublisher service.
*/
kind?: string | null;
/**
* The order id associated with the purchase of the inapp product.
*/
orderId?: string | null;
/**
* The purchase state of the order. Possible values are: - Purchased - Canceled - Pending
*/
purchaseState?: number | null;
/**
* The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTimeMillis?: string | null;
/**
* The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying)
*/
purchaseType?: number | null;
}
export interface Schema$TokenPagination {
nextPageToken?: string | null;
previousPageToken?: string | null;
}
/**
* A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
*/
export interface Schema$VoidedPurchase {
/**
* This kind represents a voided purchase object in the androidpublisher service.
*/
kind?: string | null;
/**
* The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTimeMillis?: string | null;
/**
* The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).
*/
purchaseToken?: string | null;
/**
* The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
*/
voidedTimeMillis?: string | null;
}
export interface Schema$VoidedPurchasesListResponse {
pageInfo?: Schema$PageInfo;
tokenPagination?: Schema$TokenPagination;
voidedPurchases?: Schema$VoidedPurchase[];
}
export class Resource$Purchases {
context: APIRequestContext;
products: Resource$Purchases$Products;
voidedpurchases: Resource$Purchases$Voidedpurchases;
constructor(context: APIRequestContext);
}
export class Resource$Purchases$Products {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidpublisher.purchases.products.get
* @desc Checks the purchase and consumption status of an inapp item.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const androidpublisher = google.androidpublisher('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/androidpublisher'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await androidpublisher.purchases.products.get({
* // The package name of the application the inapp product was sold in (for example, 'com.some.thing').
* packageName: 'placeholder-value',
* // The inapp product SKU (for example, 'com.some.thing.inapp1').
* productId: 'placeholder-value',
* // The token provided to the user's device when the inapp product was purchased.
* token: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "consumptionState": 0,
* // "developerPayload": "my_developerPayload",
* // "kind": "my_kind",
* // "orderId": "my_orderId",
* // "purchaseState": 0,
* // "purchaseTimeMillis": "my_purchaseTimeMillis",
* // "purchaseType": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias androidpublisher.purchases.products.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing').
* @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1').
* @param {string} params.token The token provided to the user's device when the inapp product was purchased.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params: Params$Resource$Purchases$Products$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Purchases$Products$Get, options?: MethodOptions): GaxiosPromise<Schema$ProductPurchase>;
get(params: Params$Resource$Purchases$Products$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Purchases$Products$Get, options: MethodOptions | BodyResponseCallback<Schema$ProductPurchase>, callback: BodyResponseCallback<Schema$ProductPurchase>): void;
get(params: Params$Resource$Purchases$Products$Get, callback: BodyResponseCallback<Schema$ProductPurchase>): void;
get(callback: BodyResponseCallback<Schema$ProductPurchase>): void;
}
export interface Params$Resource$Purchases$Products$Get extends StandardParameters {
/**
* The package name of the application the inapp product was sold in (for example, 'com.some.thing').
*/
packageName?: string;
/**
* The inapp product SKU (for example, 'com.some.thing.inapp1').
*/
productId?: string;
/**
* The token provided to the user's device when the inapp product was purchased.
*/
token?: string;
}
export class Resource$Purchases$Voidedpurchases {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidpublisher.purchases.voidedpurchases.list
* @desc Lists the purchases that were canceled, refunded or charged-back.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const androidpublisher = google.androidpublisher('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/androidpublisher'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await androidpublisher.purchases.voidedpurchases.list({
* // The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
* endTime: 'placeholder-value',
*
* maxResults: 'placeholder-value',
* // The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
* packageName: 'placeholder-value',
*
* startIndex: 'placeholder-value',
* // The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
* startTime: 'placeholder-value',
*
* token: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "pageInfo": {},
* // "tokenPagination": {},
* // "voidedPurchases": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias androidpublisher.purchases.voidedpurchases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.endTime The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
* @param {integer=} params.maxResults
* @param {string} params.packageName The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
* @param {integer=} params.startIndex
* @param {string=} params.startTime The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
* @param {string=} params.token
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params: Params$Resource$Purchases$Voidedpurchases$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Purchases$Voidedpurchases$List, options?: MethodOptions): GaxiosPromise<Schema$VoidedPurchasesListResponse>;
list(params: Params$Resource$Purchases$Voidedpurchases$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Purchases$Voidedpurchases$List, options: MethodOptions | BodyResponseCallback<Schema$VoidedPurchasesListResponse>, callback: BodyResponseCallback<Schema$VoidedPurchasesListResponse>): void;
list(params: Params$Resource$Purchases$Voidedpurchases$List, callback: BodyResponseCallback<Schema$VoidedPurchasesListResponse>): void;
list(callback: BodyResponseCallback<Schema$VoidedPurchasesListResponse>): void;
}
export interface Params$Resource$Purchases$Voidedpurchases$List extends StandardParameters {
/**
* The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
*/
endTime?: string;
/**
*
*/
maxResults?: number;
/**
* The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
*/
packageName?: string;
/**
*
*/
startIndex?: number;
/**
* The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
*/
startTime?: string;
/**
*
*/
token?: string;
}
export {};
}