diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_report.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_report.proto index 49936d92962..648bce6355c 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_report.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_report.proto @@ -107,14 +107,17 @@ message AdvancedReport { // Specifies how to precompute report metrics. CalculationSpec calculation_spec = 5; - // Specifies how the system track live campaigns. + // Specifies whether and how the system tracks live campaigns. + // + // When live campaign tracking is enabled the system monitors the report's + // underlying Event Groups and appends new data as it becomes available. message LiveCampaignTrackingSpec { // Specifies whether and how to export data when new data arrives. message ExportSpec { // The PageTemplate to use for exporting results // - // The ReportingUnit is taken to be the ReportingUnit associated - // with the entire AdvancedReport. + // When instantiating the template, The ReportingUnit is taken to be + // the reporting_sets of the AdvancedReport. string page_template = 1 [ (google.api.resource_reference) = { type: "reporting.halo-cmm.org/PageTemplate" @@ -125,8 +128,8 @@ message AdvancedReport { // If true, the exported data set will include data from the // report's reporting_interval.start_time to the present. If - // false only new data is included. - bool include_historical_metrics = 2 [ + // false only new data is exported. + bool include_history = 2 [ (google.api.field_behavior) = IMMUTABLE, (google.api.field_behavior) = OPTIONAL ]; @@ -137,10 +140,10 @@ message AdvancedReport { (google.api.field_behavior) = OPTIONAL ]; } - // Specifies that live campaign tracking is enabled, and options for + // Specifies that live campaign tracking is enabled and options for // how to handle newly arriving data. // - // When enab led, metrics are appended as they become available, + // When enabled, metrics are appended as they become available, // and if an export spec is present they are automatically exported as well. LiveCampaignTrackingSpec live_campaign_tracking_spec = 6 [ (google.api.field_behavior) = IMMUTABLE, diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_reports_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_reports_service.proto index fe6dba8d868..846c847907c 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_reports_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/advanced_reports_service.proto @@ -61,6 +61,8 @@ service AdvancedReports { // Updates the `AdvancedReport` with the given resource key. // // Only one in-progress update Operation is allow to exist at a time. + // TODO(@kungfucraig): Discuss - should we add a custom method for extending + // report end time and leave this for simpler updates (e.g. the title)? rpc UpdateAdvancedReport(UpdateAdvancedReportRequest) returns (Operation) { option (google.api.http) = { get: "/v2alpha/{advancedReport.name=measurementConsumers/*/advancedReports/*}" @@ -89,7 +91,7 @@ service AdvancedReports { // Specifies an AdvancedReport query using a PageTemplate and a ReportingUnit. message PageTemplateSpec { - // The PageTemplate to use. + // The PageTemplate to instantiate. string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/event_groups_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/event_groups_service.proto index 71ecab7695d..07ac9d457c8 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/event_groups_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/event_groups_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/event_group.proto"; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/metric_calculation_specs_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/metric_calculation_specs_service.proto index a1d09817c3c..7a82254e925 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/metric_calculation_specs_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/metric_calculation_specs_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/metric_calculation_spec.proto"; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/metrics_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/metrics_service.proto index d4168279f6f..dcfe8826e95 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/metrics_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/metrics_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/metric.proto"; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/page_template.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/page_template.proto index bce021503f8..0a2cf5b45f0 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/page_template.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/page_template.proto @@ -58,7 +58,7 @@ message PageTemplate { ]; // Specifies the Metrics to compute. - MetricSpec metric_spec = 5 [ + PageMetricSpec metric_spec = 5 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/page_templates_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/page_templates_service.proto index d887e6775f5..67b2cf4df10 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/page_templates_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/page_templates_service.proto @@ -114,7 +114,7 @@ message ListPageTemplatesRequest { // Filter criteria. Repeated fields are treated as logical ORs, and multiple // fields are treated as logical ANDs. - // TODO(@kungfucraig): Do we need filters for this? Search by name or + // TODO(@kungfucraig): Discuss - Do we need filters for this? Search by name or // display name could be useful, but should postpone that until it is clear // how these will be used via an UI. message Filter {} diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedule_iterations_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedule_iterations_service.proto index 9f7f3319aaa..d1e50a59ab6 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedule_iterations_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedule_iterations_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/report_schedule_iteration.proto"; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedules_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedules_service.proto index 59c6929fdae..040cfc4e3ab 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedules_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/report_schedules_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/report_schedule.proto"; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/reporting_sets_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/reporting_sets_service.proto index 9ccfdd876bb..195dfedbdb5 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/reporting_sets_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/reporting_sets_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/reporting_set.proto"; diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/reports_service.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/reports_service.proto index bcbe24b12d2..3af93e58831 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/reports_service.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/reports_service.proto @@ -16,9 +16,9 @@ syntax = "proto3"; package wfa.measurement.reporting.v2alpha; -import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/annotations.proto"; import "google/api/resource.proto"; import "wfa/measurement/reporting/v2alpha/report.proto";