Skip to content

Commit

Permalink
update documentation and EG summary
Browse files Browse the repository at this point in the history
  • Loading branch information
kungfucraig committed Jan 9, 2025
1 parent 3739a5b commit 1fd235e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ message ListBasicReportsRequest {

// Response message for `ListBasicReports` method.
message ListBasicReportsResponse {
// The Basic Reports that met the filter criteria
// The BasicReports that met the filter criteria
repeated BasicReport basic_reports = 1
[(google.api.field_behavior) = OPTIONAL];

Expand All @@ -133,14 +133,14 @@ message CreateBasicReportRequest {
}
];

// The ID to use for the Basic Report, which will become the final component
// of the Basic Report's resource name.
// The ID to use for the BasicReport, which will become the final component
// of the BasicReport's resource name.
//
// This must conform to RFC 1034, with the additional restriction that all
// letters must be lower-case.
string page_template_id = 2 [(google.api.field_behavior) = REQUIRED];
string basic_report_id = 2 [(google.api.field_behavior) = REQUIRED];

// The Basic Report to create.
// The BasicReport to create.
BasicReport basic_report = 3;

// A unique identifier for this request. Restricted to 36 ASCII characters.
Expand Down
41 changes: 17 additions & 24 deletions src/main/proto/wfa/measurement/reporting/v2alpha/page.proto
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ message PageMetricSpec {

// Metrics to be computed over the entire reporting_unit
message ReportingUnitMetricSetSpec {
// Metrics for the union of the items in the reporting)unit
// Metrics for the union of the items in the reporting_unit
BasicMetricSetSpec basic = 1 [(google.api.field_behavior) = IMMUTABLE];

// Compute a stacked incremental reach result for the reporting_unit
Expand All @@ -126,11 +126,11 @@ message PageMetricSpec {
// field is "rs1, rs2, rs3" then the following are reported:
// 1. The reach of rs1
// 2. The incremental reach of (rs1+rs2) over rs1
// (i.e. the unique contribution of rs2 with respect to rs2)
// (i.e. the unique contribution of rs2 with respect to rs1)
// 3. The incremental reach of (rs1+rs2+rs3) over (rs1+rs2)
// (i.e. the unique contribution of rs3 with respect to rs1 and rs2.
//
// In the case a output for a category of components is desired, this
// In the case an output for a category of components is desired, this
// can be achieved by first grouping the components by category. Then
// once the output is provided the reach values for the components in the
// category can be summed.
Expand All @@ -149,51 +149,44 @@ message PageMetricSpec {
// The set of metrics to compute for the entire reporting_unit
ReportingUnitMetricSetSpec reporting_unit = 2;

// Compute metrics that apply to each unit of the reporting_unit_spec
// with respect to all others.
// Metrics for each component of the reporting_unit
message ComponentMetricSetSpec {
// The basic metrics for each ReportingUnit.unit
// Basic metrics for each item in reporting_unit.components
BasicMetricSetSpec basic = 1 [(google.api.field_behavior) = IMMUTABLE];

// Compute the unique reach of each reporting unit in the
// reporting_unit_spec with respect to all other reporting units.
//
// For example if reporting_sets=[RS1, RS2, RS3] the unique reach of
// RS1, RS2, and RS3 are computed.
//
// It is an error to specify this if only a single reporting unit is
// specified since it is the same thing as requesting union.reach.
// The unique reach of each item in reporting_unit.components
// with respect to all other components
bool unique_reach = 2 [(google.api.field_behavior) = IMMUTABLE];
}
// If reporting_unit.component is of size 1 the metrics computed for the
// component are identical to those computed for the union. Specifying this
// value is not recommended in this case.
// If reporting_unit.components is of size 1 the metrics computed for the
// component are identical to those computed for the entire reporting_unit.
// Specifying this value is not recommended in that case.
ComponentMetricSetSpec component = 3
[(google.api.field_behavior) = IMMUTABLE];

// Request overlaps (i.e. intersections) of the various combinations
// of reporting_unit components
// Metrics for the intersections (aka overlaps) of the n-way combinations
// of reporting_unit.components
message ComponentIntersectionMetricSetSpec {
// The number of components that contribute to the intersection.
//
// For example, a value of 2 will provide all 2-way intersections of
// the reporting_unit_spec. A value of 2 and 3 will provide both the
// the reporting_unit.components A value of 2 and 3 will provide both the
// 2 and 3 way intersections.
//
// The max value is the number of distrinct reporting
// units in the reporting_unit
// The minimum value is one and the the max value is the number of
// distinct reporting units in reporting_unit.components
repeated int32 contributor_count = 1 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = REQUIRED
];

// The set of metrics to be computed for each intersection
// Metrics for each intersection
BasicMetricSetSpec basic = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = REQUIRED
];
}
// Compute n-way intersections
// Metrics for n-way intersections
ComponentIntersectionMetricSetSpec component_intersection = 4
[(google.api.field_behavior) = IMMUTABLE];
}
Expand Down

0 comments on commit 1fd235e

Please sign in to comment.