google-apis-analyticsadmin_v1alpha 0.74.0 → 0.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/lib/google/apis/analyticsadmin_v1alpha/classes.rb +195 -101
- data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb +3 -3
- data/lib/google/apis/analyticsadmin_v1alpha/representations.rb +67 -32
- data/lib/google/apis/analyticsadmin_v1alpha/service.rb +349 -64
- metadata +4 -4
@@ -166,7 +166,7 @@ module Google
|
|
166
166
|
# Get data sharing settings on an account. Data sharing settings are singletons.
|
167
167
|
# @param [String] name
|
168
168
|
# Required. The name of the settings to lookup. Format: accounts/`account`/
|
169
|
-
# dataSharingSettings Example:
|
169
|
+
# dataSharingSettings Example: `accounts/1000/dataSharingSettings`
|
170
170
|
# @param [String] fields
|
171
171
|
# Selector specifying which fields to include in a partial response.
|
172
172
|
# @param [String] quota_user
|
@@ -195,7 +195,7 @@ module Google
|
|
195
195
|
end
|
196
196
|
|
197
197
|
# Returns all accounts accessible by the caller. Note that these accounts might
|
198
|
-
# not currently have
|
198
|
+
# not currently have GA properties. Soft-deleted (ie: "trashed") accounts are
|
199
199
|
# excluded by default. Returns an empty list if no relevant accounts are found.
|
200
200
|
# @param [Fixnum] page_size
|
201
201
|
# The maximum number of resources to return. The service may return fewer than
|
@@ -314,20 +314,22 @@ module Google
|
|
314
314
|
# for a property. Reports may be requested for any property, but dimensions that
|
315
315
|
# aren't related to quota can only be requested on Google Analytics 360
|
316
316
|
# properties. This method is only available to Administrators. These data access
|
317
|
-
# records include
|
317
|
+
# records include GA UI Reporting, GA UI Explorations, GA Data API, and other
|
318
318
|
# products like Firebase & Admob that can retrieve data from Google Analytics
|
319
319
|
# through a linkage. These records don't include property configuration changes
|
320
320
|
# like adding a stream or changing a property's time zone. For configuration
|
321
321
|
# change history, see [searchChangeHistoryEvents](https://developers.google.com/
|
322
322
|
# analytics/devguides/config/admin/v1/rest/v1alpha/accounts/
|
323
|
-
# searchChangeHistoryEvents).
|
323
|
+
# searchChangeHistoryEvents). To give your feedback on this API, complete the [
|
324
|
+
# Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/
|
325
|
+
# 1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
|
324
326
|
# @param [String] entity
|
325
327
|
# The Data Access Report supports requesting at the property level or account
|
326
328
|
# level. If requested at the account level, Data Access Reports include all
|
327
329
|
# access for all properties under that account. To request at the property level,
|
328
|
-
# entity should be for example 'properties/123' if "123" is your
|
329
|
-
# ID. To request at the account level, entity should be for
|
330
|
-
# 1234' if "1234" is your
|
330
|
+
# entity should be for example 'properties/123' if "123" is your Google
|
331
|
+
# Analytics property ID. To request at the account level, entity should be for
|
332
|
+
# example 'accounts/1234' if "1234" is your Google Analytics Account ID.
|
331
333
|
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaRunAccessReportRequest] google_analytics_admin_v1alpha_run_access_report_request_object
|
332
334
|
# @param [String] fields
|
333
335
|
# Selector specifying which fields to include in a partial response.
|
@@ -362,7 +364,7 @@ module Google
|
|
362
364
|
# set of filters.
|
363
365
|
# @param [String] account
|
364
366
|
# Required. The account resource for which to return change history resources.
|
365
|
-
# Format: accounts/`account` Example:
|
367
|
+
# Format: accounts/`account` Example: `accounts/100`
|
366
368
|
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest] google_analytics_admin_v1alpha_search_change_history_events_request_object
|
367
369
|
# @param [String] fields
|
368
370
|
# Selector specifying which fields to include in a partial response.
|
@@ -746,7 +748,7 @@ module Google
|
|
746
748
|
execute_or_queue_command(command, &block)
|
747
749
|
end
|
748
750
|
|
749
|
-
# Creates
|
751
|
+
# Creates a Google Analytics property with the specified location and attributes.
|
750
752
|
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
|
751
753
|
# @param [String] fields
|
752
754
|
# Selector specifying which fields to include in a partial response.
|
@@ -838,44 +840,12 @@ module Google
|
|
838
840
|
execute_or_queue_command(command, &block)
|
839
841
|
end
|
840
842
|
|
841
|
-
# Create a subproperty and a subproperty event filter that applies to the
|
842
|
-
# created subproperty.
|
843
|
-
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest] google_analytics_admin_v1alpha_create_subproperty_request_object
|
844
|
-
# @param [String] fields
|
845
|
-
# Selector specifying which fields to include in a partial response.
|
846
|
-
# @param [String] quota_user
|
847
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
848
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
849
|
-
# @param [Google::Apis::RequestOptions] options
|
850
|
-
# Request-specific options
|
851
|
-
#
|
852
|
-
# @yield [result, err] Result & error if block supplied
|
853
|
-
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse] parsed result object
|
854
|
-
# @yieldparam err [StandardError] error object if request failed
|
855
|
-
#
|
856
|
-
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse]
|
857
|
-
#
|
858
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
859
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
860
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
861
|
-
def create_property_subproperty(google_analytics_admin_v1alpha_create_subproperty_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
862
|
-
command = make_simple_command(:post, 'v1alpha/properties:createSubproperty', options)
|
863
|
-
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest::Representation
|
864
|
-
command.request_object = google_analytics_admin_v1alpha_create_subproperty_request_object
|
865
|
-
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse::Representation
|
866
|
-
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse
|
867
|
-
command.query['fields'] = fields unless fields.nil?
|
868
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
869
|
-
execute_or_queue_command(command, &block)
|
870
|
-
end
|
871
|
-
|
872
843
|
# Marks target Property as soft-deleted (ie: "trashed") and returns it. This API
|
873
844
|
# does not have a method to restore soft-deleted properties. However, they can
|
874
845
|
# be restored using the Trash Can UI. If the properties are not restored before
|
875
846
|
# the expiration time, the Property and all child resources (eg: GoogleAdsLinks,
|
876
847
|
# Streams, AccessBindings) will be permanently purged. https://support.google.
|
877
|
-
# com/analytics/answer/6154772 Returns an error if the target is not found
|
878
|
-
# is not a GA4 Property.
|
848
|
+
# com/analytics/answer/6154772 Returns an error if the target is not found.
|
879
849
|
# @param [String] name
|
880
850
|
# Required. The name of the Property to soft-delete. Format: properties/`
|
881
851
|
# property_id` Example: "properties/1000"
|
@@ -1002,7 +972,7 @@ module Google
|
|
1002
972
|
execute_or_queue_command(command, &block)
|
1003
973
|
end
|
1004
974
|
|
1005
|
-
# Lookup for a single
|
975
|
+
# Lookup for a single GA Property.
|
1006
976
|
# @param [String] name
|
1007
977
|
# Required. The name of the property to lookup. Format: properties/`property_id`
|
1008
978
|
# Example: "properties/1000"
|
@@ -1126,10 +1096,10 @@ module Google
|
|
1126
1096
|
execute_or_queue_command(command, &block)
|
1127
1097
|
end
|
1128
1098
|
|
1129
|
-
# Returns child Properties under the specified parent Account.
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1099
|
+
# Returns child Properties under the specified parent Account. Properties will
|
1100
|
+
# be excluded if the caller does not have access. Soft-deleted (ie: "trashed")
|
1101
|
+
# properties are excluded by default. Returns an empty list if no relevant
|
1102
|
+
# properties are found.
|
1133
1103
|
# @param [String] filter
|
1134
1104
|
# Required. An expression for filtering the results of the request. Fields
|
1135
1105
|
# eligible for filtering are: `parent:`(The resource name of the parent account/
|
@@ -1254,26 +1224,59 @@ module Google
|
|
1254
1224
|
execute_or_queue_command(command, &block)
|
1255
1225
|
end
|
1256
1226
|
|
1227
|
+
# Create a subproperty and a subproperty event filter that applies to the
|
1228
|
+
# created subproperty.
|
1229
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest] google_analytics_admin_v1alpha_provision_subproperty_request_object
|
1230
|
+
# @param [String] fields
|
1231
|
+
# Selector specifying which fields to include in a partial response.
|
1232
|
+
# @param [String] quota_user
|
1233
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1234
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1235
|
+
# @param [Google::Apis::RequestOptions] options
|
1236
|
+
# Request-specific options
|
1237
|
+
#
|
1238
|
+
# @yield [result, err] Result & error if block supplied
|
1239
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse] parsed result object
|
1240
|
+
# @yieldparam err [StandardError] error object if request failed
|
1241
|
+
#
|
1242
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse]
|
1243
|
+
#
|
1244
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1245
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1246
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1247
|
+
def provision_property_subproperty(google_analytics_admin_v1alpha_provision_subproperty_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1248
|
+
command = make_simple_command(:post, 'v1alpha/properties:provisionSubproperty', options)
|
1249
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest::Representation
|
1250
|
+
command.request_object = google_analytics_admin_v1alpha_provision_subproperty_request_object
|
1251
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse::Representation
|
1252
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse
|
1253
|
+
command.query['fields'] = fields unless fields.nil?
|
1254
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1255
|
+
execute_or_queue_command(command, &block)
|
1256
|
+
end
|
1257
|
+
|
1257
1258
|
# Returns a customized report of data access records. The report provides
|
1258
1259
|
# records of each time a user reads Google Analytics reporting data. Access
|
1259
1260
|
# records are retained for up to 2 years. Data Access Reports can be requested
|
1260
1261
|
# for a property. Reports may be requested for any property, but dimensions that
|
1261
1262
|
# aren't related to quota can only be requested on Google Analytics 360
|
1262
1263
|
# properties. This method is only available to Administrators. These data access
|
1263
|
-
# records include
|
1264
|
+
# records include GA UI Reporting, GA UI Explorations, GA Data API, and other
|
1264
1265
|
# products like Firebase & Admob that can retrieve data from Google Analytics
|
1265
1266
|
# through a linkage. These records don't include property configuration changes
|
1266
1267
|
# like adding a stream or changing a property's time zone. For configuration
|
1267
1268
|
# change history, see [searchChangeHistoryEvents](https://developers.google.com/
|
1268
1269
|
# analytics/devguides/config/admin/v1/rest/v1alpha/accounts/
|
1269
|
-
# searchChangeHistoryEvents).
|
1270
|
+
# searchChangeHistoryEvents). To give your feedback on this API, complete the [
|
1271
|
+
# Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/
|
1272
|
+
# 1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
|
1270
1273
|
# @param [String] entity
|
1271
1274
|
# The Data Access Report supports requesting at the property level or account
|
1272
1275
|
# level. If requested at the account level, Data Access Reports include all
|
1273
1276
|
# access for all properties under that account. To request at the property level,
|
1274
|
-
# entity should be for example 'properties/123' if "123" is your
|
1275
|
-
# ID. To request at the account level, entity should be for
|
1276
|
-
# 1234' if "1234" is your
|
1277
|
+
# entity should be for example 'properties/123' if "123" is your Google
|
1278
|
+
# Analytics property ID. To request at the account level, entity should be for
|
1279
|
+
# example 'accounts/1234' if "1234" is your Google Analytics Account ID.
|
1277
1280
|
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaRunAccessReportRequest] google_analytics_admin_v1alpha_run_access_report_request_object
|
1278
1281
|
# @param [String] fields
|
1279
1282
|
# Selector specifying which fields to include in a partial response.
|
@@ -2087,6 +2090,70 @@ module Google
|
|
2087
2090
|
execute_or_queue_command(command, &block)
|
2088
2091
|
end
|
2089
2092
|
|
2093
|
+
# Creates a BigQueryLink.
|
2094
|
+
# @param [String] parent
|
2095
|
+
# Required. Example format: properties/1234
|
2096
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink] google_analytics_admin_v1alpha_big_query_link_object
|
2097
|
+
# @param [String] fields
|
2098
|
+
# Selector specifying which fields to include in a partial response.
|
2099
|
+
# @param [String] quota_user
|
2100
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2101
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2102
|
+
# @param [Google::Apis::RequestOptions] options
|
2103
|
+
# Request-specific options
|
2104
|
+
#
|
2105
|
+
# @yield [result, err] Result & error if block supplied
|
2106
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink] parsed result object
|
2107
|
+
# @yieldparam err [StandardError] error object if request failed
|
2108
|
+
#
|
2109
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
|
2110
|
+
#
|
2111
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2112
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2113
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2114
|
+
def create_property_big_query_link(parent, google_analytics_admin_v1alpha_big_query_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2115
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/bigQueryLinks', options)
|
2116
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
|
2117
|
+
command.request_object = google_analytics_admin_v1alpha_big_query_link_object
|
2118
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
|
2119
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink
|
2120
|
+
command.params['parent'] = parent unless parent.nil?
|
2121
|
+
command.query['fields'] = fields unless fields.nil?
|
2122
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2123
|
+
execute_or_queue_command(command, &block)
|
2124
|
+
end
|
2125
|
+
|
2126
|
+
# Deletes a BigQueryLink on a property.
|
2127
|
+
# @param [String] name
|
2128
|
+
# Required. The BigQueryLink to delete. Example format: properties/1234/
|
2129
|
+
# bigQueryLinks/5678
|
2130
|
+
# @param [String] fields
|
2131
|
+
# Selector specifying which fields to include in a partial response.
|
2132
|
+
# @param [String] quota_user
|
2133
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2134
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2135
|
+
# @param [Google::Apis::RequestOptions] options
|
2136
|
+
# Request-specific options
|
2137
|
+
#
|
2138
|
+
# @yield [result, err] Result & error if block supplied
|
2139
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
2140
|
+
# @yieldparam err [StandardError] error object if request failed
|
2141
|
+
#
|
2142
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
2143
|
+
#
|
2144
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2145
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2146
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2147
|
+
def delete_property_big_query_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
2148
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
2149
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
2150
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
2151
|
+
command.params['name'] = name unless name.nil?
|
2152
|
+
command.query['fields'] = fields unless fields.nil?
|
2153
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2154
|
+
execute_or_queue_command(command, &block)
|
2155
|
+
end
|
2156
|
+
|
2090
2157
|
# Lookup for a single BigQuery Link.
|
2091
2158
|
# @param [String] name
|
2092
2159
|
# Required. The name of the BigQuery link to lookup. Format: properties/`
|
@@ -2162,6 +2229,46 @@ module Google
|
|
2162
2229
|
execute_or_queue_command(command, &block)
|
2163
2230
|
end
|
2164
2231
|
|
2232
|
+
# Updates a BigQueryLink.
|
2233
|
+
# @param [String] name
|
2234
|
+
# Output only. Resource name of this BigQuery link. Format: 'properties/`
|
2235
|
+
# property_id`/bigQueryLinks/`bigquery_link_id`' Format: 'properties/1234/
|
2236
|
+
# bigQueryLinks/abc567'
|
2237
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink] google_analytics_admin_v1alpha_big_query_link_object
|
2238
|
+
# @param [String] update_mask
|
2239
|
+
# Required. The list of fields to be updated. Field names must be in snake case (
|
2240
|
+
# e.g., "field_to_update"). Omitted fields will not be updated. To replace the
|
2241
|
+
# entire entity, use one path with the string "*" to match all fields.
|
2242
|
+
# @param [String] fields
|
2243
|
+
# Selector specifying which fields to include in a partial response.
|
2244
|
+
# @param [String] quota_user
|
2245
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2246
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2247
|
+
# @param [Google::Apis::RequestOptions] options
|
2248
|
+
# Request-specific options
|
2249
|
+
#
|
2250
|
+
# @yield [result, err] Result & error if block supplied
|
2251
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink] parsed result object
|
2252
|
+
# @yieldparam err [StandardError] error object if request failed
|
2253
|
+
#
|
2254
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
|
2255
|
+
#
|
2256
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2257
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2258
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2259
|
+
def patch_property_big_query_link(name, google_analytics_admin_v1alpha_big_query_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2260
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
2261
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
|
2262
|
+
command.request_object = google_analytics_admin_v1alpha_big_query_link_object
|
2263
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
|
2264
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink
|
2265
|
+
command.params['name'] = name unless name.nil?
|
2266
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2267
|
+
command.query['fields'] = fields unless fields.nil?
|
2268
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2269
|
+
execute_or_queue_command(command, &block)
|
2270
|
+
end
|
2271
|
+
|
2165
2272
|
# Creates a CalculatedMetric.
|
2166
2273
|
# @param [String] parent
|
2167
2274
|
# Required. Format: properties/`property_id` Example: properties/1234
|
@@ -2524,7 +2631,8 @@ module Google
|
|
2524
2631
|
execute_or_queue_command(command, &block)
|
2525
2632
|
end
|
2526
2633
|
|
2527
|
-
# Creates a conversion event with the
|
2634
|
+
# Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the
|
2635
|
+
# specified attributes.
|
2528
2636
|
# @param [String] parent
|
2529
2637
|
# Required. The resource name of the parent property where this conversion event
|
2530
2638
|
# will be created. Format: properties/123
|
@@ -2558,7 +2666,8 @@ module Google
|
|
2558
2666
|
execute_or_queue_command(command, &block)
|
2559
2667
|
end
|
2560
2668
|
|
2561
|
-
# Deletes a conversion event in a
|
2669
|
+
# Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a
|
2670
|
+
# property.
|
2562
2671
|
# @param [String] name
|
2563
2672
|
# Required. The resource name of the conversion event to delete. Format:
|
2564
2673
|
# properties/`property`/conversionEvents/`conversion_event` Example: "properties/
|
@@ -2590,7 +2699,7 @@ module Google
|
|
2590
2699
|
execute_or_queue_command(command, &block)
|
2591
2700
|
end
|
2592
2701
|
|
2593
|
-
# Retrieve a single conversion event.
|
2702
|
+
# Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
|
2594
2703
|
# @param [String] name
|
2595
2704
|
# Required. The resource name of the conversion event to retrieve. Format:
|
2596
2705
|
# properties/`property`/conversionEvents/`conversion_event` Example: "properties/
|
@@ -2622,8 +2731,9 @@ module Google
|
|
2622
2731
|
execute_or_queue_command(command, &block)
|
2623
2732
|
end
|
2624
2733
|
|
2625
|
-
# Returns a list of conversion events
|
2626
|
-
# an empty list if no conversion
|
2734
|
+
# Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events
|
2735
|
+
# in the specified parent property. Returns an empty list if no conversion
|
2736
|
+
# events are found.
|
2627
2737
|
# @param [String] parent
|
2628
2738
|
# Required. The resource name of the parent property. Example: 'properties/123'
|
2629
2739
|
# @param [Fixnum] page_size
|
@@ -2664,7 +2774,8 @@ module Google
|
|
2664
2774
|
execute_or_queue_command(command, &block)
|
2665
2775
|
end
|
2666
2776
|
|
2667
|
-
# Updates a conversion event with the
|
2777
|
+
# Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the
|
2778
|
+
# specified attributes.
|
2668
2779
|
# @param [String] name
|
2669
2780
|
# Output only. Resource name of this conversion event. Format: properties/`
|
2670
2781
|
# property`/conversionEvents/`conversion_event`
|
@@ -3224,8 +3335,8 @@ module Google
|
|
3224
3335
|
# @param [String] name
|
3225
3336
|
# Required. The name of the site tag to lookup. Note that site tags are
|
3226
3337
|
# singletons and do not have unique IDs. Format: properties/`property_id`/
|
3227
|
-
# dataStreams/`stream_id`/globalSiteTag Example:
|
3228
|
-
# globalSiteTag
|
3338
|
+
# dataStreams/`stream_id`/globalSiteTag Example: `properties/123/dataStreams/456/
|
3339
|
+
# globalSiteTag`
|
3229
3340
|
# @param [String] fields
|
3230
3341
|
# Selector specifying which fields to include in a partial response.
|
3231
3342
|
# @param [String] quota_user
|
@@ -3589,6 +3700,180 @@ module Google
|
|
3589
3700
|
execute_or_queue_command(command, &block)
|
3590
3701
|
end
|
3591
3702
|
|
3703
|
+
# Creates an EventEditRule.
|
3704
|
+
# @param [String] parent
|
3705
|
+
# Required. Example format: properties/123/dataStreams/456
|
3706
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule] google_analytics_admin_v1alpha_event_edit_rule_object
|
3707
|
+
# @param [String] fields
|
3708
|
+
# Selector specifying which fields to include in a partial response.
|
3709
|
+
# @param [String] quota_user
|
3710
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3711
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3712
|
+
# @param [Google::Apis::RequestOptions] options
|
3713
|
+
# Request-specific options
|
3714
|
+
#
|
3715
|
+
# @yield [result, err] Result & error if block supplied
|
3716
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule] parsed result object
|
3717
|
+
# @yieldparam err [StandardError] error object if request failed
|
3718
|
+
#
|
3719
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule]
|
3720
|
+
#
|
3721
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3722
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3723
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3724
|
+
def create_property_data_stream_event_edit_rule(parent, google_analytics_admin_v1alpha_event_edit_rule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3725
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/eventEditRules', options)
|
3726
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule::Representation
|
3727
|
+
command.request_object = google_analytics_admin_v1alpha_event_edit_rule_object
|
3728
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule::Representation
|
3729
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule
|
3730
|
+
command.params['parent'] = parent unless parent.nil?
|
3731
|
+
command.query['fields'] = fields unless fields.nil?
|
3732
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3733
|
+
execute_or_queue_command(command, &block)
|
3734
|
+
end
|
3735
|
+
|
3736
|
+
# Deletes an EventEditRule.
|
3737
|
+
# @param [String] name
|
3738
|
+
# Required. Example format: properties/123/dataStreams/456/eventEditRules/789
|
3739
|
+
# @param [String] fields
|
3740
|
+
# Selector specifying which fields to include in a partial response.
|
3741
|
+
# @param [String] quota_user
|
3742
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3743
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3744
|
+
# @param [Google::Apis::RequestOptions] options
|
3745
|
+
# Request-specific options
|
3746
|
+
#
|
3747
|
+
# @yield [result, err] Result & error if block supplied
|
3748
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
3749
|
+
# @yieldparam err [StandardError] error object if request failed
|
3750
|
+
#
|
3751
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
3752
|
+
#
|
3753
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3754
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3755
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3756
|
+
def delete_property_data_stream_event_edit_rule(name, fields: nil, quota_user: nil, options: nil, &block)
|
3757
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
3758
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
3759
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
3760
|
+
command.params['name'] = name unless name.nil?
|
3761
|
+
command.query['fields'] = fields unless fields.nil?
|
3762
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3763
|
+
execute_or_queue_command(command, &block)
|
3764
|
+
end
|
3765
|
+
|
3766
|
+
# Lookup for a single EventEditRule.
|
3767
|
+
# @param [String] name
|
3768
|
+
# Required. The name of the EventEditRule to get. Example format: properties/123/
|
3769
|
+
# dataStreams/456/eventEditRules/789
|
3770
|
+
# @param [String] fields
|
3771
|
+
# Selector specifying which fields to include in a partial response.
|
3772
|
+
# @param [String] quota_user
|
3773
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3774
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3775
|
+
# @param [Google::Apis::RequestOptions] options
|
3776
|
+
# Request-specific options
|
3777
|
+
#
|
3778
|
+
# @yield [result, err] Result & error if block supplied
|
3779
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule] parsed result object
|
3780
|
+
# @yieldparam err [StandardError] error object if request failed
|
3781
|
+
#
|
3782
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule]
|
3783
|
+
#
|
3784
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3785
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3786
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3787
|
+
def get_property_data_stream_event_edit_rule(name, fields: nil, quota_user: nil, options: nil, &block)
|
3788
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
3789
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule::Representation
|
3790
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule
|
3791
|
+
command.params['name'] = name unless name.nil?
|
3792
|
+
command.query['fields'] = fields unless fields.nil?
|
3793
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3794
|
+
execute_or_queue_command(command, &block)
|
3795
|
+
end
|
3796
|
+
|
3797
|
+
# Lists EventEditRules on a web data stream.
|
3798
|
+
# @param [String] parent
|
3799
|
+
# Required. Example format: properties/123/dataStreams/456
|
3800
|
+
# @param [Fixnum] page_size
|
3801
|
+
# Optional. The maximum number of resources to return. If unspecified, at most
|
3802
|
+
# 50 resources will be returned. The maximum value is 200 (higher values will be
|
3803
|
+
# coerced to the maximum).
|
3804
|
+
# @param [String] page_token
|
3805
|
+
# Optional. A page token, received from a previous `ListEventEditRules` call.
|
3806
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
3807
|
+
# parameters provided to `ListEventEditRules` must match the call that provided
|
3808
|
+
# the page token.
|
3809
|
+
# @param [String] fields
|
3810
|
+
# Selector specifying which fields to include in a partial response.
|
3811
|
+
# @param [String] quota_user
|
3812
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3813
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3814
|
+
# @param [Google::Apis::RequestOptions] options
|
3815
|
+
# Request-specific options
|
3816
|
+
#
|
3817
|
+
# @yield [result, err] Result & error if block supplied
|
3818
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListEventEditRulesResponse] parsed result object
|
3819
|
+
# @yieldparam err [StandardError] error object if request failed
|
3820
|
+
#
|
3821
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListEventEditRulesResponse]
|
3822
|
+
#
|
3823
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3824
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3825
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3826
|
+
def list_property_data_stream_event_edit_rules(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3827
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/eventEditRules', options)
|
3828
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListEventEditRulesResponse::Representation
|
3829
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListEventEditRulesResponse
|
3830
|
+
command.params['parent'] = parent unless parent.nil?
|
3831
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3832
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3833
|
+
command.query['fields'] = fields unless fields.nil?
|
3834
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3835
|
+
execute_or_queue_command(command, &block)
|
3836
|
+
end
|
3837
|
+
|
3838
|
+
# Updates an EventEditRule.
|
3839
|
+
# @param [String] name
|
3840
|
+
# Identifier. Resource name for this EventEditRule resource. Format: properties/`
|
3841
|
+
# property`/dataStreams/`data_stream`/eventEditRules/`event_edit_rule`
|
3842
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule] google_analytics_admin_v1alpha_event_edit_rule_object
|
3843
|
+
# @param [String] update_mask
|
3844
|
+
# Required. The list of fields to be updated. Field names must be in snake case (
|
3845
|
+
# e.g., "field_to_update"). Omitted fields will not be updated. To replace the
|
3846
|
+
# entire entity, use one path with the string "*" to match all fields.
|
3847
|
+
# @param [String] fields
|
3848
|
+
# Selector specifying which fields to include in a partial response.
|
3849
|
+
# @param [String] quota_user
|
3850
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3851
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3852
|
+
# @param [Google::Apis::RequestOptions] options
|
3853
|
+
# Request-specific options
|
3854
|
+
#
|
3855
|
+
# @yield [result, err] Result & error if block supplied
|
3856
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule] parsed result object
|
3857
|
+
# @yieldparam err [StandardError] error object if request failed
|
3858
|
+
#
|
3859
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule]
|
3860
|
+
#
|
3861
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3862
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3863
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3864
|
+
def patch_property_data_stream_event_edit_rule(name, google_analytics_admin_v1alpha_event_edit_rule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3865
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
3866
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule::Representation
|
3867
|
+
command.request_object = google_analytics_admin_v1alpha_event_edit_rule_object
|
3868
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule::Representation
|
3869
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule
|
3870
|
+
command.params['name'] = name unless name.nil?
|
3871
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3872
|
+
command.query['fields'] = fields unless fields.nil?
|
3873
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3874
|
+
execute_or_queue_command(command, &block)
|
3875
|
+
end
|
3876
|
+
|
3592
3877
|
# Changes the processing order of event edit rules on the specified stream.
|
3593
3878
|
# @param [String] parent
|
3594
3879
|
# Required. Example format: properties/123/dataStreams/456
|
@@ -3688,7 +3973,7 @@ module Google
|
|
3688
3973
|
execute_or_queue_command(command, &block)
|
3689
3974
|
end
|
3690
3975
|
|
3691
|
-
# Lookup for a single
|
3976
|
+
# Lookup for a single MeasurementProtocolSecret.
|
3692
3977
|
# @param [String] name
|
3693
3978
|
# Required. The name of the measurement protocol secret to lookup. Format:
|
3694
3979
|
# properties/`property`/dataStreams/`dataStream`/measurementProtocolSecrets/`
|
@@ -4549,7 +4834,7 @@ module Google
|
|
4549
4834
|
|
4550
4835
|
# Creates a FirebaseLink. Properties can have at most one FirebaseLink.
|
4551
4836
|
# @param [String] parent
|
4552
|
-
# Required. Format: properties/`property_id` Example: properties/1234
|
4837
|
+
# Required. Format: properties/`property_id` Example: `properties/1234`
|
4553
4838
|
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink] google_analytics_admin_v1alpha_firebase_link_object
|
4554
4839
|
# @param [String] fields
|
4555
4840
|
# Selector specifying which fields to include in a partial response.
|
@@ -4583,7 +4868,7 @@ module Google
|
|
4583
4868
|
# Deletes a FirebaseLink on a property
|
4584
4869
|
# @param [String] name
|
4585
4870
|
# Required. Format: properties/`property_id`/firebaseLinks/`firebase_link_id`
|
4586
|
-
# Example: properties/1234/firebaseLinks/5678
|
4871
|
+
# Example: `properties/1234/firebaseLinks/5678`
|
4587
4872
|
# @param [String] fields
|
4588
4873
|
# Selector specifying which fields to include in a partial response.
|
4589
4874
|
# @param [String] quota_user
|
@@ -4614,7 +4899,7 @@ module Google
|
|
4614
4899
|
# Lists FirebaseLinks on a property. Properties can have at most one
|
4615
4900
|
# FirebaseLink.
|
4616
4901
|
# @param [String] parent
|
4617
|
-
# Required. Format: properties/`property_id` Example: properties/1234
|
4902
|
+
# Required. Format: properties/`property_id` Example: `properties/1234`
|
4618
4903
|
# @param [Fixnum] page_size
|
4619
4904
|
# The maximum number of resources to return. The service may return fewer than
|
4620
4905
|
# this value, even if there are additional pages. If unspecified, at most 50
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-analyticsadmin_v1alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.76.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-12-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.76.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
- !ruby/object:Gem::Version
|
76
76
|
version: '0'
|
77
77
|
requirements: []
|
78
|
-
rubygems_version: 3.5.
|
78
|
+
rubygems_version: 3.5.22
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Google Analytics Admin API V1alpha
|