v1.d.ts
15 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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/// <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 appsactivity_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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;
}
/**
* Drive Activity API
*
* Provides a historical view of activity.
*
* @example
* const {google} = require('googleapis');
* const appsactivity = google.appsactivity('v1');
*
* @namespace appsactivity
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Appsactivity
*/
export class Appsactivity {
context: APIRequestContext;
activities: Resource$Activities;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.
*/
export interface Schema$Activity {
/**
* The fields common to all of the singleEvents that make up the Activity.
*/
combinedEvent?: Schema$Event;
/**
* A list of all the Events that make up the Activity.
*/
singleEvents?: Schema$Event[];
}
/**
* Represents the changes associated with an action taken by a user.
*/
export interface Schema$Event {
/**
* Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
*/
additionalEventTypes?: string[] | null;
/**
* The time at which the event occurred formatted as Unix time in milliseconds.
*/
eventTimeMillis?: string | null;
/**
* Whether this event is caused by a user being deleted.
*/
fromUserDeletion?: boolean | null;
/**
* Extra information for move type events, such as changes in an object's parents.
*/
move?: Schema$Move;
/**
* Extra information for permissionChange type events, such as the user or group the new permission applies to.
*/
permissionChanges?: Schema$PermissionChange[];
/**
* The main type of event that occurred.
*/
primaryEventType?: string | null;
/**
* Extra information for rename type events, such as the old and new names.
*/
rename?: Schema$Rename;
/**
* Information specific to the Target object modified by the event.
*/
target?: Schema$Target;
/**
* Represents the user responsible for the event.
*/
user?: Schema$User;
}
/**
* The response from the list request. Contains a list of activities and a token to retrieve the next page of results.
*/
export interface Schema$ListActivitiesResponse {
/**
* List of activities.
*/
activities?: Schema$Activity[];
/**
* Token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Contains information about changes in an object's parents as a result of a move type event.
*/
export interface Schema$Move {
/**
* The added parent(s).
*/
addedParents?: Schema$Parent[];
/**
* The removed parent(s).
*/
removedParents?: Schema$Parent[];
}
/**
* Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
*/
export interface Schema$Parent {
/**
* The parent's ID.
*/
id?: string | null;
/**
* Whether this is the root folder.
*/
isRoot?: boolean | null;
/**
* The parent's title.
*/
title?: string | null;
}
/**
* Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
*/
export interface Schema$Permission {
/**
* The name of the user or group the permission applies to.
*/
name?: string | null;
/**
* The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
*/
permissionId?: string | null;
/**
* Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
*/
role?: string | null;
/**
* Indicates how widely permissions are granted.
*/
type?: string | null;
/**
* The user's information if the type is USER.
*/
user?: Schema$User;
/**
* Whether the permission requires a link to the file.
*/
withLink?: boolean | null;
}
/**
* Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
*/
export interface Schema$PermissionChange {
/**
* Lists all Permission objects added.
*/
addedPermissions?: Schema$Permission[];
/**
* Lists all Permission objects removed.
*/
removedPermissions?: Schema$Permission[];
}
/**
* Photo information for a user.
*/
export interface Schema$Photo {
/**
* The URL of the photo.
*/
url?: string | null;
}
/**
* Contains information about a renametype event.
*/
export interface Schema$Rename {
/**
* The new title.
*/
newTitle?: string | null;
/**
* The old title.
*/
oldTitle?: string | null;
}
/**
* Information about the object modified by the event.
*/
export interface Schema$Target {
/**
* The ID of the target. For example, in Google Drive, this is the file or folder ID.
*/
id?: string | null;
/**
* The MIME type of the target.
*/
mimeType?: string | null;
/**
* The name of the target. For example, in Google Drive, this is the title of the file.
*/
name?: string | null;
}
/**
* A representation of a user.
*/
export interface Schema$User {
/**
* A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
*/
isDeleted?: boolean | null;
/**
* Whether the user is the authenticated user.
*/
isMe?: boolean | null;
/**
* The displayable name of the user.
*/
name?: string | null;
/**
* The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
*/
permissionId?: string | null;
/**
* The profile photo of the user. Not present if the user has no profile photo.
*/
photo?: Schema$Photo;
}
export class Resource$Activities {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appsactivity.activities.list
* @desc Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/appsactivity.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 appsactivity = google.appsactivity('v1');
*
* 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/activity'],
* });
*
* // 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 appsactivity.activities.list({
* // Identifies the Drive folder containing the items for which to return activities.
* 'drive.ancestorId': 'placeholder-value',
* // Identifies the Drive item to return activities for.
* 'drive.fileId': 'placeholder-value',
* // Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
* groupingStrategy: 'placeholder-value',
* // The maximum number of events to return on a page. The response includes a continuation token if there are more events.
* pageSize: 'placeholder-value',
* // A token to retrieve a specific page of results.
* pageToken: 'placeholder-value',
* // The Google service from which to return activities. Possible values of source are:
* // - drive.google.com
* source: 'placeholder-value',
* // The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.
* userId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activities": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias appsactivity.activities.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.drive.ancestorId Identifies the Drive folder containing the items for which to return activities.
* @param {string=} params.drive.fileId Identifies the Drive item to return activities for.
* @param {string=} params.groupingStrategy Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
* @param {integer=} params.pageSize The maximum number of events to return on a page. The response includes a continuation token if there are more events.
* @param {string=} params.pageToken A token to retrieve a specific page of results.
* @param {string=} params.source The Google service from which to return activities. Possible values of source are: - drive.google.com
* @param {string=} params.userId The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.
* @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$Activities$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Activities$List, options?: MethodOptions): GaxiosPromise<Schema$ListActivitiesResponse>;
list(params: Params$Resource$Activities$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Activities$List, options: MethodOptions | BodyResponseCallback<Schema$ListActivitiesResponse>, callback: BodyResponseCallback<Schema$ListActivitiesResponse>): void;
list(params: Params$Resource$Activities$List, callback: BodyResponseCallback<Schema$ListActivitiesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListActivitiesResponse>): void;
}
export interface Params$Resource$Activities$List extends StandardParameters {
/**
* Identifies the Drive folder containing the items for which to return activities.
*/
'drive.ancestorId'?: string;
/**
* Identifies the Drive item to return activities for.
*/
'drive.fileId'?: string;
/**
* Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
*/
groupingStrategy?: string;
/**
* The maximum number of events to return on a page. The response includes a continuation token if there are more events.
*/
pageSize?: number;
/**
* A token to retrieve a specific page of results.
*/
pageToken?: string;
/**
* The Google service from which to return activities. Possible values of source are: - drive.google.com
*/
source?: string;
/**
* The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.
*/
userId?: string;
}
export {};
}