@google-analytics/data 4.1.0 → 4.3.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.
@@ -365,6 +365,84 @@ export declare class AlphaAnalyticsDataClient {
365
365
  ]>;
366
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;
367
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;
368
446
  /**
369
447
  * Creates an audience list for later retrieval. This method quickly returns
370
448
  * the audience list's resource name and initiates a long running asynchronous
@@ -543,6 +621,124 @@ export declare class AlphaAnalyticsDataClient {
543
621
  * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListAudienceLists_async
544
622
  */
545
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>;
546
742
  /**
547
743
  * Return a fully-qualified audienceList resource name string.
548
744
  *
@@ -582,6 +778,30 @@ export declare class AlphaAnalyticsDataClient {
582
778
  * @returns {string} A string representing the property.
583
779
  */
584
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.
803
+ */
804
+ matchRecurringAudienceListFromRecurringAudienceListName(recurringAudienceListName: string): string | number;
585
805
  /**
586
806
  * Terminate the gRPC channel and close the client.
587
807
  *
@@ -139,12 +139,14 @@ class AlphaAnalyticsDataClient {
139
139
  this.pathTemplates = {
140
140
  audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/audienceLists/{audience_list}'),
141
141
  propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{property}'),
142
+ recurringAudienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/recurringAudienceLists/{recurring_audience_list}'),
142
143
  };
143
144
  // Some of the methods on this service return "paged" results,
144
145
  // (e.g. 50 results at a time, with tokens to get subsequent
145
146
  // pages). Denote the keys used for pagination and results.
146
147
  this.descriptors.page = {
147
148
  listAudienceLists: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'audienceLists'),
149
+ listRecurringAudienceLists: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'recurringAudienceLists'),
148
150
  };
149
151
  const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
150
152
  // This API contains "long-running operations", which return a
@@ -207,6 +209,9 @@ class AlphaAnalyticsDataClient {
207
209
  'sheetExportAudienceList',
208
210
  'getAudienceList',
209
211
  'listAudienceLists',
212
+ 'createRecurringAudienceList',
213
+ 'getRecurringAudienceList',
214
+ 'listRecurringAudienceLists',
210
215
  ];
211
216
  for (const methodName of alphaAnalyticsDataStubMethods) {
212
217
  const callPromise = this.alphaAnalyticsDataStub.then(stub => (...args) => {
@@ -357,6 +362,48 @@ class AlphaAnalyticsDataClient {
357
362
  this.initialize();
358
363
  return this.innerApiCalls.getAudienceList(request, options, callback);
359
364
  }
365
+ createRecurringAudienceList(request, optionsOrCallback, callback) {
366
+ var _a;
367
+ request = request || {};
368
+ let options;
369
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
370
+ callback = optionsOrCallback;
371
+ options = {};
372
+ }
373
+ else {
374
+ options = optionsOrCallback;
375
+ }
376
+ options = options || {};
377
+ options.otherArgs = options.otherArgs || {};
378
+ options.otherArgs.headers = options.otherArgs.headers || {};
379
+ options.otherArgs.headers['x-goog-request-params'] =
380
+ this._gaxModule.routingHeader.fromParams({
381
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
382
+ });
383
+ this.initialize();
384
+ return this.innerApiCalls.createRecurringAudienceList(request, options, callback);
385
+ }
386
+ getRecurringAudienceList(request, optionsOrCallback, callback) {
387
+ var _a;
388
+ request = request || {};
389
+ let options;
390
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
391
+ callback = optionsOrCallback;
392
+ options = {};
393
+ }
394
+ else {
395
+ options = optionsOrCallback;
396
+ }
397
+ options = options || {};
398
+ options.otherArgs = options.otherArgs || {};
399
+ options.otherArgs.headers = options.otherArgs.headers || {};
400
+ options.otherArgs.headers['x-goog-request-params'] =
401
+ this._gaxModule.routingHeader.fromParams({
402
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
403
+ });
404
+ this.initialize();
405
+ return this.innerApiCalls.getRecurringAudienceList(request, options, callback);
406
+ }
360
407
  createAudienceList(request, optionsOrCallback, callback) {
361
408
  var _a;
362
409
  request = request || {};
@@ -507,6 +554,122 @@ class AlphaAnalyticsDataClient {
507
554
  this.initialize();
508
555
  return this.descriptors.page.listAudienceLists.asyncIterate(this.innerApiCalls['listAudienceLists'], request, callSettings);
509
556
  }
557
+ listRecurringAudienceLists(request, optionsOrCallback, callback) {
558
+ var _a;
559
+ request = request || {};
560
+ let options;
561
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
562
+ callback = optionsOrCallback;
563
+ options = {};
564
+ }
565
+ else {
566
+ options = optionsOrCallback;
567
+ }
568
+ options = options || {};
569
+ options.otherArgs = options.otherArgs || {};
570
+ options.otherArgs.headers = options.otherArgs.headers || {};
571
+ options.otherArgs.headers['x-goog-request-params'] =
572
+ this._gaxModule.routingHeader.fromParams({
573
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
574
+ });
575
+ this.initialize();
576
+ return this.innerApiCalls.listRecurringAudienceLists(request, options, callback);
577
+ }
578
+ /**
579
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
580
+ * @param {Object} request
581
+ * The request object that will be sent.
582
+ * @param {string} request.parent
583
+ * Required. All recurring audience lists for this property will be listed in
584
+ * the response. Format: `properties/{property}`
585
+ * @param {number} [request.pageSize]
586
+ * Optional. The maximum number of recurring audience lists to return. The
587
+ * service may return fewer than this value. If unspecified, at most 200
588
+ * recurring audience lists will be returned. The maximum value is 1000
589
+ * (higher values will be coerced to the maximum).
590
+ * @param {string} [request.pageToken]
591
+ * Optional. A page token, received from a previous
592
+ * `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
593
+ * page.
594
+ *
595
+ * When paginating, all other parameters provided to
596
+ * `ListRecurringAudienceLists` must match the call that provided the page
597
+ * token.
598
+ * @param {object} [options]
599
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
600
+ * @returns {Stream}
601
+ * An object stream which emits an object representing {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList} on 'data' event.
602
+ * The client library will perform auto-pagination by default: it will call the API as many
603
+ * times as needed. Note that it can affect your quota.
604
+ * We recommend using `listRecurringAudienceListsAsync()`
605
+ * method described below for async iteration which you can stop as needed.
606
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
607
+ * for more details and examples.
608
+ */
609
+ listRecurringAudienceListsStream(request, options) {
610
+ var _a;
611
+ request = request || {};
612
+ options = options || {};
613
+ options.otherArgs = options.otherArgs || {};
614
+ options.otherArgs.headers = options.otherArgs.headers || {};
615
+ options.otherArgs.headers['x-goog-request-params'] =
616
+ this._gaxModule.routingHeader.fromParams({
617
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
618
+ });
619
+ const defaultCallSettings = this._defaults['listRecurringAudienceLists'];
620
+ const callSettings = defaultCallSettings.merge(options);
621
+ this.initialize();
622
+ return this.descriptors.page.listRecurringAudienceLists.createStream(this.innerApiCalls.listRecurringAudienceLists, request, callSettings);
623
+ }
624
+ /**
625
+ * Equivalent to `listRecurringAudienceLists`, but returns an iterable object.
626
+ *
627
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
628
+ * @param {Object} request
629
+ * The request object that will be sent.
630
+ * @param {string} request.parent
631
+ * Required. All recurring audience lists for this property will be listed in
632
+ * the response. Format: `properties/{property}`
633
+ * @param {number} [request.pageSize]
634
+ * Optional. The maximum number of recurring audience lists to return. The
635
+ * service may return fewer than this value. If unspecified, at most 200
636
+ * recurring audience lists will be returned. The maximum value is 1000
637
+ * (higher values will be coerced to the maximum).
638
+ * @param {string} [request.pageToken]
639
+ * Optional. A page token, received from a previous
640
+ * `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
641
+ * page.
642
+ *
643
+ * When paginating, all other parameters provided to
644
+ * `ListRecurringAudienceLists` must match the call that provided the page
645
+ * token.
646
+ * @param {object} [options]
647
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
648
+ * @returns {Object}
649
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
650
+ * When you iterate the returned iterable, each element will be an object representing
651
+ * {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}. The API will be called under the hood as needed, once per the page,
652
+ * so you can stop the iteration when you don't need more results.
653
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
654
+ * for more details and examples.
655
+ * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.list_recurring_audience_lists.js</caption>
656
+ * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListRecurringAudienceLists_async
657
+ */
658
+ listRecurringAudienceListsAsync(request, options) {
659
+ var _a;
660
+ request = request || {};
661
+ options = options || {};
662
+ options.otherArgs = options.otherArgs || {};
663
+ options.otherArgs.headers = options.otherArgs.headers || {};
664
+ options.otherArgs.headers['x-goog-request-params'] =
665
+ this._gaxModule.routingHeader.fromParams({
666
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
667
+ });
668
+ const defaultCallSettings = this._defaults['listRecurringAudienceLists'];
669
+ const callSettings = defaultCallSettings.merge(options);
670
+ this.initialize();
671
+ return this.descriptors.page.listRecurringAudienceLists.asyncIterate(this.innerApiCalls['listRecurringAudienceLists'], request, callSettings);
672
+ }
510
673
  // --------------------
511
674
  // -- Path templates --
512
675
  // --------------------
@@ -566,6 +729,39 @@ class AlphaAnalyticsDataClient {
566
729
  matchPropertyFromPropertyName(propertyName) {
567
730
  return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
568
731
  }
732
+ /**
733
+ * Return a fully-qualified recurringAudienceList resource name string.
734
+ *
735
+ * @param {string} property
736
+ * @param {string} recurring_audience_list
737
+ * @returns {string} Resource name string.
738
+ */
739
+ recurringAudienceListPath(property, recurringAudienceList) {
740
+ return this.pathTemplates.recurringAudienceListPathTemplate.render({
741
+ property: property,
742
+ recurring_audience_list: recurringAudienceList,
743
+ });
744
+ }
745
+ /**
746
+ * Parse the property from RecurringAudienceList resource.
747
+ *
748
+ * @param {string} recurringAudienceListName
749
+ * A fully-qualified path representing RecurringAudienceList resource.
750
+ * @returns {string} A string representing the property.
751
+ */
752
+ matchPropertyFromRecurringAudienceListName(recurringAudienceListName) {
753
+ return this.pathTemplates.recurringAudienceListPathTemplate.match(recurringAudienceListName).property;
754
+ }
755
+ /**
756
+ * Parse the recurring_audience_list from RecurringAudienceList resource.
757
+ *
758
+ * @param {string} recurringAudienceListName
759
+ * A fully-qualified path representing RecurringAudienceList resource.
760
+ * @returns {string} A string representing the recurring_audience_list.
761
+ */
762
+ matchRecurringAudienceListFromRecurringAudienceListName(recurringAudienceListName) {
763
+ return this.pathTemplates.recurringAudienceListPathTemplate.match(recurringAudienceListName).recurring_audience_list;
764
+ }
569
765
  /**
570
766
  * Terminate the gRPC channel and close the client.
571
767
  *
@@ -61,6 +61,21 @@
61
61
  "timeout_millis": 60000,
62
62
  "retry_codes_name": "unknown",
63
63
  "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
64
+ },
65
+ "CreateRecurringAudienceList": {
66
+ "timeout_millis": 60000,
67
+ "retry_codes_name": "unknown",
68
+ "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
69
+ },
70
+ "GetRecurringAudienceList": {
71
+ "timeout_millis": 60000,
72
+ "retry_codes_name": "unknown",
73
+ "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
74
+ },
75
+ "ListRecurringAudienceLists": {
76
+ "timeout_millis": 60000,
77
+ "retry_codes_name": "unknown",
78
+ "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
64
79
  }
65
80
  }
66
81
  }