@google-analytics/data 5.2.1 → 6.0.0

package/README.md

@@ -8,7 +8,7 @@ This library is considered to be in **preview**. This means it is still a
 work-in-progress and under active development. Any release is subject to
 backwards-incompatible changes at any time.
 
-[![npm version](https://img.shields.io/npm/v/@google-cloud/data.svg)](https://www.npmjs.org/package/@google-cloud/data)
+[![npm version](https://img.shields.io/npm/v/@google-analytics/data.svg)](https://www.npmjs.org/package/@google-analytics/data)
 
 Google Analytics Data API client for Node.js
 
@@ -46,7 +46,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 ### Installing the client library
 
 ```bash
-npm install @google-cloud/data
+npm install @google-analytics/data
 ```
 
 [//]: # "partials.body"
@@ -61,6 +61,7 @@ Samples are in the [`samples/`][homepage_samples] directory. Each sample's `READ
 | create recurring audience list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_recurring_audience_list.js) |
 | create report task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.create_report_task.js) |
 | get audience list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_audience_list.js) |
+| get metadata | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_metadata.js) |
 | get property quotas snapshot | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_property_quotas_snapshot.js) |
 | get recurring audience list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_recurring_audience_list.js) |
 | get report task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.get_report_task.js) |
@@ -70,7 +71,7 @@ Samples are in the [`samples/`][homepage_samples] directory. Each sample's `READ
 | query audience list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.query_audience_list.js) |
 | query report task | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.query_report_task.js) |
 | run funnel report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_funnel_report.js) |
-| sheet export audience list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.sheet_export_audience_list.js) |
+| run report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/alpha_analytics_data.run_report.js) |
 | analytics | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1alpha/snippet_metadata_google.analytics.data.v1alpha.json) |
 | batch run pivot reports | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_pivot_reports.js) |
 | batch run reports | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-data/samples/generated/v1beta/beta_analytics_data.batch_run_reports.js) |
@@ -104,7 +105,7 @@ best-efforts basis with the following warnings:
 Client libraries targeting some end-of-life versions of Node.js are available, and
 can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
 The dist-tags follow the naming convention `legacy-(version)`.
-For example, `npm install @google-cloud/data@legacy-8` installs client libraries
+For example, `npm install @google-analytics/data@legacy-8` installs client libraries
 for versions compatible with Node.js 8.
 
 ## Versioning

package/build/protos/google/analytics/data/v1alpha/analytics_data_api.proto

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -38,10 +38,7 @@ service AlphaAnalyticsData {
   option (google.api.default_host) = "analyticsdata.googleapis.com";
   option (google.api.oauth_scopes) =
       "https://www.googleapis.com/auth/analytics,"
-      "https://www.googleapis.com/auth/analytics.readonly,"
-      "https://www.googleapis.com/auth/drive,"
-      "https://www.googleapis.com/auth/drive.file,"
-      "https://www.googleapis.com/auth/spreadsheets";
+      "https://www.googleapis.com/auth/analytics.readonly";
 
   // Returns a customized funnel report of your Google Analytics event data. The
   // data returned from the API is as a table with columns for the requested
@@ -131,34 +128,6 @@ service AlphaAnalyticsData {
     option (google.api.method_signature) = "name";
   }
 
-  // Exports an audience list of users to a Google Sheet. After creating an
-  // audience, the users are not immediately available for listing. First, a
-  // request to `CreateAudienceList` is necessary to create an audience list of
-  // users, and then second, this method is used to export those users in the
-  // audience list to a Google Sheet.
-  //
-  // See [Creating an Audience
-  // List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
-  // for an introduction to Audience Lists with examples.
-  //
-  // Audiences in Google Analytics 4 allow you to segment your users in the ways
-  // that are important to your business. To learn more, see
-  // https://support.google.com/analytics/answer/9267572.
-  //
-  // This method is introduced at alpha stability with the intention of
-  // gathering feedback on syntax and capabilities before entering beta. To give
-  // your feedback on this API, complete the
-  // [Google Analytics Audience Export API
-  // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
-  rpc SheetExportAudienceList(SheetExportAudienceListRequest)
-      returns (SheetExportAudienceListResponse) {
-    option (google.api.http) = {
-      post: "/v1alpha/{name=properties/*/audienceLists/*}:exportSheet"
-      body: "*"
-    };
-    option (google.api.method_signature) = "name";
-  }
-
   // Gets configuration metadata about a specific audience list. This method
   // can be used to understand an audience list after it has been created.
   //
@@ -331,6 +300,37 @@ service AlphaAnalyticsData {
     };
     option (google.api.method_signature) = "parent";
   }
+
+  // Returns a customized report of your Google Analytics event data. Reports
+  // contain statistics derived from data collected by the Google Analytics
+  // tracking code. The data returned from the API is as a table with columns
+  // for the requested dimensions and metrics. Metrics are individual
+  // measurements of user activity on your property, such as active users or
+  // event count. Dimensions break down metrics across some common criteria,
+  // such as country or event name.
+  rpc RunReport(RunReportRequest) returns (RunReportResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha/{property=properties/*}:runReport"
+      body: "*"
+    };
+  }
+
+  // Returns metadata for dimensions and metrics available in reporting methods.
+  // Used to explore the dimensions and metrics. In this method, a Google
+  // Analytics 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";
+  }
 }
 
 // A request to create a new recurring audience list.
@@ -789,69 +789,6 @@ message QueryAudienceListResponse {
   optional int32 row_count = 3;
 }
 
-// A request to export users in an audience list to a Google Sheet.
-message SheetExportAudienceListRequest {
-  // Required. The name of the audience list to retrieve users from.
-  // Format: `properties/{property}/audienceLists/{audience_list}`
-  string name = 1 [
-    (google.api.field_behavior) = REQUIRED,
-    (google.api.resource_reference) = {
-      type: "analyticsdata.googleapis.com/AudienceList"
-    }
-  ];
-
-  // Optional. The row count of the start row. The first row is counted as row
-  // 0.
-  //
-  // When paging, the first request does not specify offset; or equivalently,
-  // sets offset to 0; the first request returns the first `limit` of rows. The
-  // second request sets offset to the `limit` of the first request; the second
-  // request returns the second `limit` of rows.
-  //
-  // To learn more about this pagination parameter, see
-  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
-  int64 offset = 2 [(google.api.field_behavior) = OPTIONAL];
-
-  // Optional. The number of rows to return. If unspecified, 10,000 rows are
-  // returned. The API returns a maximum of 250,000 rows per request, no matter
-  // how many you ask for. `limit` must be positive.
-  //
-  // The API can also return fewer rows than the requested `limit`, if there
-  // aren't as many dimension values as the `limit`.
-  //
-  // To learn more about this pagination parameter, see
-  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
-  int64 limit = 3 [(google.api.field_behavior) = OPTIONAL];
-}
-
-// The created Google Sheet with the list of users in an audience list.
-message SheetExportAudienceListResponse {
-  // A uri for you to visit in your browser to view the Google Sheet.
-  optional string spreadsheet_uri = 1;
-
-  // An ID that identifies the created Google Sheet resource.
-  optional string spreadsheet_id = 2;
-
-  // The total number of rows in the AudienceList result. `rowCount` is
-  // independent of the number of rows returned in the response, the `limit`
-  // request parameter, and the `offset` request parameter. For example if a
-  // query returns 175 rows and includes `limit` of 50 in the API request, the
-  // response will contain `rowCount` of 175 but only 50 rows.
-  //
-  // To learn more about this pagination parameter, see
-  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
-  optional int32 row_count = 3;
-
-  // Configuration data about AudienceList being exported. Returned to help
-  // interpret the AudienceList in the Google Sheet of this response.
-  //
-  // For example, the AudienceList may have more rows than are present in the
-  // Google Sheet, and in that case, you may want to send an additional sheet
-  // export request with a different `offset` value to retrieve the next page of
-  // rows in an additional Google Sheet.
-  optional AudienceList audience_list = 4;
-}
-
 // Dimension value attributes for the audience user row.
 message AudienceRow {
   // Each dimension value attribute for an audience user. One dimension value
@@ -1302,3 +1239,206 @@ message ListReportTasksResponse {
   // If this field is omitted, there are no subsequent pages.
   optional string next_page_token = 2;
 }
+
+// The request to generate a report.
+message RunReportRequest {
+  // Required. A Google Analytics property identifier whose events are tracked.
+  // Specified in the URL path and not the body. To learn more, see [where to
+  // find your Property
+  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+  // Within a batch request, this property should either be unspecified or
+  // consistent with the batch-level property.
+  //
+  // Example: properties/1234
+  string property = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The dimensions requested and displayed.
+  repeated Dimension dimensions = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The metrics requested and displayed.
+  repeated Metric metrics = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Date ranges of data to read. If multiple date ranges are
+  // requested, each response row will contain a zero based date range index. If
+  // two date ranges overlap, the event data for the overlapping days is
+  // included in the response rows for both date ranges. In a cohort request,
+  // this `dateRanges` must be unspecified.
+  repeated DateRange date_ranges = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Dimension filters let you ask for only specific dimension values
+  // in the report. To learn more, see [Fundamentals of Dimension
+  // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
+  // for examples. Metrics cannot be used in this filter.
+  FilterExpression dimension_filter = 5
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The filter clause of metrics. Applied after aggregating the
+  // report's rows, similar to SQL having-clause. Dimensions cannot be used in
+  // this filter.
+  FilterExpression metric_filter = 6 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The row count of the start row. The first row is counted as row
+  // 0.
+  //
+  // When paging, the first request does not specify offset; or equivalently,
+  // sets offset to 0; the first request returns the first `limit` of rows. The
+  // second request sets offset to the `limit` of the first request; the second
+  // request returns the second `limit` of rows.
+  //
+  // To learn more about this pagination parameter, see
+  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+  int64 offset = 7 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The maximum number of rows to return. If unspecified, 10,000 rows
+  // are returned. The API returns a maximum of 250,000 rows per request, no
+  // matter how many you ask for. `limit` must be positive.
+  //
+  // The API can also return fewer rows than the requested `limit`, if there
+  // aren't as many dimension values as the `limit`. For instance, there are
+  // fewer than 300 possible values for the dimension `country`, so when
+  // reporting on only `country`, you can't get more than 300 rows, even if you
+  // set `limit` to a higher value.
+  //
+  // To learn more about this pagination parameter, see
+  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+  int64 limit = 8 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Aggregation of metrics. Aggregated metric values will be shown in
+  // rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
+  // Aggregates including both comparisons and multiple date ranges will
+  // be aggregated based on the date ranges.
+  repeated MetricAggregation metric_aggregations = 9
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specifies how rows are ordered in the response.
+  // Requests including both comparisons and multiple date ranges will
+  // have order bys applied on the comparisons.
+  repeated OrderBy order_bys = 10 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY".
+  // If the field is empty, the report uses the property's default currency.
+  string currency_code = 11 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Cohort group associated with this request. If there is a cohort
+  // group in the request the 'cohort' dimension must be present.
+  CohortSpec cohort_spec = 12 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. If false or unspecified, each row with all metrics equal to 0
+  // will not be returned. If true, these rows will be returned if they are not
+  // separately removed by a filter.
+  //
+  // Regardless of this `keep_empty_rows` setting, only data recorded by the
+  // Google Analytics property can be displayed in a report.
+  //
+  // For example if a property never logs a `purchase` event, then a query for
+  // the `eventName` dimension and  `eventCount` metric will not have a row
+  // eventName: "purchase" and eventCount: 0.
+  bool keep_empty_rows = 13 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Toggles whether to return the current state of this Google
+  // Analytics property's quota. Quota is returned in
+  // [PropertyQuota](#PropertyQuota).
+  bool return_property_quota = 14 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The configuration of comparisons requested and displayed. The
+  // request only requires a comparisons field in order to receive a comparison
+  // column in the response.
+  repeated Comparison comparisons = 15 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Controls conversion reporting. This field is optional. If this
+  // field is set or any conversion metrics are requested, the report will be a
+  // conversion report.
+  ConversionSpec conversion_spec = 16 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// The response report table corresponding to a request.
+message RunReportResponse {
+  // Describes dimension columns. The number of DimensionHeaders and ordering of
+  // DimensionHeaders matches the dimensions present in rows.
+  repeated DimensionHeader dimension_headers = 1;
+
+  // Describes metric columns. The number of MetricHeaders and ordering of
+  // MetricHeaders matches the metrics present in rows.
+  repeated MetricHeader metric_headers = 2;
+
+  // Rows of dimension value combinations and metric values in the report.
+  repeated Row rows = 3;
+
+  // If requested, the totaled values of metrics.
+  repeated Row totals = 4;
+
+  // If requested, the maximum values of metrics.
+  repeated Row maximums = 5;
+
+  // If requested, the minimum values of metrics.
+  repeated Row minimums = 6;
+
+  // The total number of rows in the query result, regardless of the number of
+  // rows returned in the response. For example if a query returns 175 rows and
+  // includes limit = 50 in the API request, the response will contain row_count
+  // = 175 but only 50 rows.
+  //
+  // To learn more about this pagination parameter, see
+  // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+  int32 row_count = 7;
+
+  // Metadata for the report.
+  ResponseMetaData metadata = 8;
+
+  // This Analytics Property's quota state including this request.
+  PropertyQuota property_quota = 9;
+
+  // Identifies what kind of resource this message is. This `kind` is always the
+  // fixed string "analyticsData#runReport". Useful to distinguish between
+  // response types in JSON.
+  string kind = 10;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  optional string next_page_token = 11;
+}
+
+// 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 property identifier. To learn more, see [where to find
+  // your Property
+  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+  //
+  // Example: properties/1234/metadata
+  //
+  // Set the Property ID to 0 for dimensions and metrics common to all
+  // properties. In this special mode, this method will not return custom
+  // dimensions and metrics.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsdata.googleapis.com/Metadata"
+    }
+  ];
+}
+
+// The dimensions, metrics and comparisons 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 dimension descriptions.
+  repeated DimensionMetadata dimensions = 1;
+
+  // The metric descriptions.
+  repeated MetricMetadata metrics = 2;
+
+  // The comparison descriptions.
+  repeated ComparisonMetadata comparisons = 4;
+
+  // The conversion descriptions.
+  repeated ConversionMetadata conversions = 5;
+}

package/build/protos/google/analytics/data/v1alpha/data.proto

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -156,6 +156,24 @@ message Metric {
   bool invisible = 3;
 }
 
+// Defines an individual comparison. Most requests will include multiple
+// comparisons so that the report compares between the comparisons.
+message Comparison {
+  // Each comparison produces separate rows in the response. In the response,
+  // this comparison is identified by this name. If name is unspecified, we will
+  // use the saved comparisons display name.
+  optional string name = 1;
+
+  oneof one_comparison {
+    // A basic comparison.
+    FilterExpression dimension_filter = 2;
+
+    // A saved comparison identified by the comparison's resource name.
+    // For example, 'comparisons/1234'.
+    string comparison = 3;
+  }
+}
+
 // To express dimension or metric filters. The fields in the same
 // FilterExpression need to be either all dimensions or all metrics.
 message FilterExpression {
@@ -487,6 +505,25 @@ message CohortReportSettings {
   bool accumulate = 1;
 }
 
+// Identifies if the report data is from the standard report data or
+// conversion data
+enum Section {
+  // Should never be specified.
+  SECTION_UNSPECIFIED = 0;
+
+  // The report data is from the standard report data. Google Analytics reports
+  // include acquisition, engagement, and user behavior reports. Reports use
+  // dimensions like session source & landing page; reports use metrics like
+  // sessions, views, and engagement time.
+  SECTION_REPORT = 1;
+
+  // The report data is from the conversion data. The Google Analytics
+  // Advertising section reports on conversion performance. Advertising reports
+  // use dimensions like source & medium; advertising reports use metrics like
+  // all conversions and ads cost.
+  SECTION_ADVERTISING = 2;
+}
+
 // Response's metadata carrying additional information about the report content.
 message ResponseMetaData {
   // The schema restrictions actively enforced in creating this report. To learn
@@ -561,15 +598,18 @@ message ResponseMetaData {
   // Interests](https://support.google.com/analytics/answer/2799357).
   optional bool subject_to_thresholding = 8;
 
-  // If this report's results are
+  // If this report results is
   // [sampled](https://support.google.com/analytics/answer/13331292), this
   // describes the percentage of events used in this report. One
   // `samplingMetadatas` is populated for each date range. Each
-  // `samplingMetadatas` corresponds to a date range in the order that date
-  // ranges were specified in the request.
+  // `samplingMetadatas` corresponds to a date range in order that date ranges
+  // were specified in the request.
   //
   // However if the results are not sampled, this field will not be defined.
   repeated SamplingMetadata sampling_metadatas = 9;
+
+  // Identifies the type of data in the report.
+  Section section = 10;
 }
 
 // Describes a dimension column in the report. Dimensions requested in a report
@@ -1488,8 +1528,8 @@ message FunnelResponseMetadata {
   // [sampled](https://support.google.com/analytics/answer/13331292), this
   // describes what percentage of events were used in this funnel report. One
   // `samplingMetadatas` is populated for each date range. Each
-  // `samplingMetadatas` corresponds to a date range in the order that date
-  // ranges were specified in the request.
+  // `samplingMetadatas` corresponds to a date range in order that date ranges
+  // were specified in the request.
   //
   // However if the results are not sampled, this field will not be defined.
   repeated SamplingMetadata sampling_metadatas = 1;
@@ -1609,3 +1649,166 @@ enum SamplingLevel {
   // https://support.google.com/analytics/answer/10896953.
   UNSAMPLED = 3;
 }
+
+// Controls conversion reporting.
+//
+// <aside class="caution">
+//   This feature may not be available to your Google Analytics property. The
+//   Google Analytics team is actively working to expand this feature to more
+//   properties. Please reach out to your
+//   <a href="https://support.google.com/analytics/gethelp">support team</a> if
+//   you have questions about the eligibility of your property.
+// </aside>
+message ConversionSpec {
+  // Attribution model to use in the Conversion Report
+  enum AttributionModel {
+    // Unspecified attribution model.
+    ATTRIBUTION_MODEL_UNSPECIFIED = 0;
+
+    // Attribution was based on the paid and organic data driven model
+    DATA_DRIVEN = 1;
+
+    // Attribution was based on the paid and organic last click model
+    LAST_CLICK = 2;
+  }
+
+  // The conversion action IDs to include in the report. If empty, all
+  // conversions are included. Valid conversion action IDs can be retrieved from
+  // the `conversion_action` field within the `conversions` list in the
+  // response of the `GetMetadata` method. For example,
+  // 'conversionActions/1234'.
+  repeated string conversion_actions = 1;
+
+  // The attribution model to use in the Conversion Report. If unspecified,
+  // `DATA_DRIVEN` is used.
+  AttributionModel attribution_model = 2;
+}
+
+// Explains a dimension.
+message DimensionMetadata {
+  // This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For
+  // example, `eventName`.
+  string api_name = 1;
+
+  // This dimension's name within the Google Analytics user interface. For
+  // example, `Event name`.
+  string ui_name = 2;
+
+  // Description of how this dimension is used and calculated.
+  string description = 3;
+
+  // Still usable but deprecated names for this dimension. If populated, this
+  // dimension is available by either `apiName` or one of `deprecatedApiNames`
+  // for a period of time. After the deprecation period, the dimension will be
+  // available only by `apiName`.
+  repeated string deprecated_api_names = 4;
+
+  // True if the dimension is custom to this property. This includes user,
+  // event, & item scoped custom dimensions; to learn more about custom
+  // dimensions, see https://support.google.com/analytics/answer/14240153. This
+  // also include custom channel groups; to learn more about custom channel
+  // groups, see https://support.google.com/analytics/answer/13051316.
+  bool custom_definition = 5;
+
+  // The display name of the category that this dimension belongs to. Similar
+  // dimensions and metrics are categorized together.
+  string category = 6;
+
+  // Specifies the Google Analytics sections this dimension applies to.
+  repeated Section sections = 7;
+}
+
+// Explains a metric.
+message MetricMetadata {
+  // Justifications for why this metric is blocked.
+  enum BlockedReason {
+    // Will never be specified in API response.
+    BLOCKED_REASON_UNSPECIFIED = 0;
+
+    // If present, your access is blocked to revenue related metrics for this
+    // property, and this metric is revenue related.
+    NO_REVENUE_METRICS = 1;
+
+    // If present, your access is blocked to cost related metrics for this
+    // property, and this metric is cost related.
+    NO_COST_METRICS = 2;
+  }
+
+  // A metric name. Usable in [Metric](#Metric)'s `name`. For example,
+  // `eventCount`.
+  string api_name = 1;
+
+  // This metric's name within the Google Analytics user interface. For example,
+  // `Event count`.
+  string ui_name = 2;
+
+  // Description of how this metric is used and calculated.
+  string description = 3;
+
+  // Still usable but deprecated names for this metric. If populated, this
+  // metric is available by either `apiName` or one of `deprecatedApiNames`
+  // for a period of time. After the deprecation period, the metric will be
+  // available only by `apiName`.
+  repeated string deprecated_api_names = 4;
+
+  // The type of this metric.
+  MetricType type = 5;
+
+  // The mathematical expression for this derived metric. Can be used in
+  // [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
+  // are not expressions, and for non-expressions, this field is empty.
+  string expression = 6;
+
+  // True if the metric is a custom metric for this property.
+  bool custom_definition = 7;
+
+  // If reasons are specified, your access is blocked to this metric for this
+  // property. API requests from you to this property for this metric will
+  // succeed; however, the report will contain only zeros for this metric. API
+  // requests with metric filters on blocked metrics will fail. If reasons are
+  // empty, you have access to this metric.
+  //
+  // To learn more, see [Access and data-restriction
+  // management](https://support.google.com/analytics/answer/10851388).
+  repeated BlockedReason blocked_reasons = 8;
+
+  // The display name of the category that this metrics belongs to. Similar
+  // dimensions and metrics are categorized together.
+  string category = 9;
+
+  // Specifies the Google Analytics sections this metric applies to.
+  repeated Section sections = 10;
+}
+
+// The metadata for a single comparison.
+message ComparisonMetadata {
+  // This comparison's resource name. Usable in [Comparison](#Comparison)'s
+  // `comparison` field. For example, 'comparisons/1234'.
+  string api_name = 1;
+
+  // This comparison's name within the Google Analytics user interface.
+  string ui_name = 2;
+
+  // This comparison's description.
+  string description = 3;
+}
+
+// The metadata for a single conversion.
+//
+// <aside class="caution">
+//   This feature may not be available to your Google Analytics property. The
+//   Google Analytics team is actively working to expand this feature to more
+//   properties. Please reach out to your
+//   <a href="https://support.google.com/analytics/gethelp">support team</a> if
+//   you have questions about the eligibility of your property.
+// </aside>
+message ConversionMetadata {
+  // The unique identifier of the conversion action. This ID is used to specify
+  // which conversions to include in a report by populating the
+  // `conversion_actions` field in the `ConversionsSpec` of a report request.
+  // For example, 'conversionActions/1234'.
+  string conversion_action = 1;
+
+  // This conversion's name within the Google Analytics user interface.
+  string display_name = 2;
+}