@google-analytics/data 4.0.1 → 4.1.0

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.
@@ -127,66 +127,67 @@ export declare class AlphaAnalyticsDataClient {
127
127
  *
128
128
  * @param {Object} request
129
129
  * The request object that will be sent.
130
- * @param {string} request.property
131
- * A Google Analytics GA4 property identifier whose events are tracked.
132
- * Specified in the URL path and not the body. To learn more, see [where to
133
- * find your Property
130
+ * @param {string} [request.property]
131
+ * Optional. A Google Analytics GA4 property identifier whose events are
132
+ * tracked. Specified in the URL path and not the body. To learn more, see
133
+ * [where to find your Property
134
134
  * ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
135
135
  * Within a batch request, this property should either be unspecified or
136
136
  * consistent with the batch-level property.
137
137
  *
138
138
  * Example: properties/1234
139
- * @param {number[]} request.dateRanges
140
- * Date ranges of data to read. If multiple date ranges are requested, each
141
- * response row will contain a zero based date range index. If two date
142
- * ranges overlap, the event data for the overlapping days is included in the
143
- * response rows for both date ranges.
144
- * @param {google.analytics.data.v1alpha.Funnel} request.funnel
145
- * The configuration of this request's funnel. This funnel configuration is
146
- * required.
147
- * @param {google.analytics.data.v1alpha.FunnelBreakdown} request.funnelBreakdown
148
- * If specified, this breakdown adds a dimension to the funnel table sub
149
- * report response. This breakdown dimension expands each funnel step to the
150
- * unique values of the breakdown dimension. For example, a breakdown by the
151
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
139
+ * @param {number[]} [request.dateRanges]
140
+ * Optional. Date ranges of data to read. If multiple date ranges are
141
+ * requested, each response row will contain a zero based date range index. If
142
+ * two date ranges overlap, the event data for the overlapping days is
143
+ * included in the response rows for both date ranges.
144
+ * @param {google.analytics.data.v1alpha.Funnel} [request.funnel]
145
+ * Optional. The configuration of this request's funnel. This funnel
146
+ * configuration is required.
147
+ * @param {google.analytics.data.v1alpha.FunnelBreakdown} [request.funnelBreakdown]
148
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
149
+ * sub report response. This breakdown dimension expands each funnel step to
150
+ * the unique values of the breakdown dimension. For example, a breakdown by
151
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
152
152
  * `desktop`, and the total.
153
- * @param {google.analytics.data.v1alpha.FunnelNextAction} request.funnelNextAction
154
- * If specified, next action adds a dimension to the funnel visualization sub
155
- * report response. This next action dimension expands each funnel step to the
156
- * unique values of the next action. For example a next action of the
157
- * `eventName` dimension will create rows for several events (for example
158
- * `session_start` & `click`) and the total.
153
+ * @param {google.analytics.data.v1alpha.FunnelNextAction} [request.funnelNextAction]
154
+ * Optional. If specified, next action adds a dimension to the funnel
155
+ * visualization sub report response. This next action dimension expands each
156
+ * funnel step to the unique values of the next action. For example a next
157
+ * action of the `eventName` dimension will create rows for several events
158
+ * (for example `session_start` & `click`) and the total.
159
159
  *
160
160
  * Next action only supports `eventName` and most Page / Screen dimensions
161
161
  * like `pageTitle` and `pagePath`.
162
- * @param {google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType} request.funnelVisualizationType
163
- * The funnel visualization type controls the dimensions present in the funnel
164
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
165
- * used.
166
- * @param {number[]} request.segments
167
- * The configurations of segments. Segments are subsets of a property's data.
168
- * In a funnel report with segments, the funnel is evaluated in each segment.
162
+ * @param {google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType} [request.funnelVisualizationType]
163
+ * Optional. The funnel visualization type controls the dimensions present in
164
+ * the funnel visualization sub report response. If not specified,
165
+ * `STANDARD_FUNNEL` is used.
166
+ * @param {number[]} [request.segments]
167
+ * Optional. The configurations of segments. Segments are subsets of a
168
+ * property's data. In a funnel report with segments, the funnel is evaluated
169
+ * in each segment.
169
170
  *
170
171
  * Each segment specified in this request
171
172
  * produces a separate row in the response; in the response, each segment
172
173
  * identified by its name.
173
174
  *
174
175
  * The segments parameter is optional. Requests are limited to 4 segments.
175
- * @param {number} request.limit
176
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
177
- * API returns a maximum of 250,000 rows per request, no matter how many you
178
- * ask for. `limit` must be positive.
176
+ * @param {number} [request.limit]
177
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
178
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
179
+ * how many you ask for. `limit` must be positive.
179
180
  *
180
181
  * The API can also return fewer rows than the requested `limit`, if there
181
182
  * aren't as many dimension values as the `limit`.
182
- * @param {google.analytics.data.v1alpha.FilterExpression} request.dimensionFilter
183
- * Dimension filters allow you to ask for only specific dimension values in
184
- * the report. To learn more, see [Creating a Report: Dimension
183
+ * @param {google.analytics.data.v1alpha.FilterExpression} [request.dimensionFilter]
184
+ * Optional. Dimension filters allow you to ask for only specific dimension
185
+ * values in the report. To learn more, see [Creating a Report: Dimension
185
186
  * Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
186
187
  * for examples. Metrics cannot be used in this filter.
187
- * @param {boolean} request.returnPropertyQuota
188
- * Toggles whether to return the current state of this Analytics Property's
189
- * quota. Quota is returned in [PropertyQuota](#PropertyQuota).
188
+ * @param {boolean} [request.returnPropertyQuota]
189
+ * Optional. Toggles whether to return the current state of this Analytics
190
+ * Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
190
191
  * @param {object} [options]
191
192
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
192
193
  * @returns {Promise} - The promise which resolves to an array.
@@ -207,19 +208,31 @@ export declare class AlphaAnalyticsDataClient {
207
208
  * Retrieves an audience list of users. After creating an audience, the users
208
209
  * are not immediately available for listing. First, a request to
209
210
  * `CreateAudienceList` is necessary to create an audience list of users, and
210
- * then second, this method is used to retrieve the users in the audience.
211
+ * then second, this method is used to retrieve the users in the audience
212
+ * list.
213
+ *
214
+ * See [Creating an Audience
215
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
216
+ * for an introduction to Audience Lists with examples.
211
217
  *
212
218
  * Audiences in Google Analytics 4 allow you to segment your users in the ways
213
219
  * that are important to your business. To learn more, see
214
220
  * https://support.google.com/analytics/answer/9267572.
215
221
  *
222
+ * This method is introduced at alpha stability with the intention of
223
+ * gathering feedback on syntax and capabilities before entering beta. To give
224
+ * your feedback on this API, complete the
225
+ * [Google Analytics Audience Export API
226
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
227
+ *
216
228
  * @param {Object} request
217
229
  * The request object that will be sent.
218
230
  * @param {string} request.name
219
- * The name of the audience list to retrieve users from.
220
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
221
- * @param {number} request.offset
222
- * The row count of the start row. The first row is counted as row 0.
231
+ * Required. The name of the audience list to retrieve users from.
232
+ * Format: `properties/{property}/audienceLists/{audience_list}`
233
+ * @param {number} [request.offset]
234
+ * Optional. The row count of the start row. The first row is counted as row
235
+ * 0.
223
236
  *
224
237
  * When paging, the first request does not specify offset; or equivalently,
225
238
  * sets offset to 0; the first request returns the first `limit` of rows. The
@@ -228,10 +241,10 @@ export declare class AlphaAnalyticsDataClient {
228
241
  *
229
242
  * To learn more about this pagination parameter, see
230
243
  * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
231
- * @param {number} request.limit
232
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
233
- * API returns a maximum of 250,000 rows per request, no matter how many you
234
- * ask for. `limit` must be positive.
244
+ * @param {number} [request.limit]
245
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
246
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
247
+ * how many you ask for. `limit` must be positive.
235
248
  *
236
249
  * The API can also return fewer rows than the requested `limit`, if there
237
250
  * aren't as many dimension values as the `limit`.
@@ -254,15 +267,88 @@ export declare class AlphaAnalyticsDataClient {
254
267
  ]>;
255
268
  queryAudienceList(request: protos.google.analytics.data.v1alpha.IQueryAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IQueryAudienceListResponse, protos.google.analytics.data.v1alpha.IQueryAudienceListRequest | null | undefined, {} | null | undefined>): void;
256
269
  queryAudienceList(request: protos.google.analytics.data.v1alpha.IQueryAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.IQueryAudienceListResponse, protos.google.analytics.data.v1alpha.IQueryAudienceListRequest | null | undefined, {} | null | undefined>): void;
270
+ /**
271
+ * Exports an audience list of users to a Google Sheet. After creating an
272
+ * audience, the users are not immediately available for listing. First, a
273
+ * request to `CreateAudienceList` is necessary to create an audience list of
274
+ * users, and then second, this method is used to export those users in the
275
+ * audience list to a Google Sheet.
276
+ *
277
+ * See [Creating an Audience
278
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
279
+ * for an introduction to Audience Lists with examples.
280
+ *
281
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
282
+ * that are important to your business. To learn more, see
283
+ * https://support.google.com/analytics/answer/9267572.
284
+ *
285
+ * This method is introduced at alpha stability with the intention of
286
+ * gathering feedback on syntax and capabilities before entering beta. To give
287
+ * your feedback on this API, complete the
288
+ * [Google Analytics Audience Export API
289
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
290
+ *
291
+ * @param {Object} request
292
+ * The request object that will be sent.
293
+ * @param {string} request.name
294
+ * Required. The name of the audience list to retrieve users from.
295
+ * Format: `properties/{property}/audienceLists/{audience_list}`
296
+ * @param {number} [request.offset]
297
+ * Optional. The row count of the start row. The first row is counted as row
298
+ * 0.
299
+ *
300
+ * When paging, the first request does not specify offset; or equivalently,
301
+ * sets offset to 0; the first request returns the first `limit` of rows. The
302
+ * second request sets offset to the `limit` of the first request; the second
303
+ * request returns the second `limit` of rows.
304
+ *
305
+ * To learn more about this pagination parameter, see
306
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
307
+ * @param {number} [request.limit]
308
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
309
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
310
+ * how many you ask for. `limit` must be positive.
311
+ *
312
+ * The API can also return fewer rows than the requested `limit`, if there
313
+ * aren't as many dimension values as the `limit`.
314
+ *
315
+ * To learn more about this pagination parameter, see
316
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
317
+ * @param {object} [options]
318
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
319
+ * @returns {Promise} - The promise which resolves to an array.
320
+ * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.SheetExportAudienceListResponse|SheetExportAudienceListResponse}.
321
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
322
+ * for more details and examples.
323
+ * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.sheet_export_audience_list.js</caption>
324
+ * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_SheetExportAudienceList_async
325
+ */
326
+ sheetExportAudienceList(request?: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, options?: CallOptions): Promise<[
327
+ protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse,
328
+ (protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | undefined),
329
+ {} | undefined
330
+ ]>;
331
+ sheetExportAudienceList(request: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse, protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | null | undefined, {} | null | undefined>): void;
332
+ sheetExportAudienceList(request: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse, protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | null | undefined, {} | null | undefined>): void;
257
333
  /**
258
334
  * Gets configuration metadata about a specific audience list. This method
259
335
  * can be used to understand an audience list after it has been created.
260
336
  *
337
+ * See [Creating an Audience
338
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
339
+ * for an introduction to Audience Lists with examples.
340
+ *
341
+ * This method is introduced at alpha stability with the intention of
342
+ * gathering feedback on syntax and capabilities before entering beta. To give
343
+ * your feedback on this API, complete the
344
+ * [Google Analytics Audience Export API
345
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
346
+ *
261
347
  * @param {Object} request
262
348
  * The request object that will be sent.
263
349
  * @param {string} request.name
264
350
  * Required. The audience list resource name.
265
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
351
+ * Format: `properties/{property}/audienceLists/{audience_list}`
266
352
  * @param {object} [options]
267
353
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
268
354
  * @returns {Promise} - The promise which resolves to an array.
@@ -286,6 +372,10 @@ export declare class AlphaAnalyticsDataClient {
286
372
  * first create the audience list through this method and then send the
287
373
  * audience resource name to the `QueryAudienceList` method.
288
374
  *
375
+ * See [Creating an Audience
376
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
377
+ * for an introduction to Audience Lists with examples.
378
+ *
289
379
  * An audience list is a snapshot of the users currently in the audience at
290
380
  * the time of audience list creation. Creating audience lists for one
291
381
  * audience on different days will return different results as users enter and
@@ -296,11 +386,17 @@ export declare class AlphaAnalyticsDataClient {
296
386
  * https://support.google.com/analytics/answer/9267572. Audience lists contain
297
387
  * the users in each audience.
298
388
  *
389
+ * This method is introduced at alpha stability with the intention of
390
+ * gathering feedback on syntax and capabilities before entering beta. To give
391
+ * your feedback on this API, complete the
392
+ * [Google Analytics Audience Export API
393
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
394
+ *
299
395
  * @param {Object} request
300
396
  * The request object that will be sent.
301
397
  * @param {string} request.parent
302
398
  * Required. The parent resource where this audience list will be created.
303
- * Format: `properties/{propertyId}`
399
+ * Format: `properties/{property}`
304
400
  * @param {google.analytics.data.v1alpha.AudienceList} request.audienceList
305
401
  * Required. The audience list to create.
306
402
  * @param {object} [options]
@@ -339,19 +435,29 @@ export declare class AlphaAnalyticsDataClient {
339
435
  * audience lists. The same audience can have multiple audience lists that
340
436
  * represent the list of users that were in an audience on different days.
341
437
  *
438
+ * See [Creating an Audience
439
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
440
+ * for an introduction to Audience Lists with examples.
441
+ *
442
+ * This method is introduced at alpha stability with the intention of
443
+ * gathering feedback on syntax and capabilities before entering beta. To give
444
+ * your feedback on this API, complete the
445
+ * [Google Analytics Audience Export API
446
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
447
+ *
342
448
  * @param {Object} request
343
449
  * The request object that will be sent.
344
450
  * @param {string} request.parent
345
451
  * Required. All audience lists for this property will be listed in the
346
- * response. Format: `properties/{propertyId}`
347
- * @param {number} request.pageSize
348
- * The maximum number of audience lists to return. The service may return
349
- * fewer than this value. If unspecified, at most 200 audience lists will be
350
- * returned. The maximum value is 1000 (higher values will be coerced to the
351
- * maximum).
352
- * @param {string} request.pageToken
353
- * A page token, received from a previous `ListAudienceLists` call. Provide
354
- * this to retrieve the subsequent page.
452
+ * response. Format: `properties/{property}`
453
+ * @param {number} [request.pageSize]
454
+ * Optional. The maximum number of audience lists to return. The service may
455
+ * return fewer than this value. If unspecified, at most 200 audience lists
456
+ * will be returned. The maximum value is 1000 (higher values will be coerced
457
+ * to the maximum).
458
+ * @param {string} [request.pageToken]
459
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
460
+ * Provide this to retrieve the subsequent page.
355
461
  *
356
462
  * When paginating, all other parameters provided to `ListAudienceLists` must
357
463
  * match the call that provided the page token.
@@ -380,15 +486,15 @@ export declare class AlphaAnalyticsDataClient {
380
486
  * The request object that will be sent.
381
487
  * @param {string} request.parent
382
488
  * Required. All audience lists for this property will be listed in the
383
- * response. Format: `properties/{propertyId}`
384
- * @param {number} request.pageSize
385
- * The maximum number of audience lists to return. The service may return
386
- * fewer than this value. If unspecified, at most 200 audience lists will be
387
- * returned. The maximum value is 1000 (higher values will be coerced to the
388
- * maximum).
389
- * @param {string} request.pageToken
390
- * A page token, received from a previous `ListAudienceLists` call. Provide
391
- * this to retrieve the subsequent page.
489
+ * response. Format: `properties/{property}`
490
+ * @param {number} [request.pageSize]
491
+ * Optional. The maximum number of audience lists to return. The service may
492
+ * return fewer than this value. If unspecified, at most 200 audience lists
493
+ * will be returned. The maximum value is 1000 (higher values will be coerced
494
+ * to the maximum).
495
+ * @param {string} [request.pageToken]
496
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
497
+ * Provide this to retrieve the subsequent page.
392
498
  *
393
499
  * When paginating, all other parameters provided to `ListAudienceLists` must
394
500
  * match the call that provided the page token.
@@ -412,15 +518,15 @@ export declare class AlphaAnalyticsDataClient {
412
518
  * The request object that will be sent.
413
519
  * @param {string} request.parent
414
520
  * Required. All audience lists for this property will be listed in the
415
- * response. Format: `properties/{propertyId}`
416
- * @param {number} request.pageSize
417
- * The maximum number of audience lists to return. The service may return
418
- * fewer than this value. If unspecified, at most 200 audience lists will be
419
- * returned. The maximum value is 1000 (higher values will be coerced to the
420
- * maximum).
421
- * @param {string} request.pageToken
422
- * A page token, received from a previous `ListAudienceLists` call. Provide
423
- * this to retrieve the subsequent page.
521
+ * response. Format: `properties/{property}`
522
+ * @param {number} [request.pageSize]
523
+ * Optional. The maximum number of audience lists to return. The service may
524
+ * return fewer than this value. If unspecified, at most 200 audience lists
525
+ * will be returned. The maximum value is 1000 (higher values will be coerced
526
+ * to the maximum).
527
+ * @param {string} [request.pageToken]
528
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
529
+ * Provide this to retrieve the subsequent page.
424
530
  *
425
531
  * When paginating, all other parameters provided to `ListAudienceLists` must
426
532
  * match the call that provided the page token.
@@ -440,42 +546,42 @@ export declare class AlphaAnalyticsDataClient {
440
546
  /**
441
547
  * Return a fully-qualified audienceList resource name string.
442
548
  *
443
- * @param {string} propertyId
444
- * @param {string} audienceListId
549
+ * @param {string} property
550
+ * @param {string} audience_list
445
551
  * @returns {string} Resource name string.
446
552
  */
447
- audienceListPath(propertyId: string, audienceListId: string): string;
553
+ audienceListPath(property: string, audienceList: string): string;
448
554
  /**
449
- * Parse the propertyId from AudienceList resource.
555
+ * Parse the property from AudienceList resource.
450
556
  *
451
557
  * @param {string} audienceListName
452
558
  * A fully-qualified path representing AudienceList resource.
453
- * @returns {string} A string representing the propertyId.
559
+ * @returns {string} A string representing the property.
454
560
  */
455
- matchPropertyIdFromAudienceListName(audienceListName: string): string | number;
561
+ matchPropertyFromAudienceListName(audienceListName: string): string | number;
456
562
  /**
457
- * Parse the audienceListId from AudienceList resource.
563
+ * Parse the audience_list from AudienceList resource.
458
564
  *
459
565
  * @param {string} audienceListName
460
566
  * A fully-qualified path representing AudienceList resource.
461
- * @returns {string} A string representing the audienceListId.
567
+ * @returns {string} A string representing the audience_list.
462
568
  */
463
- matchAudienceListIdFromAudienceListName(audienceListName: string): string | number;
569
+ matchAudienceListFromAudienceListName(audienceListName: string): string | number;
464
570
  /**
465
571
  * Return a fully-qualified property resource name string.
466
572
  *
467
- * @param {string} propertyId
573
+ * @param {string} property
468
574
  * @returns {string} Resource name string.
469
575
  */
470
- propertyPath(propertyId: string): string;
576
+ propertyPath(property: string): string;
471
577
  /**
472
- * Parse the propertyId from Property resource.
578
+ * Parse the property from Property resource.
473
579
  *
474
580
  * @param {string} propertyName
475
581
  * A fully-qualified path representing Property resource.
476
- * @returns {string} A string representing the propertyId.
582
+ * @returns {string} A string representing the property.
477
583
  */
478
- matchPropertyIdFromPropertyName(propertyName: string): string | number;
584
+ matchPropertyFromPropertyName(propertyName: string): string | number;
479
585
  /**
480
586
  * Terminate the gRPC channel and close the client.
481
587
  *
@@ -137,8 +137,8 @@ class AlphaAnalyticsDataClient {
137
137
  // identifiers to uniquely identify resources within the API.
138
138
  // Create useful helper objects for these.
139
139
  this.pathTemplates = {
140
- audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{propertyId}/audienceLists/{audienceListId}'),
141
- propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{propertyId}'),
140
+ audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/audienceLists/{audience_list}'),
141
+ propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{property}'),
142
142
  };
143
143
  // Some of the methods on this service return "paged" results,
144
144
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -204,6 +204,7 @@ class AlphaAnalyticsDataClient {
204
204
  'runFunnelReport',
205
205
  'createAudienceList',
206
206
  'queryAudienceList',
207
+ 'sheetExportAudienceList',
207
208
  'getAudienceList',
208
209
  'listAudienceLists',
209
210
  ];
@@ -256,6 +257,9 @@ class AlphaAnalyticsDataClient {
256
257
  return [
257
258
  'https://www.googleapis.com/auth/analytics',
258
259
  'https://www.googleapis.com/auth/analytics.readonly',
260
+ 'https://www.googleapis.com/auth/drive',
261
+ 'https://www.googleapis.com/auth/drive.file',
262
+ 'https://www.googleapis.com/auth/spreadsheets',
259
263
  ];
260
264
  }
261
265
  /**
@@ -311,6 +315,27 @@ class AlphaAnalyticsDataClient {
311
315
  this.initialize();
312
316
  return this.innerApiCalls.queryAudienceList(request, options, callback);
313
317
  }
318
+ sheetExportAudienceList(request, optionsOrCallback, callback) {
319
+ var _a;
320
+ request = request || {};
321
+ let options;
322
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
323
+ callback = optionsOrCallback;
324
+ options = {};
325
+ }
326
+ else {
327
+ options = optionsOrCallback;
328
+ }
329
+ options = options || {};
330
+ options.otherArgs = options.otherArgs || {};
331
+ options.otherArgs.headers = options.otherArgs.headers || {};
332
+ options.otherArgs.headers['x-goog-request-params'] =
333
+ this._gaxModule.routingHeader.fromParams({
334
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
335
+ });
336
+ this.initialize();
337
+ return this.innerApiCalls.sheetExportAudienceList(request, options, callback);
338
+ }
314
339
  getAudienceList(request, optionsOrCallback, callback) {
315
340
  var _a;
316
341
  request = request || {};
@@ -397,15 +422,15 @@ class AlphaAnalyticsDataClient {
397
422
  * The request object that will be sent.
398
423
  * @param {string} request.parent
399
424
  * Required. All audience lists for this property will be listed in the
400
- * response. Format: `properties/{propertyId}`
401
- * @param {number} request.pageSize
402
- * The maximum number of audience lists to return. The service may return
403
- * fewer than this value. If unspecified, at most 200 audience lists will be
404
- * returned. The maximum value is 1000 (higher values will be coerced to the
405
- * maximum).
406
- * @param {string} request.pageToken
407
- * A page token, received from a previous `ListAudienceLists` call. Provide
408
- * this to retrieve the subsequent page.
425
+ * response. Format: `properties/{property}`
426
+ * @param {number} [request.pageSize]
427
+ * Optional. The maximum number of audience lists to return. The service may
428
+ * return fewer than this value. If unspecified, at most 200 audience lists
429
+ * will be returned. The maximum value is 1000 (higher values will be coerced
430
+ * to the maximum).
431
+ * @param {string} [request.pageToken]
432
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
433
+ * Provide this to retrieve the subsequent page.
409
434
  *
410
435
  * When paginating, all other parameters provided to `ListAudienceLists` must
411
436
  * match the call that provided the page token.
@@ -443,15 +468,15 @@ class AlphaAnalyticsDataClient {
443
468
  * The request object that will be sent.
444
469
  * @param {string} request.parent
445
470
  * Required. All audience lists for this property will be listed in the
446
- * response. Format: `properties/{propertyId}`
447
- * @param {number} request.pageSize
448
- * The maximum number of audience lists to return. The service may return
449
- * fewer than this value. If unspecified, at most 200 audience lists will be
450
- * returned. The maximum value is 1000 (higher values will be coerced to the
451
- * maximum).
452
- * @param {string} request.pageToken
453
- * A page token, received from a previous `ListAudienceLists` call. Provide
454
- * this to retrieve the subsequent page.
471
+ * response. Format: `properties/{property}`
472
+ * @param {number} [request.pageSize]
473
+ * Optional. The maximum number of audience lists to return. The service may
474
+ * return fewer than this value. If unspecified, at most 200 audience lists
475
+ * will be returned. The maximum value is 1000 (higher values will be coerced
476
+ * to the maximum).
477
+ * @param {string} [request.pageToken]
478
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
479
+ * Provide this to retrieve the subsequent page.
455
480
  *
456
481
  * When paginating, all other parameters provided to `ListAudienceLists` must
457
482
  * match the call that provided the page token.
@@ -488,59 +513,58 @@ class AlphaAnalyticsDataClient {
488
513
  /**
489
514
  * Return a fully-qualified audienceList resource name string.
490
515
  *
491
- * @param {string} propertyId
492
- * @param {string} audienceListId
516
+ * @param {string} property
517
+ * @param {string} audience_list
493
518
  * @returns {string} Resource name string.
494
519
  */
495
- audienceListPath(propertyId, audienceListId) {
520
+ audienceListPath(property, audienceList) {
496
521
  return this.pathTemplates.audienceListPathTemplate.render({
497
- propertyId: propertyId,
498
- audienceListId: audienceListId,
522
+ property: property,
523
+ audience_list: audienceList,
499
524
  });
500
525
  }
501
526
  /**
502
- * Parse the propertyId from AudienceList resource.
527
+ * Parse the property from AudienceList resource.
503
528
  *
504
529
  * @param {string} audienceListName
505
530
  * A fully-qualified path representing AudienceList resource.
506
- * @returns {string} A string representing the propertyId.
531
+ * @returns {string} A string representing the property.
507
532
  */
508
- matchPropertyIdFromAudienceListName(audienceListName) {
533
+ matchPropertyFromAudienceListName(audienceListName) {
509
534
  return this.pathTemplates.audienceListPathTemplate.match(audienceListName)
510
- .propertyId;
535
+ .property;
511
536
  }
512
537
  /**
513
- * Parse the audienceListId from AudienceList resource.
538
+ * Parse the audience_list from AudienceList resource.
514
539
  *
515
540
  * @param {string} audienceListName
516
541
  * A fully-qualified path representing AudienceList resource.
517
- * @returns {string} A string representing the audienceListId.
542
+ * @returns {string} A string representing the audience_list.
518
543
  */
519
- matchAudienceListIdFromAudienceListName(audienceListName) {
544
+ matchAudienceListFromAudienceListName(audienceListName) {
520
545
  return this.pathTemplates.audienceListPathTemplate.match(audienceListName)
521
- .audienceListId;
546
+ .audience_list;
522
547
  }
523
548
  /**
524
549
  * Return a fully-qualified property resource name string.
525
550
  *
526
- * @param {string} propertyId
551
+ * @param {string} property
527
552
  * @returns {string} Resource name string.
528
553
  */
529
- propertyPath(propertyId) {
554
+ propertyPath(property) {
530
555
  return this.pathTemplates.propertyPathTemplate.render({
531
- propertyId: propertyId,
556
+ property: property,
532
557
  });
533
558
  }
534
559
  /**
535
- * Parse the propertyId from Property resource.
560
+ * Parse the property from Property resource.
536
561
  *
537
562
  * @param {string} propertyName
538
563
  * A fully-qualified path representing Property resource.
539
- * @returns {string} A string representing the propertyId.
564
+ * @returns {string} A string representing the property.
540
565
  */
541
- matchPropertyIdFromPropertyName(propertyName) {
542
- return this.pathTemplates.propertyPathTemplate.match(propertyName)
543
- .propertyId;
566
+ matchPropertyFromPropertyName(propertyName) {
567
+ return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
544
568
  }
545
569
  /**
546
570
  * Terminate the gRPC channel and close the client.
@@ -47,6 +47,11 @@
47
47
  "retry_codes_name": "unknown",
48
48
  "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
49
49
  },
50
+ "SheetExportAudienceList": {
51
+ "timeout_millis": 60000,
52
+ "retry_codes_name": "unknown",
53
+ "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
54
+ },
50
55
  "GetAudienceList": {
51
56
  "timeout_millis": 60000,
52
57
  "retry_codes_name": "unknown",