From 41818c6eb42aa3551fc2a326208f9cc083cb1953 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Oct 2022 07:20:47 +0000 Subject: [PATCH] feat(analyticsadmin): update the api #### analyticsadmin:v1alpha The following keys were added: - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.expandedDataSet.$ref (Total Keys: 1) - schemas.GoogleAnalyticsAdminV1alphaExpandedDataSet (Total Keys: 37) --- docs/dyn/analyticsadmin_v1alpha.accounts.html | 68 ++++++++ .../documents/analyticsadmin.v1alpha.json | 149 +++++++++++++++++- 2 files changed, 216 insertions(+), 1 deletion(-) diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 4a8b6f78f7c..2c61932e574 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -427,6 +427,40 @@

Method Details

"name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }, + "expandedDataSet": { # A resource message representing a GA4 ExpandedDataSet. # A snapshot of an ExpandedDataSet resource in change history. + "dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data. + "description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars. + "dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the change of encountering `other row`. + "andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression. + "filterExpressions": [ # A list of ExpandedDataSet filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression + ], + }, + "filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression. + "fieldName": "A String", # Required. The dimension name to filter. + "inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options. + "caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true. + "values": [ # Required. The list of possible string values to match against. Must be non-empty. + "A String", + ], + }, + "stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern. + "caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS. + "matchType": "A String", # Required. The match type for the string filter. + "value": "A String", # Required. The string value to be matched against. + }, + }, + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression. + }, + "dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. + "A String", + ], + "displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars. + "metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names. + "A String", + ], + "name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set} + }, "firebaseLink": { # A link between a GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 @@ -564,6 +598,40 @@

Method Details

"name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID "validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. }, + "expandedDataSet": { # A resource message representing a GA4 ExpandedDataSet. # A snapshot of an ExpandedDataSet resource in change history. + "dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data. + "description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars. + "dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the change of encountering `other row`. + "andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression. + "filterExpressions": [ # A list of ExpandedDataSet filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression + ], + }, + "filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression. + "fieldName": "A String", # Required. The dimension name to filter. + "inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options. + "caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true. + "values": [ # Required. The list of possible string values to match against. Must be non-empty. + "A String", + ], + }, + "stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern. + "caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS. + "matchType": "A String", # Required. The match type for the string filter. + "value": "A String", # Required. The string value to be matched against. + }, + }, + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression. + }, + "dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. + "A String", + ], + "displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars. + "metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names. + "A String", + ], + "name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set} + }, "firebaseLink": { # A link between a GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history. "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index a8aa917481d..c838653fe38 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -2956,7 +2956,7 @@ } } }, - "revision": "20221010", + "revision": "20221017", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -4151,6 +4151,10 @@ "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal", "description": "A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history." }, + "expandedDataSet": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSet", + "description": "A snapshot of an ExpandedDataSet resource in change history." + }, "firebaseLink": { "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink", "description": "A snapshot of a FirebaseLink resource in change history." @@ -4664,6 +4668,149 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaExpandedDataSet": { + "description": "A resource message representing a GA4 ExpandedDataSet.", + "id": "GoogleAnalyticsAdminV1alphaExpandedDataSet", + "properties": { + "dataCollectionStartTime": { + "description": "Output only. Time when expanded data set began (or will begin) collecing data.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the ExpandedDataSet. Max 50 chars.", + "type": "string" + }, + "dimensionFilterExpression": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression", + "description": "Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the change of encountering `other row`." + }, + "dimensionNames": { + "description": "Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the ExpandedDataSet. Max 200 chars.", + "type": "string" + }, + "metricNames": { + "description": "Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaExpandedDataSetFilter": { + "description": "A specific filter for a single dimension", + "id": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilter", + "properties": { + "fieldName": { + "description": "Required. The dimension name to filter.", + "type": "string" + }, + "inListFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter", + "description": "A filter for a string dimension that matches a particular list of options." + }, + "stringFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter", + "description": "A filter for a string-type dimension that matches a particular pattern." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression": { + "description": "A logical expression of EnhancedDataSet dimension filters.", + "id": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression", + "properties": { + "andGroup": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList", + "description": "A list of expressions to be AND\u2019ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression." + }, + "filter": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilter", + "description": "A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression." + }, + "notExpression": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression", + "description": "A filter expression to be NOT'ed (i.e., inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList": { + "description": "A list of ExpandedDataSet filter expressions.", + "id": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList", + "properties": { + "filterExpressions": { + "description": "A list of ExpandedDataSet filter expressions.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter": { + "description": "A filter for a string dimension that matches a particular list of options.", + "id": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter", + "properties": { + "caseSensitive": { + "description": "Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.", + "type": "boolean" + }, + "values": { + "description": "Required. The list of possible string values to match against. Must be non-empty.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter": { + "description": "A filter for a string-type dimension that matches a particular pattern.", + "id": "GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter", + "properties": { + "caseSensitive": { + "description": "Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.", + "type": "boolean" + }, + "matchType": { + "description": "Required. The match type for the string filter.", + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "EXACT", + "CONTAINS" + ], + "enumDescriptions": [ + "Unspecified", + "Exact match of the string value.", + "Contains the string value." + ], + "type": "string" + }, + "value": { + "description": "Required. The string value to be matched against.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaFirebaseLink": { "description": "A link between a GA4 property and a Firebase project.", "id": "GoogleAnalyticsAdminV1alphaFirebaseLink",