feat: added GetMetadata method for metadata including custom dimensions and metrics.

Google APIs · copybara-github · commit 7e400b0d3a81 · 2020-10-20T12:57:17.000-07:00
PiperOrigin-RevId: 338118656
diff --git a/gapic/metadata/gapic_metadata.proto b/gapic/metadata/gapic_metadata.proto
diff --git a/google/analytics/data/v1alpha/BUILD.bazel b/google/analytics/data/v1alpha/BUILD.bazel
@@ -28,6 +28,7 @@ proto_library(
         "//google/api:annotations_proto",
         "//google/api:client_proto",
         "//google/api:field_behavior_proto",
+        "//google/api:resource_proto",
     ],
 )
 
@@ -164,6 +165,7 @@ moved_proto_library(
         "//google/api:annotations_proto",
         "//google/api:client_proto",
         "//google/api:field_behavior_proto",
+        "//google/api:resource_proto",
     ],
 )
 
diff --git a/google/analytics/data/v1alpha/analytics_data_api.proto b/google/analytics/data/v1alpha/analytics_data_api.proto
@@ -20,6 +20,7 @@ import "google/analytics/data/v1alpha/data.proto";
 import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1alpha;data";
 option java_multiple_files = true;
@@ -88,6 +89,40 @@ service AlphaAnalyticsData {
       get: "/v1alpha/universalMetadata"
     };
   }
+
+  // Returns metadata for dimensions and metrics available in reporting methods.
+  // Used to explore the dimensions and metrics. In this method, a Google
+  // Analytics App + Web Property Identifier is specified in the request, and
+  // the metadata response includes Custom dimensions and metrics as well as
+  // Universal metadata.
+  //
+  // For example if a custom metric with parameter name `levels_unlocked` is
+  // registered to a property, the Metadata response will contain
+  // `customEvent:levels_unlocked`. Universal metadata are dimensions and
+  // metrics applicable to any property such as `country` and `totalUsers`.
+  rpc GetMetadata(GetMetadataRequest) returns (Metadata) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=properties/*/metadata}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+}
+
+// The dimensions and metrics currently accepted in reporting methods.
+message Metadata {
+  option (google.api.resource) = {
+    type: "analyticsdata.googleapis.com/Metadata"
+    pattern: "properties/{property}/metadata"
+  };
+
+  // Resource name of this metadata.
+  string name = 3;
+
+  // The dimensions descriptions.
+  repeated DimensionMetadata dimensions = 1;
+
+  // The metric descriptions.
+  repeated MetricMetadata metrics = 2;
 }
 
 // The request to generate a report.
@@ -353,3 +388,18 @@ message UniversalMetadata {
   // The metric descriptions.
   repeated MetricMetadata metrics = 2;
 }
+
+// Request for a property's dimension and metric metadata.
+message GetMetadataRequest {
+  // Required. The resource name of the metadata to retrieve. This name field is
+  // specified in the URL path and not URL parameters. Property is a numeric
+  // Google Analytics App + Web Property identifier.
+  //
+  // Example: properties/1234/metadata
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsdata.googleapis.com/Metadata"
+    }
+  ];
+}
diff --git a/google/analytics/data/v1alpha/data.proto b/google/analytics/data/v1alpha/data.proto
@@ -674,6 +674,30 @@ enum MetricType {
   // A duration of seconds; a special floating point type.
   TYPE_SECONDS = 4;
 
+  // A duration in milliseconds; a special floating point type.
+  TYPE_MILLISECONDS = 5;
+
+  // A duration in minutes; a special floating point type.
+  TYPE_MINUTES = 6;
+
+  // A duration in hours; a special floating point type.
+  TYPE_HOURS = 7;
+
+  // A custom metric of standard type; a special floating point type.
+  TYPE_STANDARD = 8;
+
   // An amount of money; a special floating point type.
   TYPE_CURRENCY = 9;
+
+  // A length in feet; a special floating point type.
+  TYPE_FEET = 10;
+
+  // A length in miles; a special floating point type.
+  TYPE_MILES = 11;
+
+  // A length in meters; a special floating point type.
+  TYPE_METERS = 12;
+
+  // A length in kilometers; a special floating point type.
+  TYPE_KILOMETERS = 13;
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ proto_library(`
`28`	`28`	`"//google/api:annotations_proto",`
`29`	`29`	`"//google/api:client_proto",`
`30`	`30`	`"//google/api:field_behavior_proto",`
	`31`	`+ "//google/api:resource_proto",`
`31`	`32`	`],`
`32`	`33`	`)`
`33`	`34`
`@@ -164,6 +165,7 @@ moved_proto_library(`
`164`	`165`	`"//google/api:annotations_proto",`
`165`	`166`	`"//google/api:client_proto",`
`166`	`167`	`"//google/api:field_behavior_proto",`
	`168`	`+ "//google/api:resource_proto",`
`167`	`169`	`],`
`168`	`170`	`)`
`169`	`171`