@google-analytics/data 4.8.0 → 4.9.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.9.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.8.0...data-v4.9.0) (2024-09-24)
4
+
5
+
6
+ ### Features
7
+
8
+ * [analytics-data] add `GetPropertyQuotasSnapshot` method to the Data API v1alpha ([#5692](https://github.com/googleapis/google-cloud-node/issues/5692)) ([a143a79](https://github.com/googleapis/google-cloud-node/commit/a143a7926ab91dce75a2db2d831d498d3f3524d8))
9
+
3
10
  ## [4.8.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.7.0...data-v4.8.0) (2024-08-09)
4
11
 
5
12
 
package/README.md CHANGED
@@ -43,7 +43,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
43
43
 
44
44
  1. [Select or create a Cloud Platform project][projects].
45
45
  1. [Enable the Google Analytics Data API][enable_api].
46
- 1. [Set up authentication with a service account][auth] so you can access the
46
+ 1. [Set up authentication][auth] so you can access the
47
47
  API from your local workstation.
48
48
 
49
49
  ### Installing the client library
@@ -113,6 +113,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
113
113
  | Alpha_analytics_data.create_recurring_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_recurring_audience_list.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_recurring_audience_list.js,packages/google-analytics-data/samples/README.md) |
114
114
  | Alpha_analytics_data.create_report_task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_report_task.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_report_task.js,packages/google-analytics-data/samples/README.md) |
115
115
  | Alpha_analytics_data.get_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_audience_list.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_audience_list.js,packages/google-analytics-data/samples/README.md) |
116
+ | Alpha_analytics_data.get_property_quotas_snapshot | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_property_quotas_snapshot.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_property_quotas_snapshot.js,packages/google-analytics-data/samples/README.md) |
116
117
  | Alpha_analytics_data.get_recurring_audience_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_recurring_audience_list.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_recurring_audience_list.js,packages/google-analytics-data/samples/README.md) |
117
118
  | Alpha_analytics_data.get_report_task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_report_task.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_report_task.js,packages/google-analytics-data/samples/README.md) |
118
119
  | Alpha_analytics_data.list_audience_lists | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.list_audience_lists.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.list_audience_lists.js,packages/google-analytics-data/samples/README.md) |
@@ -202,4 +203,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
202
203
  [projects]: https://console.cloud.google.com/project
203
204
  [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
204
205
  [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=analyticsdata.googleapis.com
205
- [auth]: https://cloud.google.com/docs/authentication/getting-started
206
+ [auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
@@ -266,10 +266,26 @@ service AlphaAnalyticsData {
266
266
  option (google.api.method_signature) = "parent";
267
267
  }
268
268
 
269
+ // Get all property quotas organized by quota category for a given property.
270
+ // This will charge 1 property quota from the category with the most quota.
271
+ rpc GetPropertyQuotasSnapshot(GetPropertyQuotasSnapshotRequest)
272
+ returns (PropertyQuotasSnapshot) {
273
+ option (google.api.http) = {
274
+ get: "/v1alpha/{name=properties/*/propertyQuotasSnapshot}"
275
+ };
276
+ option (google.api.method_signature) = "name";
277
+ }
278
+
269
279
  // Initiates the creation of a report task. This method quickly
270
280
  // returns a report task and initiates a long running
271
281
  // asynchronous request to form a customized report of your Google Analytics
272
282
  // event data.
283
+ //
284
+ // A report task will be retained and available for querying for 72 hours
285
+ // after it has been created.
286
+ //
287
+ // A report task created by one user can be listed and queried by all users
288
+ // who have access to the property.
273
289
  rpc CreateReportTask(CreateReportTaskRequest)
274
290
  returns (google.longrunning.Operation) {
275
291
  option (google.api.http) = {
@@ -514,6 +530,40 @@ message ListRecurringAudienceListsResponse {
514
530
  optional string next_page_token = 2;
515
531
  }
516
532
 
533
+ // A request to return the PropertyQuotasSnapshot for a given category.
534
+ message GetPropertyQuotasSnapshotRequest {
535
+ // Required. Quotas from this property will be listed in the response.
536
+ // Format: `properties/{property}/propertyQuotasSnapshot`
537
+ string name = 1 [
538
+ (google.api.field_behavior) = REQUIRED,
539
+ (google.api.resource_reference) = {
540
+ type: "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
541
+ }
542
+ ];
543
+ }
544
+
545
+ // Current state of all Property Quotas organized by quota category.
546
+ message PropertyQuotasSnapshot {
547
+ option (google.api.resource) = {
548
+ type: "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
549
+ pattern: "properties/{property}/propertyQuotasSnapshot"
550
+ plural: "propertyQuotasSnapshots"
551
+ singular: "propertyQuotasSnapshot"
552
+ };
553
+
554
+ // Identifier. The property quota snapshot resource name.
555
+ string name = 4 [(google.api.field_behavior) = IDENTIFIER];
556
+
557
+ // Property Quota for core property tokens
558
+ PropertyQuota core_property_quota = 1;
559
+
560
+ // Property Quota for realtime property tokens
561
+ PropertyQuota realtime_property_quota = 2;
562
+
563
+ // Property Quota for funnel property tokens
564
+ PropertyQuota funnel_property_quota = 3;
565
+ }
566
+
517
567
  // A request to retrieve configuration metadata about a specific audience list.
518
568
  message GetAudienceListRequest {
519
569
  // Required. The audience list resource name.
@@ -844,9 +894,9 @@ message RunFunnelReportRequest {
844
894
  TRENDED_FUNNEL = 2;
845
895
  }
846
896
 
847
- // Optional. A Google Analytics GA4 property identifier whose events are
848
- // tracked. Specified in the URL path and not the body. To learn more, see
849
- // [where to find your Property
897
+ // Optional. A Google Analytics property identifier whose events are tracked.
898
+ // Specified in the URL path and not the body. To learn more, see [where to
899
+ // find your Property
850
900
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
851
901
  // Within a batch request, this property should either be unspecified or
852
902
  // consistent with the batch-level property.
@@ -1030,7 +1080,7 @@ message ReportTask {
1030
1080
  // not separately removed by a filter.
1031
1081
  //
1032
1082
  // Regardless of this `keep_empty_rows` setting, only data recorded by the
1033
- // Google Analytics (GA4) property can be displayed in a report.
1083
+ // Google Analytics property can be displayed in a report.
1034
1084
  //
1035
1085
  // For example if a property never logs a `purchase` event, then a query for
1036
1086
  // the `eventName` dimension and `eventCount` metric will not have a row
@@ -1104,7 +1154,7 @@ message ReportTask {
1104
1154
  }
1105
1155
 
1106
1156
  // Output only. Identifier. The report task resource name assigned during
1107
- // creation. Format: `properties/{property}/reportTasks/{report_task}`
1157
+ // creation. Format: "properties/{property}/reportTasks/{report_task}"
1108
1158
  string name = 1 [
1109
1159
  (google.api.field_behavior) = IDENTIFIER,
1110
1160
  (google.api.field_behavior) = OUTPUT_ONLY
@@ -1107,7 +1107,7 @@ enum EventExclusionDuration {
1107
1107
  // Another segment might be users who purchase a particular line of products or
1108
1108
  // who visit a specific part of your site or trigger certain events in your app.
1109
1109
  //
1110
- // To learn more, see [GA4 Segment
1110
+ // To learn more, see [Segment
1111
1111
  // Builder](https://support.google.com/analytics/answer/9304353).
1112
1112
  message Segment {
1113
1113
  // The name for this segment. If unspecified, segments are named "Segment".
@@ -1561,8 +1561,8 @@ enum MetricType {
1561
1561
  TYPE_KILOMETERS = 13;
1562
1562
  }
1563
1563
 
1564
- // Categories of data that you may be restricted from viewing on certain GA4
1565
- // properties.
1564
+ // Categories of data that you may be restricted from viewing on certain
1565
+ // Google Analytics properties.
1566
1566
  enum RestrictedMetricType {
1567
1567
  // Unspecified type.
1568
1568
  RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0;
@@ -4681,6 +4681,20 @@ export namespace google {
4681
4681
  */
4682
4682
  public listRecurringAudienceLists(request: google.analytics.data.v1alpha.IListRecurringAudienceListsRequest): Promise<google.analytics.data.v1alpha.ListRecurringAudienceListsResponse>;
4683
4683
 
4684
+ /**
4685
+ * Calls GetPropertyQuotasSnapshot.
4686
+ * @param request GetPropertyQuotasSnapshotRequest message or plain object
4687
+ * @param callback Node-style callback called with the error, if any, and PropertyQuotasSnapshot
4688
+ */
4689
+ public getPropertyQuotasSnapshot(request: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.GetPropertyQuotasSnapshotCallback): void;
4690
+
4691
+ /**
4692
+ * Calls GetPropertyQuotasSnapshot.
4693
+ * @param request GetPropertyQuotasSnapshotRequest message or plain object
4694
+ * @returns Promise
4695
+ */
4696
+ public getPropertyQuotasSnapshot(request: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest): Promise<google.analytics.data.v1alpha.PropertyQuotasSnapshot>;
4697
+
4684
4698
  /**
4685
4699
  * Calls CreateReportTask.
4686
4700
  * @param request CreateReportTaskRequest message or plain object
@@ -4803,6 +4817,13 @@ export namespace google {
4803
4817
  */
4804
4818
  type ListRecurringAudienceListsCallback = (error: (Error|null), response?: google.analytics.data.v1alpha.ListRecurringAudienceListsResponse) => void;
4805
4819
 
4820
+ /**
4821
+ * Callback as used by {@link google.analytics.data.v1alpha.AlphaAnalyticsData|getPropertyQuotasSnapshot}.
4822
+ * @param error Error, if any
4823
+ * @param [response] PropertyQuotasSnapshot
4824
+ */
4825
+ type GetPropertyQuotasSnapshotCallback = (error: (Error|null), response?: google.analytics.data.v1alpha.PropertyQuotasSnapshot) => void;
4826
+
4806
4827
  /**
4807
4828
  * Callback as used by {@link google.analytics.data.v1alpha.AlphaAnalyticsData|createReportTask}.
4808
4829
  * @param error Error, if any
@@ -5495,6 +5516,218 @@ export namespace google {
5495
5516
  public static getTypeUrl(typeUrlPrefix?: string): string;
5496
5517
  }
5497
5518
 
5519
+ /** Properties of a GetPropertyQuotasSnapshotRequest. */
5520
+ interface IGetPropertyQuotasSnapshotRequest {
5521
+
5522
+ /** GetPropertyQuotasSnapshotRequest name */
5523
+ name?: (string|null);
5524
+ }
5525
+
5526
+ /** Represents a GetPropertyQuotasSnapshotRequest. */
5527
+ class GetPropertyQuotasSnapshotRequest implements IGetPropertyQuotasSnapshotRequest {
5528
+
5529
+ /**
5530
+ * Constructs a new GetPropertyQuotasSnapshotRequest.
5531
+ * @param [properties] Properties to set
5532
+ */
5533
+ constructor(properties?: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest);
5534
+
5535
+ /** GetPropertyQuotasSnapshotRequest name. */
5536
+ public name: string;
5537
+
5538
+ /**
5539
+ * Creates a new GetPropertyQuotasSnapshotRequest instance using the specified properties.
5540
+ * @param [properties] Properties to set
5541
+ * @returns GetPropertyQuotasSnapshotRequest instance
5542
+ */
5543
+ public static create(properties?: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest): google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest;
5544
+
5545
+ /**
5546
+ * Encodes the specified GetPropertyQuotasSnapshotRequest message. Does not implicitly {@link google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest.verify|verify} messages.
5547
+ * @param message GetPropertyQuotasSnapshotRequest message or plain object to encode
5548
+ * @param [writer] Writer to encode to
5549
+ * @returns Writer
5550
+ */
5551
+ public static encode(message: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, writer?: $protobuf.Writer): $protobuf.Writer;
5552
+
5553
+ /**
5554
+ * Encodes the specified GetPropertyQuotasSnapshotRequest message, length delimited. Does not implicitly {@link google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest.verify|verify} messages.
5555
+ * @param message GetPropertyQuotasSnapshotRequest message or plain object to encode
5556
+ * @param [writer] Writer to encode to
5557
+ * @returns Writer
5558
+ */
5559
+ public static encodeDelimited(message: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, writer?: $protobuf.Writer): $protobuf.Writer;
5560
+
5561
+ /**
5562
+ * Decodes a GetPropertyQuotasSnapshotRequest message from the specified reader or buffer.
5563
+ * @param reader Reader or buffer to decode from
5564
+ * @param [length] Message length if known beforehand
5565
+ * @returns GetPropertyQuotasSnapshotRequest
5566
+ * @throws {Error} If the payload is not a reader or valid buffer
5567
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5568
+ */
5569
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest;
5570
+
5571
+ /**
5572
+ * Decodes a GetPropertyQuotasSnapshotRequest message from the specified reader or buffer, length delimited.
5573
+ * @param reader Reader or buffer to decode from
5574
+ * @returns GetPropertyQuotasSnapshotRequest
5575
+ * @throws {Error} If the payload is not a reader or valid buffer
5576
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5577
+ */
5578
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest;
5579
+
5580
+ /**
5581
+ * Verifies a GetPropertyQuotasSnapshotRequest message.
5582
+ * @param message Plain object to verify
5583
+ * @returns `null` if valid, otherwise the reason why it is not
5584
+ */
5585
+ public static verify(message: { [k: string]: any }): (string|null);
5586
+
5587
+ /**
5588
+ * Creates a GetPropertyQuotasSnapshotRequest message from a plain object. Also converts values to their respective internal types.
5589
+ * @param object Plain object
5590
+ * @returns GetPropertyQuotasSnapshotRequest
5591
+ */
5592
+ public static fromObject(object: { [k: string]: any }): google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest;
5593
+
5594
+ /**
5595
+ * Creates a plain object from a GetPropertyQuotasSnapshotRequest message. Also converts values to other types if specified.
5596
+ * @param message GetPropertyQuotasSnapshotRequest
5597
+ * @param [options] Conversion options
5598
+ * @returns Plain object
5599
+ */
5600
+ public static toObject(message: google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
5601
+
5602
+ /**
5603
+ * Converts this GetPropertyQuotasSnapshotRequest to JSON.
5604
+ * @returns JSON object
5605
+ */
5606
+ public toJSON(): { [k: string]: any };
5607
+
5608
+ /**
5609
+ * Gets the default type url for GetPropertyQuotasSnapshotRequest
5610
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
5611
+ * @returns The default type url
5612
+ */
5613
+ public static getTypeUrl(typeUrlPrefix?: string): string;
5614
+ }
5615
+
5616
+ /** Properties of a PropertyQuotasSnapshot. */
5617
+ interface IPropertyQuotasSnapshot {
5618
+
5619
+ /** PropertyQuotasSnapshot name */
5620
+ name?: (string|null);
5621
+
5622
+ /** PropertyQuotasSnapshot corePropertyQuota */
5623
+ corePropertyQuota?: (google.analytics.data.v1alpha.IPropertyQuota|null);
5624
+
5625
+ /** PropertyQuotasSnapshot realtimePropertyQuota */
5626
+ realtimePropertyQuota?: (google.analytics.data.v1alpha.IPropertyQuota|null);
5627
+
5628
+ /** PropertyQuotasSnapshot funnelPropertyQuota */
5629
+ funnelPropertyQuota?: (google.analytics.data.v1alpha.IPropertyQuota|null);
5630
+ }
5631
+
5632
+ /** Represents a PropertyQuotasSnapshot. */
5633
+ class PropertyQuotasSnapshot implements IPropertyQuotasSnapshot {
5634
+
5635
+ /**
5636
+ * Constructs a new PropertyQuotasSnapshot.
5637
+ * @param [properties] Properties to set
5638
+ */
5639
+ constructor(properties?: google.analytics.data.v1alpha.IPropertyQuotasSnapshot);
5640
+
5641
+ /** PropertyQuotasSnapshot name. */
5642
+ public name: string;
5643
+
5644
+ /** PropertyQuotasSnapshot corePropertyQuota. */
5645
+ public corePropertyQuota?: (google.analytics.data.v1alpha.IPropertyQuota|null);
5646
+
5647
+ /** PropertyQuotasSnapshot realtimePropertyQuota. */
5648
+ public realtimePropertyQuota?: (google.analytics.data.v1alpha.IPropertyQuota|null);
5649
+
5650
+ /** PropertyQuotasSnapshot funnelPropertyQuota. */
5651
+ public funnelPropertyQuota?: (google.analytics.data.v1alpha.IPropertyQuota|null);
5652
+
5653
+ /**
5654
+ * Creates a new PropertyQuotasSnapshot instance using the specified properties.
5655
+ * @param [properties] Properties to set
5656
+ * @returns PropertyQuotasSnapshot instance
5657
+ */
5658
+ public static create(properties?: google.analytics.data.v1alpha.IPropertyQuotasSnapshot): google.analytics.data.v1alpha.PropertyQuotasSnapshot;
5659
+
5660
+ /**
5661
+ * Encodes the specified PropertyQuotasSnapshot message. Does not implicitly {@link google.analytics.data.v1alpha.PropertyQuotasSnapshot.verify|verify} messages.
5662
+ * @param message PropertyQuotasSnapshot message or plain object to encode
5663
+ * @param [writer] Writer to encode to
5664
+ * @returns Writer
5665
+ */
5666
+ public static encode(message: google.analytics.data.v1alpha.IPropertyQuotasSnapshot, writer?: $protobuf.Writer): $protobuf.Writer;
5667
+
5668
+ /**
5669
+ * Encodes the specified PropertyQuotasSnapshot message, length delimited. Does not implicitly {@link google.analytics.data.v1alpha.PropertyQuotasSnapshot.verify|verify} messages.
5670
+ * @param message PropertyQuotasSnapshot message or plain object to encode
5671
+ * @param [writer] Writer to encode to
5672
+ * @returns Writer
5673
+ */
5674
+ public static encodeDelimited(message: google.analytics.data.v1alpha.IPropertyQuotasSnapshot, writer?: $protobuf.Writer): $protobuf.Writer;
5675
+
5676
+ /**
5677
+ * Decodes a PropertyQuotasSnapshot message from the specified reader or buffer.
5678
+ * @param reader Reader or buffer to decode from
5679
+ * @param [length] Message length if known beforehand
5680
+ * @returns PropertyQuotasSnapshot
5681
+ * @throws {Error} If the payload is not a reader or valid buffer
5682
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5683
+ */
5684
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1alpha.PropertyQuotasSnapshot;
5685
+
5686
+ /**
5687
+ * Decodes a PropertyQuotasSnapshot message from the specified reader or buffer, length delimited.
5688
+ * @param reader Reader or buffer to decode from
5689
+ * @returns PropertyQuotasSnapshot
5690
+ * @throws {Error} If the payload is not a reader or valid buffer
5691
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
5692
+ */
5693
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1alpha.PropertyQuotasSnapshot;
5694
+
5695
+ /**
5696
+ * Verifies a PropertyQuotasSnapshot message.
5697
+ * @param message Plain object to verify
5698
+ * @returns `null` if valid, otherwise the reason why it is not
5699
+ */
5700
+ public static verify(message: { [k: string]: any }): (string|null);
5701
+
5702
+ /**
5703
+ * Creates a PropertyQuotasSnapshot message from a plain object. Also converts values to their respective internal types.
5704
+ * @param object Plain object
5705
+ * @returns PropertyQuotasSnapshot
5706
+ */
5707
+ public static fromObject(object: { [k: string]: any }): google.analytics.data.v1alpha.PropertyQuotasSnapshot;
5708
+
5709
+ /**
5710
+ * Creates a plain object from a PropertyQuotasSnapshot message. Also converts values to other types if specified.
5711
+ * @param message PropertyQuotasSnapshot
5712
+ * @param [options] Conversion options
5713
+ * @returns Plain object
5714
+ */
5715
+ public static toObject(message: google.analytics.data.v1alpha.PropertyQuotasSnapshot, options?: $protobuf.IConversionOptions): { [k: string]: any };
5716
+
5717
+ /**
5718
+ * Converts this PropertyQuotasSnapshot to JSON.
5719
+ * @returns JSON object
5720
+ */
5721
+ public toJSON(): { [k: string]: any };
5722
+
5723
+ /**
5724
+ * Gets the default type url for PropertyQuotasSnapshot
5725
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
5726
+ * @returns The default type url
5727
+ */
5728
+ public static getTypeUrl(typeUrlPrefix?: string): string;
5729
+ }
5730
+
5498
5731
  /** Properties of a GetAudienceListRequest. */
5499
5732
  interface IGetAudienceListRequest {
5500
5733
 
@@ -13316,6 +13316,39 @@
13316
13316
  * @variation 2
13317
13317
  */
13318
13318
 
13319
+ /**
13320
+ * Callback as used by {@link google.analytics.data.v1alpha.AlphaAnalyticsData|getPropertyQuotasSnapshot}.
13321
+ * @memberof google.analytics.data.v1alpha.AlphaAnalyticsData
13322
+ * @typedef GetPropertyQuotasSnapshotCallback
13323
+ * @type {function}
13324
+ * @param {Error|null} error Error, if any
13325
+ * @param {google.analytics.data.v1alpha.PropertyQuotasSnapshot} [response] PropertyQuotasSnapshot
13326
+ */
13327
+
13328
+ /**
13329
+ * Calls GetPropertyQuotasSnapshot.
13330
+ * @function getPropertyQuotasSnapshot
13331
+ * @memberof google.analytics.data.v1alpha.AlphaAnalyticsData
13332
+ * @instance
13333
+ * @param {google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest} request GetPropertyQuotasSnapshotRequest message or plain object
13334
+ * @param {google.analytics.data.v1alpha.AlphaAnalyticsData.GetPropertyQuotasSnapshotCallback} callback Node-style callback called with the error, if any, and PropertyQuotasSnapshot
13335
+ * @returns {undefined}
13336
+ * @variation 1
13337
+ */
13338
+ Object.defineProperty(AlphaAnalyticsData.prototype.getPropertyQuotasSnapshot = function getPropertyQuotasSnapshot(request, callback) {
13339
+ return this.rpcCall(getPropertyQuotasSnapshot, $root.google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest, $root.google.analytics.data.v1alpha.PropertyQuotasSnapshot, request, callback);
13340
+ }, "name", { value: "GetPropertyQuotasSnapshot" });
13341
+
13342
+ /**
13343
+ * Calls GetPropertyQuotasSnapshot.
13344
+ * @function getPropertyQuotasSnapshot
13345
+ * @memberof google.analytics.data.v1alpha.AlphaAnalyticsData
13346
+ * @instance
13347
+ * @param {google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest} request GetPropertyQuotasSnapshotRequest message or plain object
13348
+ * @returns {Promise<google.analytics.data.v1alpha.PropertyQuotasSnapshot>} Promise
13349
+ * @variation 2
13350
+ */
13351
+
13319
13352
  /**
13320
13353
  * Callback as used by {@link google.analytics.data.v1alpha.AlphaAnalyticsData|createReportTask}.
13321
13354
  * @memberof google.analytics.data.v1alpha.AlphaAnalyticsData
@@ -15082,6 +15115,497 @@
15082
15115
  return ListRecurringAudienceListsResponse;
15083
15116
  })();
15084
15117
 
15118
+ v1alpha.GetPropertyQuotasSnapshotRequest = (function() {
15119
+
15120
+ /**
15121
+ * Properties of a GetPropertyQuotasSnapshotRequest.
15122
+ * @memberof google.analytics.data.v1alpha
15123
+ * @interface IGetPropertyQuotasSnapshotRequest
15124
+ * @property {string|null} [name] GetPropertyQuotasSnapshotRequest name
15125
+ */
15126
+
15127
+ /**
15128
+ * Constructs a new GetPropertyQuotasSnapshotRequest.
15129
+ * @memberof google.analytics.data.v1alpha
15130
+ * @classdesc Represents a GetPropertyQuotasSnapshotRequest.
15131
+ * @implements IGetPropertyQuotasSnapshotRequest
15132
+ * @constructor
15133
+ * @param {google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest=} [properties] Properties to set
15134
+ */
15135
+ function GetPropertyQuotasSnapshotRequest(properties) {
15136
+ if (properties)
15137
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
15138
+ if (properties[keys[i]] != null)
15139
+ this[keys[i]] = properties[keys[i]];
15140
+ }
15141
+
15142
+ /**
15143
+ * GetPropertyQuotasSnapshotRequest name.
15144
+ * @member {string} name
15145
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15146
+ * @instance
15147
+ */
15148
+ GetPropertyQuotasSnapshotRequest.prototype.name = "";
15149
+
15150
+ /**
15151
+ * Creates a new GetPropertyQuotasSnapshotRequest instance using the specified properties.
15152
+ * @function create
15153
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15154
+ * @static
15155
+ * @param {google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest=} [properties] Properties to set
15156
+ * @returns {google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest} GetPropertyQuotasSnapshotRequest instance
15157
+ */
15158
+ GetPropertyQuotasSnapshotRequest.create = function create(properties) {
15159
+ return new GetPropertyQuotasSnapshotRequest(properties);
15160
+ };
15161
+
15162
+ /**
15163
+ * Encodes the specified GetPropertyQuotasSnapshotRequest message. Does not implicitly {@link google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest.verify|verify} messages.
15164
+ * @function encode
15165
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15166
+ * @static
15167
+ * @param {google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest} message GetPropertyQuotasSnapshotRequest message or plain object to encode
15168
+ * @param {$protobuf.Writer} [writer] Writer to encode to
15169
+ * @returns {$protobuf.Writer} Writer
15170
+ */
15171
+ GetPropertyQuotasSnapshotRequest.encode = function encode(message, writer) {
15172
+ if (!writer)
15173
+ writer = $Writer.create();
15174
+ if (message.name != null && Object.hasOwnProperty.call(message, "name"))
15175
+ writer.uint32(/* id 1, wireType 2 =*/10).string(message.name);
15176
+ return writer;
15177
+ };
15178
+
15179
+ /**
15180
+ * Encodes the specified GetPropertyQuotasSnapshotRequest message, length delimited. Does not implicitly {@link google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest.verify|verify} messages.
15181
+ * @function encodeDelimited
15182
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15183
+ * @static
15184
+ * @param {google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest} message GetPropertyQuotasSnapshotRequest message or plain object to encode
15185
+ * @param {$protobuf.Writer} [writer] Writer to encode to
15186
+ * @returns {$protobuf.Writer} Writer
15187
+ */
15188
+ GetPropertyQuotasSnapshotRequest.encodeDelimited = function encodeDelimited(message, writer) {
15189
+ return this.encode(message, writer).ldelim();
15190
+ };
15191
+
15192
+ /**
15193
+ * Decodes a GetPropertyQuotasSnapshotRequest message from the specified reader or buffer.
15194
+ * @function decode
15195
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15196
+ * @static
15197
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
15198
+ * @param {number} [length] Message length if known beforehand
15199
+ * @returns {google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest} GetPropertyQuotasSnapshotRequest
15200
+ * @throws {Error} If the payload is not a reader or valid buffer
15201
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
15202
+ */
15203
+ GetPropertyQuotasSnapshotRequest.decode = function decode(reader, length) {
15204
+ if (!(reader instanceof $Reader))
15205
+ reader = $Reader.create(reader);
15206
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest();
15207
+ while (reader.pos < end) {
15208
+ var tag = reader.uint32();
15209
+ switch (tag >>> 3) {
15210
+ case 1: {
15211
+ message.name = reader.string();
15212
+ break;
15213
+ }
15214
+ default:
15215
+ reader.skipType(tag & 7);
15216
+ break;
15217
+ }
15218
+ }
15219
+ return message;
15220
+ };
15221
+
15222
+ /**
15223
+ * Decodes a GetPropertyQuotasSnapshotRequest message from the specified reader or buffer, length delimited.
15224
+ * @function decodeDelimited
15225
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15226
+ * @static
15227
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
15228
+ * @returns {google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest} GetPropertyQuotasSnapshotRequest
15229
+ * @throws {Error} If the payload is not a reader or valid buffer
15230
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
15231
+ */
15232
+ GetPropertyQuotasSnapshotRequest.decodeDelimited = function decodeDelimited(reader) {
15233
+ if (!(reader instanceof $Reader))
15234
+ reader = new $Reader(reader);
15235
+ return this.decode(reader, reader.uint32());
15236
+ };
15237
+
15238
+ /**
15239
+ * Verifies a GetPropertyQuotasSnapshotRequest message.
15240
+ * @function verify
15241
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15242
+ * @static
15243
+ * @param {Object.<string,*>} message Plain object to verify
15244
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
15245
+ */
15246
+ GetPropertyQuotasSnapshotRequest.verify = function verify(message) {
15247
+ if (typeof message !== "object" || message === null)
15248
+ return "object expected";
15249
+ if (message.name != null && message.hasOwnProperty("name"))
15250
+ if (!$util.isString(message.name))
15251
+ return "name: string expected";
15252
+ return null;
15253
+ };
15254
+
15255
+ /**
15256
+ * Creates a GetPropertyQuotasSnapshotRequest message from a plain object. Also converts values to their respective internal types.
15257
+ * @function fromObject
15258
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15259
+ * @static
15260
+ * @param {Object.<string,*>} object Plain object
15261
+ * @returns {google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest} GetPropertyQuotasSnapshotRequest
15262
+ */
15263
+ GetPropertyQuotasSnapshotRequest.fromObject = function fromObject(object) {
15264
+ if (object instanceof $root.google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest)
15265
+ return object;
15266
+ var message = new $root.google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest();
15267
+ if (object.name != null)
15268
+ message.name = String(object.name);
15269
+ return message;
15270
+ };
15271
+
15272
+ /**
15273
+ * Creates a plain object from a GetPropertyQuotasSnapshotRequest message. Also converts values to other types if specified.
15274
+ * @function toObject
15275
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15276
+ * @static
15277
+ * @param {google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest} message GetPropertyQuotasSnapshotRequest
15278
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
15279
+ * @returns {Object.<string,*>} Plain object
15280
+ */
15281
+ GetPropertyQuotasSnapshotRequest.toObject = function toObject(message, options) {
15282
+ if (!options)
15283
+ options = {};
15284
+ var object = {};
15285
+ if (options.defaults)
15286
+ object.name = "";
15287
+ if (message.name != null && message.hasOwnProperty("name"))
15288
+ object.name = message.name;
15289
+ return object;
15290
+ };
15291
+
15292
+ /**
15293
+ * Converts this GetPropertyQuotasSnapshotRequest to JSON.
15294
+ * @function toJSON
15295
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15296
+ * @instance
15297
+ * @returns {Object.<string,*>} JSON object
15298
+ */
15299
+ GetPropertyQuotasSnapshotRequest.prototype.toJSON = function toJSON() {
15300
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
15301
+ };
15302
+
15303
+ /**
15304
+ * Gets the default type url for GetPropertyQuotasSnapshotRequest
15305
+ * @function getTypeUrl
15306
+ * @memberof google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest
15307
+ * @static
15308
+ * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
15309
+ * @returns {string} The default type url
15310
+ */
15311
+ GetPropertyQuotasSnapshotRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
15312
+ if (typeUrlPrefix === undefined) {
15313
+ typeUrlPrefix = "type.googleapis.com";
15314
+ }
15315
+ return typeUrlPrefix + "/google.analytics.data.v1alpha.GetPropertyQuotasSnapshotRequest";
15316
+ };
15317
+
15318
+ return GetPropertyQuotasSnapshotRequest;
15319
+ })();
15320
+
15321
+ v1alpha.PropertyQuotasSnapshot = (function() {
15322
+
15323
+ /**
15324
+ * Properties of a PropertyQuotasSnapshot.
15325
+ * @memberof google.analytics.data.v1alpha
15326
+ * @interface IPropertyQuotasSnapshot
15327
+ * @property {string|null} [name] PropertyQuotasSnapshot name
15328
+ * @property {google.analytics.data.v1alpha.IPropertyQuota|null} [corePropertyQuota] PropertyQuotasSnapshot corePropertyQuota
15329
+ * @property {google.analytics.data.v1alpha.IPropertyQuota|null} [realtimePropertyQuota] PropertyQuotasSnapshot realtimePropertyQuota
15330
+ * @property {google.analytics.data.v1alpha.IPropertyQuota|null} [funnelPropertyQuota] PropertyQuotasSnapshot funnelPropertyQuota
15331
+ */
15332
+
15333
+ /**
15334
+ * Constructs a new PropertyQuotasSnapshot.
15335
+ * @memberof google.analytics.data.v1alpha
15336
+ * @classdesc Represents a PropertyQuotasSnapshot.
15337
+ * @implements IPropertyQuotasSnapshot
15338
+ * @constructor
15339
+ * @param {google.analytics.data.v1alpha.IPropertyQuotasSnapshot=} [properties] Properties to set
15340
+ */
15341
+ function PropertyQuotasSnapshot(properties) {
15342
+ if (properties)
15343
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
15344
+ if (properties[keys[i]] != null)
15345
+ this[keys[i]] = properties[keys[i]];
15346
+ }
15347
+
15348
+ /**
15349
+ * PropertyQuotasSnapshot name.
15350
+ * @member {string} name
15351
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15352
+ * @instance
15353
+ */
15354
+ PropertyQuotasSnapshot.prototype.name = "";
15355
+
15356
+ /**
15357
+ * PropertyQuotasSnapshot corePropertyQuota.
15358
+ * @member {google.analytics.data.v1alpha.IPropertyQuota|null|undefined} corePropertyQuota
15359
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15360
+ * @instance
15361
+ */
15362
+ PropertyQuotasSnapshot.prototype.corePropertyQuota = null;
15363
+
15364
+ /**
15365
+ * PropertyQuotasSnapshot realtimePropertyQuota.
15366
+ * @member {google.analytics.data.v1alpha.IPropertyQuota|null|undefined} realtimePropertyQuota
15367
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15368
+ * @instance
15369
+ */
15370
+ PropertyQuotasSnapshot.prototype.realtimePropertyQuota = null;
15371
+
15372
+ /**
15373
+ * PropertyQuotasSnapshot funnelPropertyQuota.
15374
+ * @member {google.analytics.data.v1alpha.IPropertyQuota|null|undefined} funnelPropertyQuota
15375
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15376
+ * @instance
15377
+ */
15378
+ PropertyQuotasSnapshot.prototype.funnelPropertyQuota = null;
15379
+
15380
+ /**
15381
+ * Creates a new PropertyQuotasSnapshot instance using the specified properties.
15382
+ * @function create
15383
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15384
+ * @static
15385
+ * @param {google.analytics.data.v1alpha.IPropertyQuotasSnapshot=} [properties] Properties to set
15386
+ * @returns {google.analytics.data.v1alpha.PropertyQuotasSnapshot} PropertyQuotasSnapshot instance
15387
+ */
15388
+ PropertyQuotasSnapshot.create = function create(properties) {
15389
+ return new PropertyQuotasSnapshot(properties);
15390
+ };
15391
+
15392
+ /**
15393
+ * Encodes the specified PropertyQuotasSnapshot message. Does not implicitly {@link google.analytics.data.v1alpha.PropertyQuotasSnapshot.verify|verify} messages.
15394
+ * @function encode
15395
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15396
+ * @static
15397
+ * @param {google.analytics.data.v1alpha.IPropertyQuotasSnapshot} message PropertyQuotasSnapshot message or plain object to encode
15398
+ * @param {$protobuf.Writer} [writer] Writer to encode to
15399
+ * @returns {$protobuf.Writer} Writer
15400
+ */
15401
+ PropertyQuotasSnapshot.encode = function encode(message, writer) {
15402
+ if (!writer)
15403
+ writer = $Writer.create();
15404
+ if (message.corePropertyQuota != null && Object.hasOwnProperty.call(message, "corePropertyQuota"))
15405
+ $root.google.analytics.data.v1alpha.PropertyQuota.encode(message.corePropertyQuota, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
15406
+ if (message.realtimePropertyQuota != null && Object.hasOwnProperty.call(message, "realtimePropertyQuota"))
15407
+ $root.google.analytics.data.v1alpha.PropertyQuota.encode(message.realtimePropertyQuota, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
15408
+ if (message.funnelPropertyQuota != null && Object.hasOwnProperty.call(message, "funnelPropertyQuota"))
15409
+ $root.google.analytics.data.v1alpha.PropertyQuota.encode(message.funnelPropertyQuota, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
15410
+ if (message.name != null && Object.hasOwnProperty.call(message, "name"))
15411
+ writer.uint32(/* id 4, wireType 2 =*/34).string(message.name);
15412
+ return writer;
15413
+ };
15414
+
15415
+ /**
15416
+ * Encodes the specified PropertyQuotasSnapshot message, length delimited. Does not implicitly {@link google.analytics.data.v1alpha.PropertyQuotasSnapshot.verify|verify} messages.
15417
+ * @function encodeDelimited
15418
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15419
+ * @static
15420
+ * @param {google.analytics.data.v1alpha.IPropertyQuotasSnapshot} message PropertyQuotasSnapshot message or plain object to encode
15421
+ * @param {$protobuf.Writer} [writer] Writer to encode to
15422
+ * @returns {$protobuf.Writer} Writer
15423
+ */
15424
+ PropertyQuotasSnapshot.encodeDelimited = function encodeDelimited(message, writer) {
15425
+ return this.encode(message, writer).ldelim();
15426
+ };
15427
+
15428
+ /**
15429
+ * Decodes a PropertyQuotasSnapshot message from the specified reader or buffer.
15430
+ * @function decode
15431
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15432
+ * @static
15433
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
15434
+ * @param {number} [length] Message length if known beforehand
15435
+ * @returns {google.analytics.data.v1alpha.PropertyQuotasSnapshot} PropertyQuotasSnapshot
15436
+ * @throws {Error} If the payload is not a reader or valid buffer
15437
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
15438
+ */
15439
+ PropertyQuotasSnapshot.decode = function decode(reader, length) {
15440
+ if (!(reader instanceof $Reader))
15441
+ reader = $Reader.create(reader);
15442
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.analytics.data.v1alpha.PropertyQuotasSnapshot();
15443
+ while (reader.pos < end) {
15444
+ var tag = reader.uint32();
15445
+ switch (tag >>> 3) {
15446
+ case 4: {
15447
+ message.name = reader.string();
15448
+ break;
15449
+ }
15450
+ case 1: {
15451
+ message.corePropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.decode(reader, reader.uint32());
15452
+ break;
15453
+ }
15454
+ case 2: {
15455
+ message.realtimePropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.decode(reader, reader.uint32());
15456
+ break;
15457
+ }
15458
+ case 3: {
15459
+ message.funnelPropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.decode(reader, reader.uint32());
15460
+ break;
15461
+ }
15462
+ default:
15463
+ reader.skipType(tag & 7);
15464
+ break;
15465
+ }
15466
+ }
15467
+ return message;
15468
+ };
15469
+
15470
+ /**
15471
+ * Decodes a PropertyQuotasSnapshot message from the specified reader or buffer, length delimited.
15472
+ * @function decodeDelimited
15473
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15474
+ * @static
15475
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
15476
+ * @returns {google.analytics.data.v1alpha.PropertyQuotasSnapshot} PropertyQuotasSnapshot
15477
+ * @throws {Error} If the payload is not a reader or valid buffer
15478
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
15479
+ */
15480
+ PropertyQuotasSnapshot.decodeDelimited = function decodeDelimited(reader) {
15481
+ if (!(reader instanceof $Reader))
15482
+ reader = new $Reader(reader);
15483
+ return this.decode(reader, reader.uint32());
15484
+ };
15485
+
15486
+ /**
15487
+ * Verifies a PropertyQuotasSnapshot message.
15488
+ * @function verify
15489
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15490
+ * @static
15491
+ * @param {Object.<string,*>} message Plain object to verify
15492
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
15493
+ */
15494
+ PropertyQuotasSnapshot.verify = function verify(message) {
15495
+ if (typeof message !== "object" || message === null)
15496
+ return "object expected";
15497
+ if (message.name != null && message.hasOwnProperty("name"))
15498
+ if (!$util.isString(message.name))
15499
+ return "name: string expected";
15500
+ if (message.corePropertyQuota != null && message.hasOwnProperty("corePropertyQuota")) {
15501
+ var error = $root.google.analytics.data.v1alpha.PropertyQuota.verify(message.corePropertyQuota);
15502
+ if (error)
15503
+ return "corePropertyQuota." + error;
15504
+ }
15505
+ if (message.realtimePropertyQuota != null && message.hasOwnProperty("realtimePropertyQuota")) {
15506
+ var error = $root.google.analytics.data.v1alpha.PropertyQuota.verify(message.realtimePropertyQuota);
15507
+ if (error)
15508
+ return "realtimePropertyQuota." + error;
15509
+ }
15510
+ if (message.funnelPropertyQuota != null && message.hasOwnProperty("funnelPropertyQuota")) {
15511
+ var error = $root.google.analytics.data.v1alpha.PropertyQuota.verify(message.funnelPropertyQuota);
15512
+ if (error)
15513
+ return "funnelPropertyQuota." + error;
15514
+ }
15515
+ return null;
15516
+ };
15517
+
15518
+ /**
15519
+ * Creates a PropertyQuotasSnapshot message from a plain object. Also converts values to their respective internal types.
15520
+ * @function fromObject
15521
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15522
+ * @static
15523
+ * @param {Object.<string,*>} object Plain object
15524
+ * @returns {google.analytics.data.v1alpha.PropertyQuotasSnapshot} PropertyQuotasSnapshot
15525
+ */
15526
+ PropertyQuotasSnapshot.fromObject = function fromObject(object) {
15527
+ if (object instanceof $root.google.analytics.data.v1alpha.PropertyQuotasSnapshot)
15528
+ return object;
15529
+ var message = new $root.google.analytics.data.v1alpha.PropertyQuotasSnapshot();
15530
+ if (object.name != null)
15531
+ message.name = String(object.name);
15532
+ if (object.corePropertyQuota != null) {
15533
+ if (typeof object.corePropertyQuota !== "object")
15534
+ throw TypeError(".google.analytics.data.v1alpha.PropertyQuotasSnapshot.corePropertyQuota: object expected");
15535
+ message.corePropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.fromObject(object.corePropertyQuota);
15536
+ }
15537
+ if (object.realtimePropertyQuota != null) {
15538
+ if (typeof object.realtimePropertyQuota !== "object")
15539
+ throw TypeError(".google.analytics.data.v1alpha.PropertyQuotasSnapshot.realtimePropertyQuota: object expected");
15540
+ message.realtimePropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.fromObject(object.realtimePropertyQuota);
15541
+ }
15542
+ if (object.funnelPropertyQuota != null) {
15543
+ if (typeof object.funnelPropertyQuota !== "object")
15544
+ throw TypeError(".google.analytics.data.v1alpha.PropertyQuotasSnapshot.funnelPropertyQuota: object expected");
15545
+ message.funnelPropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.fromObject(object.funnelPropertyQuota);
15546
+ }
15547
+ return message;
15548
+ };
15549
+
15550
+ /**
15551
+ * Creates a plain object from a PropertyQuotasSnapshot message. Also converts values to other types if specified.
15552
+ * @function toObject
15553
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15554
+ * @static
15555
+ * @param {google.analytics.data.v1alpha.PropertyQuotasSnapshot} message PropertyQuotasSnapshot
15556
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
15557
+ * @returns {Object.<string,*>} Plain object
15558
+ */
15559
+ PropertyQuotasSnapshot.toObject = function toObject(message, options) {
15560
+ if (!options)
15561
+ options = {};
15562
+ var object = {};
15563
+ if (options.defaults) {
15564
+ object.corePropertyQuota = null;
15565
+ object.realtimePropertyQuota = null;
15566
+ object.funnelPropertyQuota = null;
15567
+ object.name = "";
15568
+ }
15569
+ if (message.corePropertyQuota != null && message.hasOwnProperty("corePropertyQuota"))
15570
+ object.corePropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.toObject(message.corePropertyQuota, options);
15571
+ if (message.realtimePropertyQuota != null && message.hasOwnProperty("realtimePropertyQuota"))
15572
+ object.realtimePropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.toObject(message.realtimePropertyQuota, options);
15573
+ if (message.funnelPropertyQuota != null && message.hasOwnProperty("funnelPropertyQuota"))
15574
+ object.funnelPropertyQuota = $root.google.analytics.data.v1alpha.PropertyQuota.toObject(message.funnelPropertyQuota, options);
15575
+ if (message.name != null && message.hasOwnProperty("name"))
15576
+ object.name = message.name;
15577
+ return object;
15578
+ };
15579
+
15580
+ /**
15581
+ * Converts this PropertyQuotasSnapshot to JSON.
15582
+ * @function toJSON
15583
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15584
+ * @instance
15585
+ * @returns {Object.<string,*>} JSON object
15586
+ */
15587
+ PropertyQuotasSnapshot.prototype.toJSON = function toJSON() {
15588
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
15589
+ };
15590
+
15591
+ /**
15592
+ * Gets the default type url for PropertyQuotasSnapshot
15593
+ * @function getTypeUrl
15594
+ * @memberof google.analytics.data.v1alpha.PropertyQuotasSnapshot
15595
+ * @static
15596
+ * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
15597
+ * @returns {string} The default type url
15598
+ */
15599
+ PropertyQuotasSnapshot.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
15600
+ if (typeUrlPrefix === undefined) {
15601
+ typeUrlPrefix = "type.googleapis.com";
15602
+ }
15603
+ return typeUrlPrefix + "/google.analytics.data.v1alpha.PropertyQuotasSnapshot";
15604
+ };
15605
+
15606
+ return PropertyQuotasSnapshot;
15607
+ })();
15608
+
15085
15609
  v1alpha.GetAudienceListRequest = (function() {
15086
15610
 
15087
15611
  /**
@@ -1,4 +1,7 @@
1
1
  {
2
+ "options": {
3
+ "syntax": "proto3"
4
+ },
2
5
  "nested": {
3
6
  "google": {
4
7
  "nested": {
@@ -1514,6 +1517,24 @@
1514
1517
  }
1515
1518
  ]
1516
1519
  },
1520
+ "GetPropertyQuotasSnapshot": {
1521
+ "requestType": "GetPropertyQuotasSnapshotRequest",
1522
+ "responseType": "PropertyQuotasSnapshot",
1523
+ "options": {
1524
+ "(google.api.http).get": "/v1alpha/{name=properties/*/propertyQuotasSnapshot}",
1525
+ "(google.api.method_signature)": "name"
1526
+ },
1527
+ "parsedOptions": [
1528
+ {
1529
+ "(google.api.http)": {
1530
+ "get": "/v1alpha/{name=properties/*/propertyQuotasSnapshot}"
1531
+ }
1532
+ },
1533
+ {
1534
+ "(google.api.method_signature)": "name"
1535
+ }
1536
+ ]
1537
+ },
1517
1538
  "CreateReportTask": {
1518
1539
  "requestType": "CreateReportTaskRequest",
1519
1540
  "responseType": "google.longrunning.Operation",
@@ -1787,6 +1808,47 @@
1787
1808
  }
1788
1809
  }
1789
1810
  },
1811
+ "GetPropertyQuotasSnapshotRequest": {
1812
+ "fields": {
1813
+ "name": {
1814
+ "type": "string",
1815
+ "id": 1,
1816
+ "options": {
1817
+ "(google.api.field_behavior)": "REQUIRED",
1818
+ "(google.api.resource_reference).type": "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
1819
+ }
1820
+ }
1821
+ }
1822
+ },
1823
+ "PropertyQuotasSnapshot": {
1824
+ "options": {
1825
+ "(google.api.resource).type": "analyticsadmin.googleapis.com/PropertyQuotasSnapshot",
1826
+ "(google.api.resource).pattern": "properties/{property}/propertyQuotasSnapshot",
1827
+ "(google.api.resource).plural": "propertyQuotasSnapshots",
1828
+ "(google.api.resource).singular": "propertyQuotasSnapshot"
1829
+ },
1830
+ "fields": {
1831
+ "name": {
1832
+ "type": "string",
1833
+ "id": 4,
1834
+ "options": {
1835
+ "(google.api.field_behavior)": "IDENTIFIER"
1836
+ }
1837
+ },
1838
+ "corePropertyQuota": {
1839
+ "type": "PropertyQuota",
1840
+ "id": 1
1841
+ },
1842
+ "realtimePropertyQuota": {
1843
+ "type": "PropertyQuota",
1844
+ "id": 2
1845
+ },
1846
+ "funnelPropertyQuota": {
1847
+ "type": "PropertyQuota",
1848
+ "id": 3
1849
+ }
1850
+ }
1851
+ },
1790
1852
  "GetAudienceListRequest": {
1791
1853
  "fields": {
1792
1854
  "name": {
@@ -136,9 +136,9 @@ export declare class AlphaAnalyticsDataClient {
136
136
  * @param {Object} request
137
137
  * The request object that will be sent.
138
138
  * @param {string} [request.property]
139
- * Optional. A Google Analytics GA4 property identifier whose events are
140
- * tracked. Specified in the URL path and not the body. To learn more, see
141
- * [where to find your Property
139
+ * Optional. A Google Analytics property identifier whose events are tracked.
140
+ * Specified in the URL path and not the body. To learn more, see [where to
141
+ * find your Property
142
142
  * ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
143
143
  * Within a batch request, this property should either be unspecified or
144
144
  * consistent with the batch-level property.
@@ -450,6 +450,31 @@ export declare class AlphaAnalyticsDataClient {
450
450
  ]>;
451
451
  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;
452
452
  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;
453
+ /**
454
+ * Get all property quotas organized by quota category for a given property.
455
+ * This will charge 1 property quota from the category with the most quota.
456
+ *
457
+ * @param {Object} request
458
+ * The request object that will be sent.
459
+ * @param {string} request.name
460
+ * Required. Quotas from this property will be listed in the response.
461
+ * Format: `properties/{property}/propertyQuotasSnapshot`
462
+ * @param {object} [options]
463
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
464
+ * @returns {Promise} - The promise which resolves to an array.
465
+ * The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.PropertyQuotasSnapshot|PropertyQuotasSnapshot}.
466
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
467
+ * for more details and examples.
468
+ * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.get_property_quotas_snapshot.js</caption>
469
+ * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_GetPropertyQuotasSnapshot_async
470
+ */
471
+ getPropertyQuotasSnapshot(request?: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, options?: CallOptions): Promise<[
472
+ protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot,
473
+ (protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | undefined),
474
+ {} | undefined
475
+ ]>;
476
+ getPropertyQuotasSnapshot(request: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot, protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | null | undefined, {} | null | undefined>): void;
477
+ getPropertyQuotasSnapshot(request: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, callback: Callback<protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot, protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | null | undefined, {} | null | undefined>): void;
453
478
  /**
454
479
  * Retrieves a report task's content. After requesting the `CreateReportTask`,
455
480
  * you are able to retrieve the report content once the report is
@@ -599,6 +624,12 @@ export declare class AlphaAnalyticsDataClient {
599
624
  * asynchronous request to form a customized report of your Google Analytics
600
625
  * event data.
601
626
  *
627
+ * A report task will be retained and available for querying for 72 hours
628
+ * after it has been created.
629
+ *
630
+ * A report task created by one user can be listed and queried by all users
631
+ * who have access to the property.
632
+ *
602
633
  * @param {Object} request
603
634
  * The request object that will be sent.
604
635
  * @param {string} request.parent
@@ -1110,6 +1141,21 @@ export declare class AlphaAnalyticsDataClient {
1110
1141
  * @returns {string} A string representing the property.
1111
1142
  */
1112
1143
  matchPropertyFromPropertyName(propertyName: string): string | number;
1144
+ /**
1145
+ * Return a fully-qualified propertyQuotasSnapshot resource name string.
1146
+ *
1147
+ * @param {string} property
1148
+ * @returns {string} Resource name string.
1149
+ */
1150
+ propertyQuotasSnapshotPath(property: string): string;
1151
+ /**
1152
+ * Parse the property from PropertyQuotasSnapshot resource.
1153
+ *
1154
+ * @param {string} propertyQuotasSnapshotName
1155
+ * A fully-qualified path representing PropertyQuotasSnapshot resource.
1156
+ * @returns {string} A string representing the property.
1157
+ */
1158
+ matchPropertyFromPropertyQuotasSnapshotName(propertyQuotasSnapshotName: string): string | number;
1113
1159
  /**
1114
1160
  * Return a fully-qualified recurringAudienceList resource name string.
1115
1161
  *
@@ -150,6 +150,7 @@ class AlphaAnalyticsDataClient {
150
150
  this.pathTemplates = {
151
151
  audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/audienceLists/{audience_list}'),
152
152
  propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{property}'),
153
+ propertyQuotasSnapshotPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/propertyQuotasSnapshot'),
153
154
  recurringAudienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/recurringAudienceLists/{recurring_audience_list}'),
154
155
  reportTaskPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/reportTasks/{report_task}'),
155
156
  };
@@ -228,6 +229,7 @@ class AlphaAnalyticsDataClient {
228
229
  'createRecurringAudienceList',
229
230
  'getRecurringAudienceList',
230
231
  'listRecurringAudienceLists',
232
+ 'getPropertyQuotasSnapshot',
231
233
  'createReportTask',
232
234
  'queryReportTask',
233
235
  'getReportTask',
@@ -443,6 +445,27 @@ class AlphaAnalyticsDataClient {
443
445
  this.initialize();
444
446
  return this.innerApiCalls.getRecurringAudienceList(request, options, callback);
445
447
  }
448
+ getPropertyQuotasSnapshot(request, optionsOrCallback, callback) {
449
+ var _a;
450
+ request = request || {};
451
+ let options;
452
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
453
+ callback = optionsOrCallback;
454
+ options = {};
455
+ }
456
+ else {
457
+ options = optionsOrCallback;
458
+ }
459
+ options = options || {};
460
+ options.otherArgs = options.otherArgs || {};
461
+ options.otherArgs.headers = options.otherArgs.headers || {};
462
+ options.otherArgs.headers['x-goog-request-params'] =
463
+ this._gaxModule.routingHeader.fromParams({
464
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
465
+ });
466
+ this.initialize();
467
+ return this.innerApiCalls.getPropertyQuotasSnapshot(request, options, callback);
468
+ }
446
469
  queryReportTask(request, optionsOrCallback, callback) {
447
470
  var _a;
448
471
  request = request || {};
@@ -1076,6 +1099,27 @@ class AlphaAnalyticsDataClient {
1076
1099
  matchPropertyFromPropertyName(propertyName) {
1077
1100
  return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
1078
1101
  }
1102
+ /**
1103
+ * Return a fully-qualified propertyQuotasSnapshot resource name string.
1104
+ *
1105
+ * @param {string} property
1106
+ * @returns {string} Resource name string.
1107
+ */
1108
+ propertyQuotasSnapshotPath(property) {
1109
+ return this.pathTemplates.propertyQuotasSnapshotPathTemplate.render({
1110
+ property: property,
1111
+ });
1112
+ }
1113
+ /**
1114
+ * Parse the property from PropertyQuotasSnapshot resource.
1115
+ *
1116
+ * @param {string} propertyQuotasSnapshotName
1117
+ * A fully-qualified path representing PropertyQuotasSnapshot resource.
1118
+ * @returns {string} A string representing the property.
1119
+ */
1120
+ matchPropertyFromPropertyQuotasSnapshotName(propertyQuotasSnapshotName) {
1121
+ return this.pathTemplates.propertyQuotasSnapshotPathTemplate.match(propertyQuotasSnapshotName).property;
1122
+ }
1079
1123
  /**
1080
1124
  * Return a fully-qualified recurringAudienceList resource name string.
1081
1125
  *
@@ -77,6 +77,11 @@
77
77
  "retry_codes_name": "unknown",
78
78
  "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
79
79
  },
80
+ "GetPropertyQuotasSnapshot": {
81
+ "timeout_millis": 60000,
82
+ "retry_codes_name": "unknown",
83
+ "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
84
+ },
80
85
  "CreateReportTask": {
81
86
  "timeout_millis": 60000,
82
87
  "retry_codes_name": "unknown",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-analytics/data",
3
- "version": "4.8.0",
3
+ "version": "4.9.0",
4
4
  "description": "Data client for Node.js",
5
5
  "repository": {
6
6
  "type": "git",