Skip to content

Commit

Permalink
feat: add GetPropertyQuotasSnapshot method to the Data API v1alpha
Browse files Browse the repository at this point in the history
feat: add `PropertyQuotasSnapshot` type to the Data API v1alpha
docs: update the documentation for the `CreateReportTask` method

PiperOrigin-RevId: 676527881
  • Loading branch information
Google APIs authored and copybara-github committed Sep 19, 2024
1 parent e88eeaa commit 923b6f3
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 9 deletions.
1 change: 0 additions & 1 deletion google/analytics/data/v1alpha/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,6 @@ load(

csharp_proto_library(
name = "data_csharp_proto",
extra_opts = [],
deps = [":data_proto"],
)

Expand Down
60 changes: 55 additions & 5 deletions google/analytics/data/v1alpha/analytics_data_api.proto
Original file line number Diff line number Diff line change
Expand Up @@ -266,10 +266,26 @@ service AlphaAnalyticsData {
option (google.api.method_signature) = "parent";
}

// Get all property quotas organized by quota category for a given property.
// This will charge 1 property quota from the category with the most quota.
rpc GetPropertyQuotasSnapshot(GetPropertyQuotasSnapshotRequest)
returns (PropertyQuotasSnapshot) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/propertyQuotasSnapshot}"
};
option (google.api.method_signature) = "name";
}

// Initiates the creation of a report task. This method quickly
// returns a report task and initiates a long running
// asynchronous request to form a customized report of your Google Analytics
// event data.
//
// A report task will be retained and available for querying for 72 hours
// after it has been created.
//
// A report task created by one user can be listed and queried by all users
// who have access to the property.
rpc CreateReportTask(CreateReportTaskRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
Expand Down Expand Up @@ -514,6 +530,40 @@ message ListRecurringAudienceListsResponse {
optional string next_page_token = 2;
}

// A request to return the PropertyQuotasSnapshot for a given category.
message GetPropertyQuotasSnapshotRequest {
// Required. Quotas from this property will be listed in the response.
// Format: `properties/{property}/propertyQuotasSnapshot`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
}
];
}

// Current state of all Property Quotas organized by quota category.
message PropertyQuotasSnapshot {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
pattern: "properties/{property}/propertyQuotasSnapshot"
plural: "propertyQuotasSnapshots"
singular: "propertyQuotasSnapshot"
};

// Identifier. The property quota snapshot resource name.
string name = 4 [(google.api.field_behavior) = IDENTIFIER];

// Property Quota for core property tokens
PropertyQuota core_property_quota = 1;

// Property Quota for realtime property tokens
PropertyQuota realtime_property_quota = 2;

// Property Quota for funnel property tokens
PropertyQuota funnel_property_quota = 3;
}

// A request to retrieve configuration metadata about a specific audience list.
message GetAudienceListRequest {
// Required. The audience list resource name.
Expand Down Expand Up @@ -844,9 +894,9 @@ message RunFunnelReportRequest {
TRENDED_FUNNEL = 2;
}

// Optional. A Google Analytics GA4 property identifier whose events are
// tracked. Specified in the URL path and not the body. To learn more, see
// [where to find your Property
// Optional. A Google Analytics property identifier whose events are tracked.
// Specified in the URL path and not the body. To learn more, see [where to
// find your Property
// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
// Within a batch request, this property should either be unspecified or
// consistent with the batch-level property.
Expand Down Expand Up @@ -1030,7 +1080,7 @@ message ReportTask {
// 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.
// Google Analytics 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
Expand Down Expand Up @@ -1104,7 +1154,7 @@ message ReportTask {
}

// Output only. Identifier. The report task resource name assigned during
// creation. Format: `properties/{property}/reportTasks/{report_task}`
// creation. Format: "properties/{property}/reportTasks/{report_task}"
string name = 1 [
(google.api.field_behavior) = IDENTIFIER,
(google.api.field_behavior) = OUTPUT_ONLY
Expand Down
6 changes: 3 additions & 3 deletions google/analytics/data/v1alpha/data.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1107,7 +1107,7 @@ enum EventExclusionDuration {
// Another segment might be users who purchase a particular line of products or
// who visit a specific part of your site or trigger certain events in your app.
//
// To learn more, see [GA4 Segment
// To learn more, see [Segment
// Builder](https://support.google.com/analytics/answer/9304353).
message Segment {
// The name for this segment. If unspecified, segments are named "Segment".
Expand Down Expand Up @@ -1561,8 +1561,8 @@ enum MetricType {
TYPE_KILOMETERS = 13;
}

// Categories of data that you may be restricted from viewing on certain GA4
// properties.
// Categories of data that you may be restricted from viewing on certain
// Google Analytics properties.
enum RestrictedMetricType {
// Unspecified type.
RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0;
Expand Down

0 comments on commit 923b6f3

Please sign in to comment.