@google-analytics/data 4.0.1 → 4.2.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.
@@ -279,6 +365,84 @@ export declare class AlphaAnalyticsDataClient {
279
365
  ]>;
280
366
  getAudienceList(request: protos.google.analytics.data.v1alpha.IGetAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IAudienceList, protos.google.analytics.data.v1alpha.IGetAudienceListRequest | null | undefined, {} | null | undefined>): void;
281
367
  getAudienceList(request: protos.google.analytics.data.v1alpha.IGetAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.IAudienceList, protos.google.analytics.data.v1alpha.IGetAudienceListRequest | null | undefined, {} | null | undefined>): void;
368
+ /**
369
+ * Creates a recurring audience list. Recurring audience lists produces new
370
+ * audience lists each day. Audience lists are users in an audience at the
371
+ * time of the list's creation.
372
+ *
373
+ * A recurring audience list ensures that you have audience list based on the
374
+ * most recent data available for use each day. If you manually create
375
+ * audience list, you don't know when an audience list based on an additional
376
+ * day's data is available. This recurring audience list automates the
377
+ * creation of an audience list when an additional day's data is available.
378
+ * You will consume fewer quota tokens by using recurring audience list versus
379
+ * manually creating audience list at various times of day trying to guess
380
+ * when an additional day's data is ready.
381
+ *
382
+ * This method is introduced at alpha stability with the intention of
383
+ * gathering feedback on syntax and capabilities before entering beta. To give
384
+ * your feedback on this API, complete the
385
+ * [Google Analytics Audience Export API
386
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
387
+ *
388
+ * @param {Object} request
389
+ * The request object that will be sent.
390
+ * @param {string} request.parent
391
+ * Required. The parent resource where this recurring audience list will be
392
+ * created. Format: `properties/{property}`
393
+ * @param {google.analytics.data.v1alpha.RecurringAudienceList} request.recurringAudienceList
394
+ * Required. The recurring audience list to create.
395
+ * @param {object} [options]
396
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
397
+ * @returns {Promise} - The promise which resolves to an array.
398
+ * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}.
399
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
400
+ * for more details and examples.
401
+ * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.create_recurring_audience_list.js</caption>
402
+ * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateRecurringAudienceList_async
403
+ */
404
+ createRecurringAudienceList(request?: protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest, options?: CallOptions): Promise<[
405
+ protos.google.analytics.data.v1alpha.IRecurringAudienceList,
406
+ (protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest | undefined),
407
+ {} | undefined
408
+ ]>;
409
+ createRecurringAudienceList(request: protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
410
+ createRecurringAudienceList(request: protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
411
+ /**
412
+ * Gets configuration metadata about a specific recurring audience list. This
413
+ * method can be used to understand a recurring audience list's state after it
414
+ * has been created. For example, a recurring audience list resource will
415
+ * generate audience list instances for each day, and this method can be used
416
+ * to get the resource name of the most recent audience list instance.
417
+ *
418
+ * This method is introduced at alpha stability with the intention of
419
+ * gathering feedback on syntax and capabilities before entering beta. To give
420
+ * your feedback on this API, complete the
421
+ * [Google Analytics Audience Export API
422
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
423
+ *
424
+ * @param {Object} request
425
+ * The request object that will be sent.
426
+ * @param {string} request.name
427
+ * Required. The recurring audience list resource name.
428
+ * Format:
429
+ * `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
430
+ * @param {object} [options]
431
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
432
+ * @returns {Promise} - The promise which resolves to an array.
433
+ * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}.
434
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
435
+ * for more details and examples.
436
+ * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.get_recurring_audience_list.js</caption>
437
+ * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_GetRecurringAudienceList_async
438
+ */
439
+ getRecurringAudienceList(request?: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, options?: CallOptions): Promise<[
440
+ protos.google.analytics.data.v1alpha.IRecurringAudienceList,
441
+ (protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | undefined),
442
+ {} | undefined
443
+ ]>;
444
+ getRecurringAudienceList(request: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
445
+ getRecurringAudienceList(request: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
282
446
  /**
283
447
  * Creates an audience list for later retrieval. This method quickly returns
284
448
  * the audience list's resource name and initiates a long running asynchronous
@@ -286,6 +450,10 @@ export declare class AlphaAnalyticsDataClient {
286
450
  * first create the audience list through this method and then send the
287
451
  * audience resource name to the `QueryAudienceList` method.
288
452
  *
453
+ * See [Creating an Audience
454
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
455
+ * for an introduction to Audience Lists with examples.
456
+ *
289
457
  * An audience list is a snapshot of the users currently in the audience at
290
458
  * the time of audience list creation. Creating audience lists for one
291
459
  * audience on different days will return different results as users enter and
@@ -296,11 +464,17 @@ export declare class AlphaAnalyticsDataClient {
296
464
  * https://support.google.com/analytics/answer/9267572. Audience lists contain
297
465
  * the users in each audience.
298
466
  *
467
+ * This method is introduced at alpha stability with the intention of
468
+ * gathering feedback on syntax and capabilities before entering beta. To give
469
+ * your feedback on this API, complete the
470
+ * [Google Analytics Audience Export API
471
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
472
+ *
299
473
  * @param {Object} request
300
474
  * The request object that will be sent.
301
475
  * @param {string} request.parent
302
476
  * Required. The parent resource where this audience list will be created.
303
- * Format: `properties/{propertyId}`
477
+ * Format: `properties/{property}`
304
478
  * @param {google.analytics.data.v1alpha.AudienceList} request.audienceList
305
479
  * Required. The audience list to create.
306
480
  * @param {object} [options]
@@ -339,19 +513,29 @@ export declare class AlphaAnalyticsDataClient {
339
513
  * audience lists. The same audience can have multiple audience lists that
340
514
  * represent the list of users that were in an audience on different days.
341
515
  *
516
+ * See [Creating an Audience
517
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
518
+ * for an introduction to Audience Lists with examples.
519
+ *
520
+ * This method is introduced at alpha stability with the intention of
521
+ * gathering feedback on syntax and capabilities before entering beta. To give
522
+ * your feedback on this API, complete the
523
+ * [Google Analytics Audience Export API
524
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
525
+ *
342
526
  * @param {Object} request
343
527
  * The request object that will be sent.
344
528
  * @param {string} request.parent
345
529
  * 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.
530
+ * response. Format: `properties/{property}`
531
+ * @param {number} [request.pageSize]
532
+ * Optional. The maximum number of audience lists to return. The service may
533
+ * return fewer than this value. If unspecified, at most 200 audience lists
534
+ * will be returned. The maximum value is 1000 (higher values will be coerced
535
+ * to the maximum).
536
+ * @param {string} [request.pageToken]
537
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
538
+ * Provide this to retrieve the subsequent page.
355
539
  *
356
540
  * When paginating, all other parameters provided to `ListAudienceLists` must
357
541
  * match the call that provided the page token.
@@ -380,15 +564,15 @@ export declare class AlphaAnalyticsDataClient {
380
564
  * The request object that will be sent.
381
565
  * @param {string} request.parent
382
566
  * 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.
567
+ * response. Format: `properties/{property}`
568
+ * @param {number} [request.pageSize]
569
+ * Optional. The maximum number of audience lists to return. The service may
570
+ * return fewer than this value. If unspecified, at most 200 audience lists
571
+ * will be returned. The maximum value is 1000 (higher values will be coerced
572
+ * to the maximum).
573
+ * @param {string} [request.pageToken]
574
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
575
+ * Provide this to retrieve the subsequent page.
392
576
  *
393
577
  * When paginating, all other parameters provided to `ListAudienceLists` must
394
578
  * match the call that provided the page token.
@@ -412,15 +596,15 @@ export declare class AlphaAnalyticsDataClient {
412
596
  * The request object that will be sent.
413
597
  * @param {string} request.parent
414
598
  * 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.
599
+ * response. Format: `properties/{property}`
600
+ * @param {number} [request.pageSize]
601
+ * Optional. The maximum number of audience lists to return. The service may
602
+ * return fewer than this value. If unspecified, at most 200 audience lists
603
+ * will be returned. The maximum value is 1000 (higher values will be coerced
604
+ * to the maximum).
605
+ * @param {string} [request.pageToken]
606
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
607
+ * Provide this to retrieve the subsequent page.
424
608
  *
425
609
  * When paginating, all other parameters provided to `ListAudienceLists` must
426
610
  * match the call that provided the page token.
@@ -437,45 +621,187 @@ export declare class AlphaAnalyticsDataClient {
437
621
  * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListAudienceLists_async
438
622
  */
439
623
  listAudienceListsAsync(request?: protos.google.analytics.data.v1alpha.IListAudienceListsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1alpha.IAudienceList>;
624
+ /**
625
+ * Lists all recurring audience lists for a property. This method can be used
626
+ * for you to find and reuse existing recurring audience lists rather than
627
+ * creating unnecessary new recurring audience lists. The same audience can
628
+ * have multiple recurring audience lists that represent different dimension
629
+ * combinations; for example, just the dimension `deviceId` or both the
630
+ * dimensions `deviceId` and `userId`.
631
+ *
632
+ * This method is introduced at alpha stability with the intention of
633
+ * gathering feedback on syntax and capabilities before entering beta. To give
634
+ * your feedback on this API, complete the
635
+ * [Google Analytics Audience Export API
636
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
637
+ *
638
+ * @param {Object} request
639
+ * The request object that will be sent.
640
+ * @param {string} request.parent
641
+ * Required. All recurring audience lists for this property will be listed in
642
+ * the response. Format: `properties/{property}`
643
+ * @param {number} [request.pageSize]
644
+ * Optional. The maximum number of recurring audience lists to return. The
645
+ * service may return fewer than this value. If unspecified, at most 200
646
+ * recurring audience lists will be returned. The maximum value is 1000
647
+ * (higher values will be coerced to the maximum).
648
+ * @param {string} [request.pageToken]
649
+ * Optional. A page token, received from a previous
650
+ * `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
651
+ * page.
652
+ *
653
+ * When paginating, all other parameters provided to
654
+ * `ListRecurringAudienceLists` must match the call that provided the page
655
+ * token.
656
+ * @param {object} [options]
657
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
658
+ * @returns {Promise} - The promise which resolves to an array.
659
+ * The first element of the array is Array of {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}.
660
+ * The client library will perform auto-pagination by default: it will call the API as many
661
+ * times as needed and will merge results from all the pages into this array.
662
+ * Note that it can affect your quota.
663
+ * We recommend using `listRecurringAudienceListsAsync()`
664
+ * method described below for async iteration which you can stop as needed.
665
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
666
+ * for more details and examples.
667
+ */
668
+ listRecurringAudienceLists(request?: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, options?: CallOptions): Promise<[
669
+ protos.google.analytics.data.v1alpha.IRecurringAudienceList[],
670
+ protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest | null,
671
+ protos.google.analytics.data.v1alpha.IListRecurringAudienceListsResponse
672
+ ]>;
673
+ listRecurringAudienceLists(request: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, protos.google.analytics.data.v1alpha.IListRecurringAudienceListsResponse | null | undefined, protos.google.analytics.data.v1alpha.IRecurringAudienceList>): void;
674
+ listRecurringAudienceLists(request: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, callback: PaginationCallback<protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, protos.google.analytics.data.v1alpha.IListRecurringAudienceListsResponse | null | undefined, protos.google.analytics.data.v1alpha.IRecurringAudienceList>): void;
675
+ /**
676
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
677
+ * @param {Object} request
678
+ * The request object that will be sent.
679
+ * @param {string} request.parent
680
+ * Required. All recurring audience lists for this property will be listed in
681
+ * the response. Format: `properties/{property}`
682
+ * @param {number} [request.pageSize]
683
+ * Optional. The maximum number of recurring audience lists to return. The
684
+ * service may return fewer than this value. If unspecified, at most 200
685
+ * recurring audience lists will be returned. The maximum value is 1000
686
+ * (higher values will be coerced to the maximum).
687
+ * @param {string} [request.pageToken]
688
+ * Optional. A page token, received from a previous
689
+ * `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
690
+ * page.
691
+ *
692
+ * When paginating, all other parameters provided to
693
+ * `ListRecurringAudienceLists` must match the call that provided the page
694
+ * token.
695
+ * @param {object} [options]
696
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
697
+ * @returns {Stream}
698
+ * An object stream which emits an object representing {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList} on 'data' event.
699
+ * The client library will perform auto-pagination by default: it will call the API as many
700
+ * times as needed. Note that it can affect your quota.
701
+ * We recommend using `listRecurringAudienceListsAsync()`
702
+ * method described below for async iteration which you can stop as needed.
703
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
704
+ * for more details and examples.
705
+ */
706
+ listRecurringAudienceListsStream(request?: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, options?: CallOptions): Transform;
707
+ /**
708
+ * Equivalent to `listRecurringAudienceLists`, but returns an iterable object.
709
+ *
710
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
711
+ * @param {Object} request
712
+ * The request object that will be sent.
713
+ * @param {string} request.parent
714
+ * Required. All recurring audience lists for this property will be listed in
715
+ * the response. Format: `properties/{property}`
716
+ * @param {number} [request.pageSize]
717
+ * Optional. The maximum number of recurring audience lists to return. The
718
+ * service may return fewer than this value. If unspecified, at most 200
719
+ * recurring audience lists will be returned. The maximum value is 1000
720
+ * (higher values will be coerced to the maximum).
721
+ * @param {string} [request.pageToken]
722
+ * Optional. A page token, received from a previous
723
+ * `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
724
+ * page.
725
+ *
726
+ * When paginating, all other parameters provided to
727
+ * `ListRecurringAudienceLists` must match the call that provided the page
728
+ * token.
729
+ * @param {object} [options]
730
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
731
+ * @returns {Object}
732
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
733
+ * When you iterate the returned iterable, each element will be an object representing
734
+ * {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}. The API will be called under the hood as needed, once per the page,
735
+ * so you can stop the iteration when you don't need more results.
736
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
737
+ * for more details and examples.
738
+ * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.list_recurring_audience_lists.js</caption>
739
+ * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListRecurringAudienceLists_async
740
+ */
741
+ listRecurringAudienceListsAsync(request?: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1alpha.IRecurringAudienceList>;
440
742
  /**
441
743
  * Return a fully-qualified audienceList resource name string.
442
744
  *
443
- * @param {string} propertyId
444
- * @param {string} audienceListId
745
+ * @param {string} property
746
+ * @param {string} audience_list
445
747
  * @returns {string} Resource name string.
446
748
  */
447
- audienceListPath(propertyId: string, audienceListId: string): string;
749
+ audienceListPath(property: string, audienceList: string): string;
448
750
  /**
449
- * Parse the propertyId from AudienceList resource.
751
+ * Parse the property from AudienceList resource.
450
752
  *
451
753
  * @param {string} audienceListName
452
754
  * A fully-qualified path representing AudienceList resource.
453
- * @returns {string} A string representing the propertyId.
755
+ * @returns {string} A string representing the property.
454
756
  */
455
- matchPropertyIdFromAudienceListName(audienceListName: string): string | number;
757
+ matchPropertyFromAudienceListName(audienceListName: string): string | number;
456
758
  /**
457
- * Parse the audienceListId from AudienceList resource.
759
+ * Parse the audience_list from AudienceList resource.
458
760
  *
459
761
  * @param {string} audienceListName
460
762
  * A fully-qualified path representing AudienceList resource.
461
- * @returns {string} A string representing the audienceListId.
763
+ * @returns {string} A string representing the audience_list.
462
764
  */
463
- matchAudienceListIdFromAudienceListName(audienceListName: string): string | number;
765
+ matchAudienceListFromAudienceListName(audienceListName: string): string | number;
464
766
  /**
465
767
  * Return a fully-qualified property resource name string.
466
768
  *
467
- * @param {string} propertyId
769
+ * @param {string} property
468
770
  * @returns {string} Resource name string.
469
771
  */
470
- propertyPath(propertyId: string): string;
772
+ propertyPath(property: string): string;
471
773
  /**
472
- * Parse the propertyId from Property resource.
774
+ * Parse the property from Property resource.
473
775
  *
474
776
  * @param {string} propertyName
475
777
  * A fully-qualified path representing Property resource.
476
- * @returns {string} A string representing the propertyId.
778
+ * @returns {string} A string representing the property.
779
+ */
780
+ matchPropertyFromPropertyName(propertyName: string): string | number;
781
+ /**
782
+ * Return a fully-qualified recurringAudienceList resource name string.
783
+ *
784
+ * @param {string} property
785
+ * @param {string} recurring_audience_list
786
+ * @returns {string} Resource name string.
787
+ */
788
+ recurringAudienceListPath(property: string, recurringAudienceList: string): string;
789
+ /**
790
+ * Parse the property from RecurringAudienceList resource.
791
+ *
792
+ * @param {string} recurringAudienceListName
793
+ * A fully-qualified path representing RecurringAudienceList resource.
794
+ * @returns {string} A string representing the property.
795
+ */
796
+ matchPropertyFromRecurringAudienceListName(recurringAudienceListName: string): string | number;
797
+ /**
798
+ * Parse the recurring_audience_list from RecurringAudienceList resource.
799
+ *
800
+ * @param {string} recurringAudienceListName
801
+ * A fully-qualified path representing RecurringAudienceList resource.
802
+ * @returns {string} A string representing the recurring_audience_list.
477
803
  */
478
- matchPropertyIdFromPropertyName(propertyName: string): string | number;
804
+ matchRecurringAudienceListFromRecurringAudienceListName(recurringAudienceListName: string): string | number;
479
805
  /**
480
806
  * Terminate the gRPC channel and close the client.
481
807
  *