v2.4.d.ts
19.2 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
379
380
381
382
383
384
385
386
387
388
389
390
391
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace analytics_v2_4 {
interface Options extends GlobalOptions {
version: 'v2_4';
}
interface StandardParameters {
/**
* 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 Analytics API
*
* Views and manages your Google Analytics data.
*
* @example
* const {google} = require('googleapis');
* const analytics = google.analytics('v2.4');
*
* @namespace analytics
* @type {Function}
* @version v2.4
* @variation v2.4
* @param {object=} options Options for Analytics
*/
class Analytics {
context: APIRequestContext;
data: Resource$Data;
management: Resource$Management;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
class Resource$Data {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* analytics.data.get
* @desc Returns Analytics report data for a view (profile).
* @alias analytics.data.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
* @param {string} params.end-date End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.
* @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to the report data.
* @param {string} params.ids Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
* @param {integer=} params.max-results The maximum number of entries to include in this feed.
* @param {string} params.metrics A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.
* @param {string=} params.segment An Analytics advanced segment to be applied to the report data.
* @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for the report data.
* @param {string} params.start-date Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.
* @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
* @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$Data$Get, options?: MethodOptions): GaxiosPromise<void>;
get(params: Params$Resource$Data$Get, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
get(params: Params$Resource$Data$Get, callback: BodyResponseCallback<void>): void;
get(callback: BodyResponseCallback<void>): void;
}
interface Params$Resource$Data$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A comma-separated list of Analytics dimensions. E.g.,
* 'ga:browser,ga:city'.
*/
dimensions?: string;
/**
* End date for fetching report data. All requests should specify an end
* date formatted as YYYY-MM-DD.
*/
'end-date'?: string;
/**
* A comma-separated list of dimension or metric filters to be applied to
* the report data.
*/
filters?: string;
/**
* Unique table ID for retrieving report data. Table ID is of the form
* ga:XXXX, where XXXX is the Analytics view (profile) ID.
*/
ids?: string;
/**
* The maximum number of entries to include in this feed.
*/
'max-results'?: number;
/**
* A comma-separated list of Analytics metrics. E.g.,
* 'ga:sessions,ga:pageviews'. At least one metric must be specified to
* retrieve a valid Analytics report.
*/
metrics?: string;
/**
* An Analytics advanced segment to be applied to the report data.
*/
segment?: string;
/**
* A comma-separated list of dimensions or metrics that determine the sort
* order for the report data.
*/
sort?: string;
/**
* Start date for fetching report data. All requests should specify a start
* date formatted as YYYY-MM-DD.
*/
'start-date'?: string;
/**
* An index of the first entity to retrieve. Use this parameter as a
* pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
class Resource$Management {
context: APIRequestContext;
accounts: Resource$Management$Accounts;
goals: Resource$Management$Goals;
profiles: Resource$Management$Profiles;
segments: Resource$Management$Segments;
webproperties: Resource$Management$Webproperties;
constructor(context: APIRequestContext);
}
class Resource$Management$Accounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* analytics.management.accounts.list
* @desc Lists all accounts to which the user has access.
* @alias analytics.management.accounts.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.max-results The maximum number of accounts to include in this response.
* @param {integer=} params.start-index An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
* @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$Management$Accounts$List, options?: MethodOptions): GaxiosPromise<void>;
list(params: Params$Resource$Management$Accounts$List, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
list(params: Params$Resource$Management$Accounts$List, callback: BodyResponseCallback<void>): void;
list(callback: BodyResponseCallback<void>): void;
}
interface Params$Resource$Management$Accounts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of accounts to include in this response.
*/
'max-results'?: number;
/**
* An index of the first account to retrieve. Use this parameter as a
* pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
class Resource$Management$Goals {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* analytics.management.goals.list
* @desc Lists goals to which the user has access.
* @alias analytics.management.goals.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
* @param {integer=} params.max-results The maximum number of goals to include in this response.
* @param {string} params.profileId View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.
* @param {integer=} params.start-index An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
* @param {string} params.webPropertyId Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
* @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$Management$Goals$List, options?: MethodOptions): GaxiosPromise<void>;
list(params: Params$Resource$Management$Goals$List, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
list(params: Params$Resource$Management$Goals$List, callback: BodyResponseCallback<void>): void;
list(callback: BodyResponseCallback<void>): void;
}
interface Params$Resource$Management$Goals$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID to retrieve goals for. Can either be a specific account ID or
* '~all', which refers to all the accounts that user has access to.
*/
accountId?: string;
/**
* The maximum number of goals to include in this response.
*/
'max-results'?: number;
/**
* View (Profile) ID to retrieve goals for. Can either be a specific view
* (profile) ID or '~all', which refers to all the views (profiles) that
* user has access to.
*/
profileId?: string;
/**
* An index of the first goal to retrieve. Use this parameter as a
* pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
* Web property ID to retrieve goals for. Can either be a specific web
* property ID or '~all', which refers to all the web properties that user
* has access to.
*/
webPropertyId?: string;
}
class Resource$Management$Profiles {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* analytics.management.profiles.list
* @desc Lists views (profiles) to which the user has access.
* @alias analytics.management.profiles.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.
* @param {integer=} params.max-results The maximum number of views (profiles) to include in this response.
* @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
* @param {string} params.webPropertyId Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.
* @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$Management$Profiles$List, options?: MethodOptions): GaxiosPromise<void>;
list(params: Params$Resource$Management$Profiles$List, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
list(params: Params$Resource$Management$Profiles$List, callback: BodyResponseCallback<void>): void;
list(callback: BodyResponseCallback<void>): void;
}
interface Params$Resource$Management$Profiles$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID for the views (profiles) to retrieve. Can either be a specific
* account ID or '~all', which refers to all the accounts to which the user
* has access.
*/
accountId?: string;
/**
* The maximum number of views (profiles) to include in this response.
*/
'max-results'?: number;
/**
* An index of the first entity to retrieve. Use this parameter as a
* pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
* Web property ID for the views (profiles) to retrieve. Can either be a
* specific web property ID or '~all', which refers to all the web
* properties to which the user has access.
*/
webPropertyId?: string;
}
class Resource$Management$Segments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* analytics.management.segments.list
* @desc Lists advanced segments to which the user has access.
* @alias analytics.management.segments.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.max-results The maximum number of advanced segments to include in this response.
* @param {integer=} params.start-index An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
* @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$Management$Segments$List, options?: MethodOptions): GaxiosPromise<void>;
list(params: Params$Resource$Management$Segments$List, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
list(params: Params$Resource$Management$Segments$List, callback: BodyResponseCallback<void>): void;
list(callback: BodyResponseCallback<void>): void;
}
interface Params$Resource$Management$Segments$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of advanced segments to include in this response.
*/
'max-results'?: number;
/**
* An index of the first advanced segment to retrieve. Use this parameter as
* a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
class Resource$Management$Webproperties {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* analytics.management.webproperties.list
* @desc Lists web properties to which the user has access.
* @alias analytics.management.webproperties.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
* @param {integer=} params.max-results The maximum number of web properties to include in this response.
* @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
* @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$Management$Webproperties$List, options?: MethodOptions): GaxiosPromise<void>;
list(params: Params$Resource$Management$Webproperties$List, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
list(params: Params$Resource$Management$Webproperties$List, callback: BodyResponseCallback<void>): void;
list(callback: BodyResponseCallback<void>): void;
}
interface Params$Resource$Management$Webproperties$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID to retrieve web properties for. Can either be a specific
* account ID or '~all', which refers to all the accounts that user has
* access to.
*/
accountId?: string;
/**
* The maximum number of web properties to include in this response.
*/
'max-results'?: number;
/**
* An index of the first entity to retrieve. Use this parameter as a
* pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
}