Skip to content

Commit

Permalink
docs: Minor formatting
Browse files Browse the repository at this point in the history
docs: Add clarifications

PiperOrigin-RevId: 553885123

Source-Link: googleapis/googleapis@9458a5a

Source-Link: googleapis/googleapis-gen@8b78760
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQW5hbHl0aWNzLkRhdGEuVjFCZXRhLy5Pd2xCb3QueWFtbCIsImgiOiI4Yjc4NzYwMzRmY2ZiNTIxZGJkOTI5NzcwOWUwNzNiNjFjZDg5MzUxIn0=
  • Loading branch information
gcf-owl-bot[bot] committed Aug 4, 2023
1 parent 564e32f commit 595b907
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,6 @@ public CheckCompatibilityRequest Clone() {
/// `property` should be the same value as in your `runReport` request.
///
/// Example: properties/1234
///
/// Set the Property ID to 0 for compatibility checking on dimensions and
/// metrics common to all properties. In this special mode, this method will
/// not return custom dimensions and metrics.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1199,7 +1195,7 @@ public string Property {
public const int DimensionFilterFieldNumber = 5;
private global::Google.Analytics.Data.V1Beta.FilterExpression dimensionFilter_;
/// <summary>
/// Dimension filters allow you to ask for only specific dimension values in
/// Dimension filters let you ask for only specific dimension values in
/// the report. To learn more, see [Fundamentals of Dimension
/// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
/// for examples. Metrics cannot be used in this filter.
Expand Down Expand Up @@ -1257,7 +1253,7 @@ public long Offset {
private long limit_;
/// <summary>
/// The number of rows to return. If unspecified, 10,000 rows are returned. The
/// API returns a maximum of 100,000 rows per request, no matter how many you
/// API returns a maximum of 250,000 rows per request, no matter how many you
/// ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
Expand Down Expand Up @@ -1346,6 +1342,13 @@ public string CurrencyCode {
/// If false or unspecified, each row with all metrics equal to 0 will not be
/// returned. If true, these rows will be returned if they are not separately
/// removed by a filter.
///
/// Regardless of this `keep_empty_rows` setting, only data recorded by the
/// Google Analytics (GA4) property can be displayed in a report.
///
/// For example if a property never logs a `purchase` event, then a query for
/// the `eventName` dimension and `eventCount` metric will not have a row
/// eventName: "purchase" and eventCount: 0.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -2531,6 +2534,13 @@ public string CurrencyCode {
/// If false or unspecified, each row with all metrics equal to 0 will not be
/// returned. If true, these rows will be returned if they are not separately
/// removed by a filter.
///
/// Regardless of this `keep_empty_rows` setting, only data recorded by the
/// Google Analytics (GA4) property can be displayed in a report.
///
/// For example if a property never logs a `purchase` event, then a query for
/// the `eventName` dimension and `eventCount` metric will not have a row
/// eventName: "purchase" and eventCount: 0.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -4660,7 +4670,7 @@ public string Property {
private long limit_;
/// <summary>
/// The number of rows to return. If unspecified, 10,000 rows are returned. The
/// API returns a maximum of 100,000 rows per request, no matter how many you
/// API returns a maximum of 250,000 rows per request, no matter how many you
/// ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// source: google/analytics/data/v1beta/analytics_data_api.proto
// </auto-generated>
// Original file comments:
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -362,8 +362,8 @@ public enum Compatibility {

#region Messages
/// <summary>
/// A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
/// are allowed up to 4 date ranges.
/// A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
/// Requests are allowed up to 4 date ranges.
/// </summary>
public sealed partial class DateRange : pb::IMessage<DateRange>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
Expand Down Expand Up @@ -647,8 +647,8 @@ public void MergeFrom(pb::CodedInputStream input) {
}

/// <summary>
/// A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
/// endMinutesAgo. Requests are allowed up to 2 minute ranges.
/// A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
/// `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
/// </summary>
public sealed partial class MinuteRange : pb::IMessage<MinuteRange>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
Expand Down Expand Up @@ -5900,7 +5900,7 @@ public long Offset {
/// single pivot requests.
///
/// The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
/// must not exceed 100,000. For example, a two pivot request with `limit:
/// must not exceed 250,000. For example, a two pivot request with `limit:
/// 1000` in each pivot will fail because the product is `1,000,000`.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
Expand Down Expand Up @@ -7325,6 +7325,18 @@ public ResponseMetaData Clone() {
/// <summary>
/// If true, indicates some buckets of dimension combinations are rolled into
/// "(other)" row. This can happen for high cardinality reports.
///
/// The metadata parameter dataLossFromOtherRow is populated based on the
/// aggregated data table used in the report. The parameter will be accurately
/// populated regardless of the filters and limits in the report.
///
/// For example, the (other) row could be dropped from the report because the
/// request contains a filter on sessionSource = google. This parameter will
/// still be populated if data loss from other row was present in the input
/// aggregate data used to generate this report.
///
/// To learn more, see [About the (other) row and data
/// sampling](https://support.google.com/analytics/answer/13208658#reports).
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -10124,8 +10136,8 @@ public PropertyQuota Clone() {
public const int TokensPerDayFieldNumber = 1;
private global::Google.Analytics.Data.V1Beta.QuotaStatus tokensPerDay_;
/// <summary>
/// Standard Analytics Properties can use up to 25,000 tokens per day;
/// Analytics 360 Properties can use 250,000 tokens per day. Most requests
/// Standard Analytics Properties can use up to 200,000 tokens per day;
/// Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
/// consume fewer than 10 tokens.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
Expand All @@ -10141,8 +10153,8 @@ public PropertyQuota Clone() {
public const int TokensPerHourFieldNumber = 2;
private global::Google.Analytics.Data.V1Beta.QuotaStatus tokensPerHour_;
/// <summary>
/// Standard Analytics Properties can use up to 5,000 tokens per hour;
/// Analytics 360 Properties can use 50,000 tokens per hour. An API request
/// Standard Analytics Properties can use up to 40,000 tokens per hour;
/// Analytics 360 Properties can use 400,000 tokens per hour. An API request
/// consumes a single number of tokens, and that number is deducted from all of
/// the hourly, daily, and per project hourly quotas.
/// </summary>
Expand Down Expand Up @@ -10210,9 +10222,9 @@ public PropertyQuota Clone() {
public const int TokensPerProjectPerHourFieldNumber = 6;
private global::Google.Analytics.Data.V1Beta.QuotaStatus tokensPerProjectPerHour_;
/// <summary>
/// Analytics Properties can use up to 25% of their tokens per project per
/// hour. This amounts to standard Analytics Properties can use up to 1,250
/// tokens per project per hour, and Analytics 360 Properties can use 12,500
/// Analytics Properties can use up to 35% of their tokens per project per
/// hour. This amounts to standard Analytics Properties can use up to 14,000
/// tokens per project per hour, and Analytics 360 Properties can use 140,000
/// tokens per project per hour. An API request consumes a single number of
/// tokens, and that number is deducted from all of the hourly, daily, and per
/// project hourly quotas.
Expand Down

0 comments on commit 595b907

Please sign in to comment.