8000 docs: Minor formatting · googleapis/googleapis@9458a5a · GitHub
[go: up one dir, main page]
Skip to content

Commit 9458a5a

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Minor formatting
docs: Add clarifications PiperOrigin-RevId: 553885123
1 parent de4d958 commit 9458a5a

File tree

3 files changed

+59
-26
lines changed

3 files changed

+59
-26
lines changed

‎google/analytics/data/v1beta/analytics_data_api.proto

Lines changed: 26 additions & 12 deletions
8000
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -66,7 +66,8 @@ service BetaAnalyticsData {
6666

6767
// Returns multiple reports in a batch. All reports must be for the same
6868
// GA4 Property.
69-
rpc BatchRunReports(BatchRunReportsRequest) returns (BatchRunReportsResponse) {
69+
rpc BatchRunReports(BatchRunReportsRequest)
70+
returns (BatchRunReportsResponse) {
7071
option (google.api.http) = {
7172
post: "/v1beta/{property=properties/*}:batchRunReports"
7273
body: "*"
@@ -75,7 +76,8 @@ service BetaAnalyticsData {
7576

7677
// Returns multiple pivot reports in a batch. All reports must be for the same
7778
// GA4 Property.
78-
rpc BatchRunPivotReports(BatchRunPivotReportsRequest) returns (BatchRunPivotReportsResponse) {
79+
rpc BatchRunPivotReports(BatchRunPivotReportsRequest)
80+
returns (BatchRunPivotReportsResponse) {
7981
option (google.api.http) = {
8082
post: "/v1beta/{property=properties/*}:batchRunPivotReports"
8183
body: "*"
@@ -108,7 +110,8 @@ service BetaAnalyticsData {
108110
// For a guide to constructing realtime requests & understanding responses,
109111
// see [Creating a Realtime
110112
// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
111-
rpc RunRealtimeReport(RunRealtimeReportRequest) returns (RunRealtimeReportResponse) {
113+
rpc RunRealtimeReport(RunRealtimeReportRequest)
114+
returns (RunRealtimeReportResponse) {
112115
option (google.api.http) = {
113116
post: "/v1beta/{property=properties/*}:runRealtimeReport"
114117
body: "*"
@@ -125,7 +128,8 @@ service BetaAnalyticsData {
125128
//
126129
// The Realtime and Core reports have different compatibility rules. This
127130
// method checks compatibility for Core reports.
128-
rpc CheckCompatibility(CheckCompatibilityRequest) returns (CheckCompatibilityResponse) {
131+
rpc CheckCompatibility(CheckCompatibilityRequest)
132+
returns (CheckCompatibilityResponse) {
129133
option (google.api.http) = {
130134
post: "/v1beta/{property=properties/*}:checkCompatibility"
131135
body: "*"
@@ -144,10 +148,6 @@ message CheckCompatibilityRequest {
144148
// `property` should be the same value as in your `runReport` request.
145149
//
146150
// Example: properties/1234
147-
//
148-
// Set the Property ID to 0 for compatibility checking on dimensions and
149-
// metrics common to all properties. In this special mode, this method will
150-
// not return custom dimensions and metrics.
151151
string property = 1;
152152

153153
// The dimensions in this report. `dimensions` should be the same value as in
@@ -223,7 +223,7 @@ message RunReportRequest {
223223
// must be unspecified.
224224
repeated DateRange date_ranges = 4;
225225

226-
// Dimension filters allow you to ask for only specific dimension values in
226+
// Dimension filters let you ask for only specific dimension values in
227227
// the report. To learn more, see [Fundamentals of Dimension
228228
// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
229229
// for examples. Metrics cannot be used in this filter.
@@ -245,7 +245,7 @@ message RunReportRequest {
245245
int64 offset = 7;
246246

247247
// The number of rows to return. If unspecified, 10,000 rows are returned. The
248-
// API returns a maximum of 100,000 rows per request, no matter how many you
248+
// API returns a maximum of 250,000 rows per request, no matter how many you
249249
// ask for. `limit` must be positive.
250250
//
251251
// The API can also return fewer rows than the requested `limit`, if there
@@ -276,6 +276,13 @@ message RunReportRequest {
276276
// If false or unspecified, each row with all metrics equal to 0 will not be
277277
// returned. If true, these rows will be returned if they are not separately
278278
// removed by a filter.
279+
//
280+
// Regardless of this `keep_empty_rows` setting, only data recorded by the
281+
// Google Analytics (GA4) property can be displayed in a report.
282+
//
283+
// For example if a property never logs a `purchase` event, then a query for
284+
// the `eventName` dimension and `eventCount` metric will not have a row
285+
// eventName: "purchase" and eventCount: 0.
279286
bool keep_empty_rows = 13;
280287

281288
// Toggles whether to return the current state of this Analytics Property's
@@ -381,6 +388,13 @@ message RunPivotReportRequest {
381388
// If false or unspecified, each row with all metrics equal to 0 will not be
382389
// returned. If true, these rows will be returned if they are not separately
383390
// removed by a filter.
391+
//
392+
// Regardless of this `keep_empty_rows` setting, only data recorded by the
393+
// Google Analytics (GA4) property can be displayed in a report.
394+
//
395+
// For example if a property never logs a `purchase` event, then a query for
396+
// the `eventName` dimension and `eventCount` metric will not have a row
397+
// eventName: "purchase" and eventCount: 0.
384398
bool keep_empty_rows = 10;
385399

386400
// Toggles whether to return the current state of this Analytics Property's
@@ -560,7 +574,7 @@ message RunRealtimeReportRequest {
560574
FilterExpression metric_filter = 5;
561575

562576
// The number of rows to return. If unspecified, 10,000 rows are returned. The
563-
// API returns a maximum of 100,000 rows per request, no matter how many you
577+
// API returns a maximum of 250,000 rows per request, no matter how many you
564578
// ask for. `limit` must be positive.
565579
//
566< 1E80 /code>580
// The API can also return fewer rows than the requested `limit`, if there

‎google/analytics/data/v1beta/analyticsdata_v1beta.yaml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ apis:
77
- name: google.analytics.data.v1beta.BetaAnalyticsData
88

99
documentation:
10-
summary: Accesses report data in Google Analytics.
10+
summary: |-
11+
Accesses report data in Google Analytics. Warning: Creating multiple
12+
Customer Applications, Accounts, or Projects to simulate or act as a
13+
single Customer Application, Account, or Project (respectively) or to
14+
circumvent Service-specific usage limits or quotas is a direct violation
15+
of Google Cloud Platform Terms of Service as well as Google APIs Terms of
16+
Service. These actions can result in immediate termination of your GCP
17+
project(s) without any warning.
1118
1219
backend:
1320
rules:

‎google/analytics/data/v1beta/data.proto

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -21,8 +21,8 @@ option java_multiple_files = true;
2121
option java_outer_classname = "ReportingApiProto";
2222
option java_package = "com.google.analytics.data.v1beta";
2323

24-
// A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
25-
// are allowed up to 4 date ranges.
24+
// A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
25+
// Requests are allowed up to 4 date ranges.
2626
message DateRange {
2727
// The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
2828
// be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
@@ -43,8 +43,8 @@ message DateRange {
4343
string name = 3;
4444
}
4545

46-
// A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
47-
// endMinutesAgo. Requests are allowed up to 2 minute ranges.
46+
// A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
47+
// `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
4848
message MinuteRange {
4949
// The inclusive start minute for the query as a number of minutes before now.
5050
// For example, `"startMinutesAgo": 29` specifies the report should include
@@ -420,7 +420,7 @@ message Pivot {
420420
// single pivot requests.
421421
//
422422
// The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
423-
// must not exceed 100,000. For example, a two pivot request with `limit:
423+
// must not exceed 250,000. For example, a two pivot request with `limit:
424424
// 1000` in each pivot will fail because the product is `1,000,000`.
425425
int64 limit = 4;
426426

@@ -581,6 +581,18 @@ message ResponseMetaData {
581581

582582
// If true, indicates some buckets of dimension combinations are rolled into
583583
// "(other)" row. This can happen for high cardinality reports.
584+
//
585+
// The metadata parameter dataLossFromOtherRow is populated based on the
586+
// aggregated data table used in the report. The parameter will be accurately
587+
// populated regardless of the filters and limits in the report.
588+
//
589+
// For example, the (other) row could be dropped from the report because the
590+
// request contains a filter on sessionSource = google. This parameter will
591+
// still be populated if data loss from other row was present in the input
592+
// aggregate data used to generate this report.
593+
//
594+
// To learn more, see [About the (other) row and data
595+
// sampling](https://support.google.com/analytics/answer/13208658#reports).
584596
bool data_loss_from_other_row = 3;
585597

586598
// Describes the schema restrictions actively enforced in creating this
@@ -739,13 +751,13 @@ message NumericValue {
739751
// property is exhausted, all requests to that property will return Resource
740752
// Exhausted errors.
741753
message PropertyQuota {
742-
// Standard Analytics Properties can use up to 25,000 tokens per day;
743-
// Analytics 360 Properties can use 250,000 tokens per day. Most requests
754+
// Standard Analytics Properties can use up to 200,000 tokens per day;
755+
// Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
744756
// consume fewer than 10 tokens.
745757
QuotaStatus tokens_per_day = 1;
746758

747-
// Standard Analytics Properties can use up to 5,000 tokens per hour;
748-
// Analytics 360 Properties can use 50,000 tokens per hour. An API request
759+
// Standard Analytics Properties can use up to 40,000 tokens per hour;
760+
// Analytics 360 Properties can use 400,000 tokens per hour. An API request
749761
// consumes a single number of tokens, and that number is deducted from all of
750762
// the hourly, daily, and per project hourly quotas.
751763
QuotaStatus tokens_per_hour = 2;
@@ -765,9 +777,9 @@ message PropertyQuota {
765777
// thresholded dimensions.
766778
QuotaStatus potentially_thresholded_requests_per_hour = 5;
767779

768-
// Analytics Properties can use up to 25% of their tokens per project per
769-
// hour. This amounts to standard Analytics Properties can use up to 1,250
770-
// tokens per project per hour, and Analytics 360 Properties can use 12,500
780+
// Analytics Properties can use up to 35% of their tokens per project per
781+
// hour. This amounts to standard Analytics Properties can use up to 14,000
782+
// tokens per project per hour, and Analytics 360 Properties can use 140,000
771783
// tokens per project per hour. An API request consumes a single number of
772784
// tokens, and that number is deducted from all of the hourly, daily, and per
773785
// project hourly quotas.

0 commit comments

Comments
 (0)
0