Skip to content

Commit

Permalink
lint and format
Browse files Browse the repository at this point in the history
  • Loading branch information
kungfucraig committed Jan 14, 2025
1 parent eee12b9 commit 1e07d4f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,14 @@ service BasicReports {
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2alpha/{parent=measurementConsumers/*}/basicReports"
body: "basicReport"
body: "basic_report"
};
option (google.api.method_signature) = "parent,basic_report,basic_report_id";
option (google.longrunning.operation_info) = {
response_type: "BasicReport"
metadata_type: "CreateBasicReportOperationMetadata"
};
option (google.api.method_signature) =
"parent,basic_report,basic_report_id";
}

// Returns the `BasicReport` with the given resource key.
Expand Down Expand Up @@ -148,6 +153,11 @@ message CreateBasicReportRequest {
// A random UUID is recommended.
// This request is only idempotent if a `request_id` is provided.
string request_id = 4 [
(google.api.field_info).format = UUID4,
(google.api.field_behavior) = OPTIONAL];
(google.api.field_info).format = UUID4,
(google.api.field_behavior) = OPTIONAL
];
}

// Operation metadata message for `CreateBasicReport`
// TODO(@kungfucraig): Additional details to be provided as the design matures.
message CreateBasicReportOperationMetadata {}
27 changes: 17 additions & 10 deletions src/main/proto/wfa/measurement/reporting/v2alpha/page.proto
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ message PageMetricSpec {
bool population_size = 1 [(google.api.field_behavior) = IMMUTABLE];

// Specifies the set of basic metrics that can be computed for any aspect of
// the reporting_unit (e.g. the whole thing, a single component, intersections,
// etc.). Each element specifies that a particular metric should be included
// in the report output.
// the reporting_unit (e.g. the whole thing, a single component,
// intersections, etc.). Each element specifies that a particular metric
// should be included in the report output.
message BasicMetricSetSpec {
// The reach
bool reach = 1 [(google.api.field_behavior) = IMMUTABLE];
Expand Down Expand Up @@ -145,11 +145,12 @@ message PageMetricSpec {
// and EDP3 and the second element is the incremental reach of EDP1
// with respect to them. Note that it would also be okay to specify
// the components as [EDP3, EDP2, EDP1].
bool stacked_incremental_reach = 2;
bool stacked_incremental_reach = 2
[(google.api.field_behavior) = IMMUTABLE];
}
// The set of metrics to compute for the entire reporting_unit
ReportingUnitMetricSetSpec reporting_unit = 2;

ReportingUnitMetricSetSpec reporting_unit = 2
[(google.api.field_behavior) = IMMUTABLE];
// Metrics for each component of the reporting_unit
message ComponentMetricSetSpec {
// Basic metrics for each item in reporting_unit.components
Expand Down Expand Up @@ -250,14 +251,18 @@ message Page {
// TODO(@kungfucraig): Add EventGroup metadata once it has been
// formally encoded in the EventGroup.
message EventGroupSummary {
// The resource name of an EventGroup
string event_group = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
type: "halo.wfanet.org/EventGroup"
}
];
}
}
// A summary of each EventGroup entailed by the component.
repeated EventGroupSummary event_group_summaries = 3
[(google.api.field_behavior) = IMMUTABLE];
}

// A summary of each component of the reporting_unit reported on
Expand Down Expand Up @@ -320,10 +325,12 @@ message Page {
// 1. reach(rs1)
// 2. reach(rs1+rs2) - reach(rs1)
// 3. reach(rs1+rs2+rs3) - reach(rs1+rs2)
repeated int32 stacked_incremental_reach = 2;
repeated int32 stacked_incremental_reach = 2
[(google.api.field_behavior) = IMMUTABLE];
}
// Metrics for the whole reporting_unit
ReportingUnitMetricSet reporting_unit = 2;
ReportingUnitMetricSet reporting_unit = 2
[(google.api.field_behavior) = IMMUTABLE];

// Metrics for a single component of the reporting_unit.
message ComponentMetricSet {
Expand Down Expand Up @@ -379,5 +386,5 @@ message Page {
}
// The set of results for the Page, one per impression qualification filter
// that was applicable to the page.
repeated Result results = 2;
repeated Result results = 2 [(google.api.field_behavior) = IMMUTABLE];
}

0 comments on commit 1e07d4f

Please sign in to comment.