@google-analytics/data 4.7.0 → 4.8.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.8.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.7.0...data-v4.8.0) (2024-08-09)
+
+
+### Features
+
+* [analytics-data] add the `comparisons` field to the `Metadata` resource ([#5600](https://github.com/googleapis/google-cloud-node/issues/5600)) ([e77b934](https://github.com/googleapis/google-cloud-node/commit/e77b9348a198e3a3e60e71474ac3320273d17f6e))
+
 ## [4.7.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.6.0...data-v4.7.0) (2024-05-21)
 
 

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

@@ -311,6 +311,9 @@ message Metadata {
 
   // The metric descriptions.
   repeated MetricMetadata metrics = 2;
+
+  // The comparison descriptions.
+  repeated ComparisonMetadata comparisons = 4;
 }
 
 // The request to generate a report.
@@ -403,6 +406,11 @@ message RunReportRequest {
   // Toggles whether to return the current state of this Analytics Property's
   // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 14;
+
+  // 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];
 }
 
 // The response report table corresponding to a request.
@@ -515,6 +523,11 @@ message RunPivotReportRequest {
   // Toggles whether to return the current state of this Analytics Property's
   // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 11;
+
+  // Optional. The configuration of comparisons requested and displayed. The
+  // request requires both a comparisons field and a comparisons dimension to
+  // receive a comparison column in the response.
+  repeated Comparison comparisons = 12 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response pivot report table corresponding to a pivot request.

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

@@ -186,6 +186,25 @@ 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;
+
+  // One kind of comparison value
+  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 {
@@ -861,7 +880,11 @@ message DimensionMetadata {
   // available only by `apiName`.
   repeated string deprecated_api_names = 4;
 
-  // True if the dimension is a custom dimension for this property.
+  // 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
@@ -928,6 +951,19 @@ message MetricMetadata {
   string category = 10;
 }
 
+// The metadata for a single comparison.
+message ComparisonMetadata {
+  // This comparison's resource name. Useable 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 compatibility for a single dimension.
 message DimensionCompatibility {
   // The dimension metadata contains the API name for this compatibility

package/build/protos/protos.d.ts

@@ -16477,6 +16477,9 @@ export namespace google {
 
                     /** Metadata metrics */
                     metrics?: (google.analytics.data.v1beta.IMetricMetadata[]|null);
+
+                    /** Metadata comparisons */
+                    comparisons?: (google.analytics.data.v1beta.IComparisonMetadata[]|null);
                 }
 
                 /** Represents a Metadata. */
@@ -16497,6 +16500,9 @@ export namespace google {
                     /** Metadata metrics. */
                     public metrics: google.analytics.data.v1beta.IMetricMetadata[];
 
+                    /** Metadata comparisons. */
+                    public comparisons: google.analytics.data.v1beta.IComparisonMetadata[];
+
                     /**
                      * Creates a new Metadata instance using the specified properties.
                      * @param [properties] Properties to set
@@ -16619,6 +16625,9 @@ export namespace google {
 
                     /** RunReportRequest returnPropertyQuota */
                     returnPropertyQuota?: (boolean|null);
+
+                    /** RunReportRequest comparisons */
+                    comparisons?: (google.analytics.data.v1beta.IComparison[]|null);
                 }
 
                 /** Represents a RunReportRequest. */
@@ -16672,6 +16681,9 @@ export namespace google {
                     /** RunReportRequest returnPropertyQuota. */
                     public returnPropertyQuota: boolean;
 
+                    /** RunReportRequest comparisons. */
+                    public comparisons: google.analytics.data.v1beta.IComparison[];
+
                     /**
                      * Creates a new RunReportRequest instance using the specified properties.
                      * @param [properties] Properties to set
@@ -16936,6 +16948,9 @@ export namespace google {
 
                     /** RunPivotReportRequest returnPropertyQuota */
                     returnPropertyQuota?: (boolean|null);
+
+                    /** RunPivotReportRequest comparisons */
+                    comparisons?: (google.analytics.data.v1beta.IComparison[]|null);
                 }
 
                 /** Represents a RunPivotReportRequest. */
@@ -16980,6 +16995,9 @@ export namespace google {
                     /** RunPivotReportRequest returnPropertyQuota. */
                     public returnPropertyQuota: boolean;
 
+                    /** RunPivotReportRequest comparisons. */
+                    public comparisons: google.analytics.data.v1beta.IComparison[];
+
                     /**
                      * Creates a new RunPivotReportRequest instance using the specified properties.
                      * @param [properties] Properties to set
@@ -19954,6 +19972,121 @@ export namespace google {
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
 
+                /** Properties of a Comparison. */
+                interface IComparison {
+
+                    /** Comparison name */
+                    name?: (string|null);
+
+                    /** Comparison dimensionFilter */
+                    dimensionFilter?: (google.analytics.data.v1beta.IFilterExpression|null);
+
+                    /** Comparison comparison */
+                    comparison?: (string|null);
+                }
+
+                /** Represents a Comparison. */
+                class Comparison implements IComparison {
+
+                    /**
+                     * Constructs a new Comparison.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.analytics.data.v1beta.IComparison);
+
+                    /** Comparison name. */
+                    public name?: (string|null);
+
+                    /** Comparison dimensionFilter. */
+                    public dimensionFilter?: (google.analytics.data.v1beta.IFilterExpression|null);
+
+                    /** Comparison comparison. */
+                    public comparison?: (string|null);
+
+                    /** Comparison _name. */
+                    public _name?: "name";
+
+                    /** Comparison oneComparison. */
+                    public oneComparison?: ("dimensionFilter"|"comparison");
+
+                    /**
+                     * Creates a new Comparison instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns Comparison instance
+                     */
+                    public static create(properties?: google.analytics.data.v1beta.IComparison): google.analytics.data.v1beta.Comparison;
+
+                    /**
+                     * Encodes the specified Comparison message. Does not implicitly {@link google.analytics.data.v1beta.Comparison.verify|verify} messages.
+                     * @param message Comparison message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.analytics.data.v1beta.IComparison, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified Comparison message, length delimited. Does not implicitly {@link google.analytics.data.v1beta.Comparison.verify|verify} messages.
+                     * @param message Comparison message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.analytics.data.v1beta.IComparison, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a Comparison message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns Comparison
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1beta.Comparison;
+
+                    /**
+                     * Decodes a Comparison message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns Comparison
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1beta.Comparison;
+
+                    /**
+                     * Verifies a Comparison message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a Comparison message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns Comparison
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.analytics.data.v1beta.Comparison;
+
+                    /**
+                     * Creates a plain object from a Comparison message. Also converts values to other types if specified.
+                     * @param message Comparison
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.analytics.data.v1beta.Comparison, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this Comparison to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for Comparison
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
                 /** Properties of a FilterExpression. */
                 interface IFilterExpression {
 
@@ -23625,6 +23758,115 @@ export namespace google {
                     }
                 }
 
+                /** Properties of a ComparisonMetadata. */
+                interface IComparisonMetadata {
+
+                    /** ComparisonMetadata apiName */
+                    apiName?: (string|null);
+
+                    /** ComparisonMetadata uiName */
+                    uiName?: (string|null);
+
+                    /** ComparisonMetadata description */
+                    description?: (string|null);
+                }
+
+                /** Represents a ComparisonMetadata. */
+                class ComparisonMetadata implements IComparisonMetadata {
+
+                    /**
+                     * Constructs a new ComparisonMetadata.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.analytics.data.v1beta.IComparisonMetadata);
+
+                    /** ComparisonMetadata apiName. */
+                    public apiName: string;
+
+                    /** ComparisonMetadata uiName. */
+                    public uiName: string;
+
+                    /** ComparisonMetadata description. */
+                    public description: string;
+
+                    /**
+                     * Creates a new ComparisonMetadata instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns ComparisonMetadata instance
+                     */
+                    public static create(properties?: google.analytics.data.v1beta.IComparisonMetadata): google.analytics.data.v1beta.ComparisonMetadata;
+
+                    /**
+                     * Encodes the specified ComparisonMetadata message. Does not implicitly {@link google.analytics.data.v1beta.ComparisonMetadata.verify|verify} messages.
+                     * @param message ComparisonMetadata message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.analytics.data.v1beta.IComparisonMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified ComparisonMetadata message, length delimited. Does not implicitly {@link google.analytics.data.v1beta.ComparisonMetadata.verify|verify} messages.
+                     * @param message ComparisonMetadata message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.analytics.data.v1beta.IComparisonMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a ComparisonMetadata message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns ComparisonMetadata
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1beta.ComparisonMetadata;
+
+                    /**
+                     * Decodes a ComparisonMetadata message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns ComparisonMetadata
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1beta.ComparisonMetadata;
+
+                    /**
+                     * Verifies a ComparisonMetadata message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a ComparisonMetadata message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns ComparisonMetadata
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.analytics.data.v1beta.ComparisonMetadata;
+
+                    /**
+                     * Creates a plain object from a ComparisonMetadata message. Also converts values to other types if specified.
+                     * @param message ComparisonMetadata
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.analytics.data.v1beta.ComparisonMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this ComparisonMetadata to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for ComparisonMetadata
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
                 /** Properties of a DimensionCompatibility. */
                 interface IDimensionCompatibility {