From 4f31b779e67d33bdeec73070c496919e2d4a6b47 Mon Sep 17 00:00:00 2001 From: kungfucraig Date: Fri, 3 Jan 2025 19:25:48 +0000 Subject: [PATCH] updated from review --- .../reporting/v2alpha/basic_report.proto | 8 ++--- .../impression_qualification_filter.proto | 2 +- .../v2alpha/metric_frequency_spec.proto | 4 +-- .../measurement/reporting/v2alpha/page.proto | 32 +++++++++++++------ 4 files changed, 29 insertions(+), 17 deletions(-) diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/basic_report.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/basic_report.proto index 2589e19f77..0c6d7a9b37 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/basic_report.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/basic_report.proto @@ -60,9 +60,8 @@ message BasicReport { (google.api.field_behavior) = IMMUTABLE ]; - // The set of Media Types to filter the campaign_group on. - // - // These are applied as to the campaign group disjunctively. + // The set of Media Types to report on. If empty report on all + // MediaTypes. repeated MediaType media_types = 5 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE @@ -84,8 +83,7 @@ message BasicReport { (google.api.field_behavior) = REQUIRED ]; - // The results for each Page Definitions in the same order as the definitions. - // + // The result for each item in `page_specs` in the same order. repeated PageResult page_results = 8 [ (google.api.field_behavior) = IMMUTABLE, (google.api.field_behavior) = OUTPUT_ONLY diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/impression_qualification_filter.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/impression_qualification_filter.proto index 9831043258..35c1f28867 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/impression_qualification_filter.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/impression_qualification_filter.proto @@ -26,7 +26,7 @@ option java_outer_classname = "ImpressionQualificationFilterProto"; // Resource representing an Impression Qualification Filter // -// An ImpressionQualificationFilter (IRF) is a named collection of +// An ImpressionQualificationFilter (IQF) is a named collection of // ImpressionQualificationFilterSpecs where there is at most // one spec per MediaType. For example, an IQF to filter all measurable // impressions for VIDEO and DISPLAY would provide one spec for diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/metric_frequency_spec.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/metric_frequency_spec.proto index 2ab47b1910..26d0d22f74 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/metric_frequency_spec.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/metric_frequency_spec.proto @@ -38,8 +38,8 @@ message MetricFrequencySpec { (google.api.field_behavior) = IMMUTABLE ]; } - // Report metrics weekly + // Whether to report metrics weekly Weekly weekly = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Report metrics across the entire reporting_interval + // Whether to report metrics across the entire `reporting_interval` bool total = 2 [(google.api.field_behavior) = IMMUTABLE]; } diff --git a/src/main/proto/wfa/measurement/reporting/v2alpha/page.proto b/src/main/proto/wfa/measurement/reporting/v2alpha/page.proto index 221153af91..1cd87188de 100644 --- a/src/main/proto/wfa/measurement/reporting/v2alpha/page.proto +++ b/src/main/proto/wfa/measurement/reporting/v2alpha/page.proto @@ -270,7 +270,7 @@ message PageMetricSpec { [(google.api.field_behavior) = IMMUTABLE]; } -// Defines a Page of results +// Specification for a Page of results. message PageSpec { // The title of the page string title = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -370,7 +370,7 @@ message Page { // The k+ reach where the index is frequency - 1. repeated int32 k_plus_reach = 3 [(google.api.field_behavior) = IMMUTABLE]; - // The perecent k+ reach + // The percent k+ reach repeated float percent_k_plus_reach = 4 [(google.api.field_behavior) = IMMUTABLE]; // The frequency historam where the index is frequency-1 @@ -414,7 +414,7 @@ message Page { [(google.api.field_behavior) = IMMUTABLE]; // The unique reach - int32 unique_rech = 2 [(google.api.field_behavior) = IMMUTABLE]; + int32 unique_reach = 2 [(google.api.field_behavior) = IMMUTABLE]; // The count of impressions associated with the unique reach // Phase III @@ -468,10 +468,24 @@ message Page { // See the definition of `ReportingImpressionQualificationFilter` for details // on what it means for a filter to be active. message PageResult { - // A map of the name of the impression qualification filter used to compute a - // Page of results to that Page. - // - // This is either the resource name of an ImpressionQualificationResource or - // the string "custom" indicating that custom filters were applied. - map page = 1 [(google.api.field_behavior) = IMMUTABLE]; + // Stores a Page of results along with the impression qualification filter + // that was applied while computing it. + message PageAndFilter { + oneof filter { + // The ImpressionQualificationFilter used to filter the impressions + string impression_qualification_filter = 1 [ + (google.api.resource_reference) = { + type: "reporting.halo-cmm.org/ImpressionQualificationFilter" + }, + (google.api.field_behavior) = IMMUTABLE + ]; + // Specifies that a custom filter was used to filter the impressions + bool custom = 2 [(google.api.field_behavior) = IMMUTABLE]; + } + // The Page of results + Page page = 3 [(google.api.field_behavior) = IMMUTABLE]; + } + // Stores each Page of results along with the impression qualification filter + // used to compute it. + repeated PageAndFilter pages = 1 [(google.api.field_behavior) = IMMUTABLE]; }