google-apis-analyticsadmin_v1alpha 0.14.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -689,6 +689,41 @@ module Google
689
689
  execute_or_queue_command(command, &block)
690
690
  end
691
691
 
692
+ # Acknowledges the terms of user data collection for the specified property.
693
+ # This acknowledgement must be completed (either in the Google Analytics UI or
694
+ # via this API) before MeasurementProtocolSecret resources may be created.
695
+ # @param [String] property
696
+ # Required. The property for which to acknowledge user data collection.
697
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest] google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_object
698
+ # @param [String] fields
699
+ # Selector specifying which fields to include in a partial response.
700
+ # @param [String] quota_user
701
+ # Available to use for quota purposes for server-side applications. Can be any
702
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
703
+ # @param [Google::Apis::RequestOptions] options
704
+ # Request-specific options
705
+ #
706
+ # @yield [result, err] Result & error if block supplied
707
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse] parsed result object
708
+ # @yieldparam err [StandardError] error object if request failed
709
+ #
710
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse]
711
+ #
712
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
713
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
714
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
715
+ def acknowledge_property_user_data_collection(property, google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
716
+ command = make_simple_command(:post, 'v1alpha/{+property}:acknowledgeUserDataCollection', options)
717
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest::Representation
718
+ command.request_object = google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_object
719
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse::Representation
720
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
721
+ command.params['property'] = property unless property.nil?
722
+ command.query['fields'] = fields unless fields.nil?
723
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
724
+ execute_or_queue_command(command, &block)
725
+ end
726
+
692
727
  # Creates an "GA4" property with the specified location and attributes.
693
728
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
694
729
  # @param [String] fields
@@ -855,13 +890,15 @@ module Google
855
890
  # default. Returns an empty list if no relevant properties are found.
856
891
  # @param [String] filter
857
892
  # Required. An expression for filtering the results of the request. Fields
858
- # eligible for filtering are: `parent:`(The resource name of the parent account)
859
- # or `firebase_project:`(The id or number of the linked firebase project). Some
893
+ # eligible for filtering are: `parent:`(The resource name of the parent account/
894
+ # property) or `ancestor:`(The resource name of the parent account) or `
895
+ # firebase_project:`(The id or number of the linked firebase project). Some
860
896
  # examples of filters: ``` | Filter | Description | |----------------------------
861
897
  # -|-------------------------------------------| | parent:accounts/123 | The
862
- # account with account id: 123. | | firebase_project:project-id | The firebase
863
- # project with id: project-id. | | firebase_project:123 | The firebase project
864
- # with number: 123. | ```
898
+ # account with account id: 123. | | parent:properties/123 | The property with
899
+ # property id: 123. | | ancestor:accounts/123 | The account with account id: 123.
900
+ # | | firebase_project:project-id | The firebase project with id: project-id. |
901
+ # | firebase_project:123 | The firebase project with number: 123. | ```
865
902
  # @param [Fixnum] page_size
866
903
  # The maximum number of resources to return. The service may return fewer than
867
904
  # this value, even if there are additional pages. If unspecified, at most 50
@@ -1021,11 +1058,45 @@ module Google
1021
1058
  execute_or_queue_command(command, &block)
1022
1059
  end
1023
1060
 
1024
- # Deletes an android app stream on a property.
1061
+ # Creates a conversion event with the specified attributes.
1062
+ # @param [String] parent
1063
+ # Required. The resource name of the parent property where this conversion event
1064
+ # will be created. Format: properties/123
1065
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] google_analytics_admin_v1alpha_conversion_event_object
1066
+ # @param [String] fields
1067
+ # Selector specifying which fields to include in a partial response.
1068
+ # @param [String] quota_user
1069
+ # Available to use for quota purposes for server-side applications. Can be any
1070
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1071
+ # @param [Google::Apis::RequestOptions] options
1072
+ # Request-specific options
1073
+ #
1074
+ # @yield [result, err] Result & error if block supplied
1075
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] parsed result object
1076
+ # @yieldparam err [StandardError] error object if request failed
1077
+ #
1078
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
1079
+ #
1080
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1081
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1082
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1083
+ def create_property_conversion_event(parent, google_analytics_admin_v1alpha_conversion_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1084
+ command = make_simple_command(:post, 'v1alpha/{+parent}/conversionEvents', options)
1085
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1086
+ command.request_object = google_analytics_admin_v1alpha_conversion_event_object
1087
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1088
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent
1089
+ command.params['parent'] = parent unless parent.nil?
1090
+ command.query['fields'] = fields unless fields.nil?
1091
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1092
+ execute_or_queue_command(command, &block)
1093
+ end
1094
+
1095
+ # Deletes a conversion event in a property.
1025
1096
  # @param [String] name
1026
- # Required. The name of the android app data stream to delete. Format:
1027
- # properties/`property_id`/androidAppDataStreams/`stream_id` Example: "
1028
- # properties/123/androidAppDataStreams/456"
1097
+ # Required. The resource name of the conversion event to delete. Format:
1098
+ # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
1099
+ # 123/conversionEvents/456"
1029
1100
  # @param [String] fields
1030
1101
  # Selector specifying which fields to include in a partial response.
1031
1102
  # @param [String] quota_user
@@ -1043,7 +1114,7 @@ module Google
1043
1114
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1044
1115
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1045
1116
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1046
- def delete_property_android_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
1117
+ def delete_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
1047
1118
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1048
1119
  command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1049
1120
  command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
@@ -1053,11 +1124,11 @@ module Google
1053
1124
  execute_or_queue_command(command, &block)
1054
1125
  end
1055
1126
 
1056
- # Lookup for a single AndroidAppDataStream
1127
+ # Retrieve a single conversion event.
1057
1128
  # @param [String] name
1058
- # Required. The name of the android app data stream to lookup. Format:
1059
- # properties/`property_id`/androidAppDataStreams/`stream_id` Example: "
1060
- # properties/123/androidAppDataStreams/456"
1129
+ # Required. The resource name of the conversion event to retrieve. Format:
1130
+ # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
1131
+ # 123/conversionEvents/456"
1061
1132
  # @param [String] fields
1062
1133
  # Selector specifying which fields to include in a partial response.
1063
1134
  # @param [String] quota_user
@@ -1067,38 +1138,37 @@ module Google
1067
1138
  # Request-specific options
1068
1139
  #
1069
1140
  # @yield [result, err] Result & error if block supplied
1070
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] parsed result object
1141
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] parsed result object
1071
1142
  # @yieldparam err [StandardError] error object if request failed
1072
1143
  #
1073
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
1144
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
1074
1145
  #
1075
1146
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1076
1147
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1077
1148
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1078
- def get_property_android_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
1149
+ def get_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
1079
1150
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
1080
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
1081
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream
1151
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1152
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent
1082
1153
  command.params['name'] = name unless name.nil?
1083
1154
  command.query['fields'] = fields unless fields.nil?
1084
1155
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1085
1156
  execute_or_queue_command(command, &block)
1086
1157
  end
1087
1158
 
1088
- # Returns child android app streams under the specified parent property. Android
1089
- # app streams will be excluded if the caller does not have access. Returns an
1090
- # empty list if no relevant android app streams are found.
1159
+ # Returns a list of conversion events in the specified parent property. Returns
1160
+ # an empty list if no conversion events are found.
1091
1161
  # @param [String] parent
1092
- # Required. The name of the parent property. For example, to limit results to
1093
- # app streams under the property with Id 123: "properties/123"
1162
+ # Required. The resource name of the parent property. Example: 'properties/123'
1094
1163
  # @param [Fixnum] page_size
1095
1164
  # The maximum number of resources to return. If unspecified, at most 50
1096
1165
  # resources will be returned. The maximum value is 200; (higher values will be
1097
1166
  # coerced to the maximum)
1098
1167
  # @param [String] page_token
1099
- # A page token, received from a previous call. Provide this to retrieve the
1100
- # subsequent page. When paginating, all other parameters provided to `
1101
- # ListAndroidAppDataStreams` must match the call that provided the page token.
1168
+ # A page token, received from a previous `ListConversionEvents` call. Provide
1169
+ # this to retrieve the subsequent page. When paginating, all other parameters
1170
+ # provided to `ListConversionEvents` must match the call that provided the page
1171
+ # token.
1102
1172
  # @param [String] fields
1103
1173
  # Selector specifying which fields to include in a partial response.
1104
1174
  # @param [String] quota_user
@@ -1108,18 +1178,18 @@ module Google
1108
1178
  # Request-specific options
1109
1179
  #
1110
1180
  # @yield [result, err] Result & error if block supplied
1111
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse] parsed result object
1181
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse] parsed result object
1112
1182
  # @yieldparam err [StandardError] error object if request failed
1113
1183
  #
1114
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse]
1184
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse]
1115
1185
  #
1116
1186
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1117
1187
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1118
1188
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1119
- def list_property_android_app_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1120
- command = make_simple_command(:get, 'v1alpha/{+parent}/androidAppDataStreams', options)
1121
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse::Representation
1122
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse
1189
+ def list_property_conversion_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1190
+ command = make_simple_command(:get, 'v1alpha/{+parent}/conversionEvents', options)
1191
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse::Representation
1192
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1123
1193
  command.params['parent'] = parent unless parent.nil?
1124
1194
  command.query['pageSize'] = page_size unless page_size.nil?
1125
1195
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -1128,16 +1198,11 @@ module Google
1128
1198
  execute_or_queue_command(command, &block)
1129
1199
  end
1130
1200
 
1131
- # Updates an android app stream on a property.
1201
+ # Archives a CustomDimension on a property.
1132
1202
  # @param [String] name
1133
- # Output only. Resource name of this Data Stream. Format: properties/`
1134
- # property_id`/androidAppDataStreams/`stream_id` Example: "properties/1000/
1135
- # androidAppDataStreams/2000"
1136
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] google_analytics_admin_v1alpha_android_app_data_stream_object
1137
- # @param [String] update_mask
1138
- # Required. The list of fields to be updated. Field names must be in snake case (
1139
- # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1140
- # entire entity, use one path with the string "*" to match all fields.
1203
+ # Required. The name of the CustomDimension to archive. Example format:
1204
+ # properties/1234/customDimensions/5678
1205
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest] google_analytics_admin_v1alpha_archive_custom_dimension_request_object
1141
1206
  # @param [String] fields
1142
1207
  # Selector specifying which fields to include in a partial response.
1143
1208
  # @param [String] quota_user
@@ -1147,33 +1212,30 @@ module Google
1147
1212
  # Request-specific options
1148
1213
  #
1149
1214
  # @yield [result, err] Result & error if block supplied
1150
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] parsed result object
1215
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1151
1216
  # @yieldparam err [StandardError] error object if request failed
1152
1217
  #
1153
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
1218
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1154
1219
  #
1155
1220
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1156
1221
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1157
1222
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1158
- def patch_property_android_app_data_stream(name, google_analytics_admin_v1alpha_android_app_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1159
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1160
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
1161
- command.request_object = google_analytics_admin_v1alpha_android_app_data_stream_object
1162
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
1163
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream
1223
+ def archive_property_custom_dimension(name, google_analytics_admin_v1alpha_archive_custom_dimension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1224
+ command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1225
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest::Representation
1226
+ command.request_object = google_analytics_admin_v1alpha_archive_custom_dimension_request_object
1227
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1228
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1164
1229
  command.params['name'] = name unless name.nil?
1165
- command.query['updateMask'] = update_mask unless update_mask.nil?
1166
1230
  command.query['fields'] = fields unless fields.nil?
1167
1231
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1168
1232
  execute_or_queue_command(command, &block)
1169
1233
  end
1170
1234
 
1171
- # Creates a measurement protocol secret.
1235
+ # Creates a CustomDimension.
1172
1236
  # @param [String] parent
1173
- # Required. The parent resource where this secret will be created. Any type of
1174
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
1175
- # Format: properties/`property`/webDataStreams/`webDataStream`
1176
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
1237
+ # Required. Example format: properties/1234
1238
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] google_analytics_admin_v1alpha_custom_dimension_object
1177
1239
  # @param [String] fields
1178
1240
  # Selector specifying which fields to include in a partial response.
1179
1241
  # @param [String] quota_user
@@ -1183,32 +1245,30 @@ module Google
1183
1245
  # Request-specific options
1184
1246
  #
1185
1247
  # @yield [result, err] Result & error if block supplied
1186
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
1248
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1187
1249
  # @yieldparam err [StandardError] error object if request failed
1188
1250
  #
1189
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
1251
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1190
1252
  #
1191
1253
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1192
1254
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1193
1255
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1194
- def create_property_android_app_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1195
- command = make_simple_command(:post, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
1196
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1197
- command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
1198
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1199
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1256
+ def create_property_custom_dimension(parent, google_analytics_admin_v1alpha_custom_dimension_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1257
+ command = make_simple_command(:post, 'v1alpha/{+parent}/customDimensions', options)
1258
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1259
+ command.request_object = google_analytics_admin_v1alpha_custom_dimension_object
1260
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1261
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1200
1262
  command.params['parent'] = parent unless parent.nil?
1201
1263
  command.query['fields'] = fields unless fields.nil?
1202
1264
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1203
1265
  execute_or_queue_command(command, &block)
1204
1266
  end
1205
1267
 
1206
- # Deletes target MeasurementProtocolSecret.
1268
+ # Lookup for a single CustomDimension.
1207
1269
  # @param [String] name
1208
- # Required. The name of the MeasurementProtocolSecret to delete. Format:
1209
- # properties/`property`/webDataStreams/`webDataStream`/
1210
- # measurementProtocolSecrets/`measurementProtocolSecret` Note: Any type of
1211
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
1270
+ # Required. The name of the CustomDimension to get. Example format: properties/
1271
+ # 1234/customDimensions/5678
1212
1272
  # @param [String] fields
1213
1273
  # Selector specifying which fields to include in a partial response.
1214
1274
  # @param [String] quota_user
@@ -1218,30 +1278,36 @@ module Google
1218
1278
  # Request-specific options
1219
1279
  #
1220
1280
  # @yield [result, err] Result & error if block supplied
1221
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1281
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1222
1282
  # @yieldparam err [StandardError] error object if request failed
1223
1283
  #
1224
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1284
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1225
1285
  #
1226
1286
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1227
1287
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1228
1288
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1229
- def delete_property_android_app_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
1230
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1231
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1232
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1289
+ def get_property_custom_dimension(name, fields: nil, quota_user: nil, options: nil, &block)
1290
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1291
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1292
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1233
1293
  command.params['name'] = name unless name.nil?
1234
1294
  command.query['fields'] = fields unless fields.nil?
1235
1295
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1236
1296
  execute_or_queue_command(command, &block)
1237
1297
  end
1238
1298
 
1239
- # Lookup for a single "GA4" MeasurementProtocolSecret.
1240
- # @param [String] name
1241
- # Required. The name of the measurement protocol secret to lookup. Format:
1242
- # properties/`property`/webDataStreams/`webDataStream`/
1243
- # measurementProtocolSecrets/`measurementProtocolSecret` Note: Any type of
1244
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
1299
+ # Lists CustomDimensions on a property.
1300
+ # @param [String] parent
1301
+ # Required. Example format: properties/1234
1302
+ # @param [Fixnum] page_size
1303
+ # The maximum number of resources to return. If unspecified, at most 50
1304
+ # resources will be returned. The maximum value is 200 (higher values will be
1305
+ # coerced to the maximum).
1306
+ # @param [String] page_token
1307
+ # A page token, received from a previous `ListCustomDimensions` call. Provide
1308
+ # this to retrieve the subsequent page. When paginating, all other parameters
1309
+ # provided to `ListCustomDimensions` must match the call that provided the page
1310
+ # token.
1245
1311
  # @param [String] fields
1246
1312
  # Selector specifying which fields to include in a partial response.
1247
1313
  # @param [String] quota_user
@@ -1251,39 +1317,35 @@ module Google
1251
1317
  # Request-specific options
1252
1318
  #
1253
1319
  # @yield [result, err] Result & error if block supplied
1254
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
1320
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse] parsed result object
1255
1321
  # @yieldparam err [StandardError] error object if request failed
1256
1322
  #
1257
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
1323
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse]
1258
1324
  #
1259
1325
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1260
1326
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1261
1327
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1262
- def get_property_android_app_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
1263
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
1264
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1265
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1266
- command.params['name'] = name unless name.nil?
1328
+ def list_property_custom_dimensions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1329
+ command = make_simple_command(:get, 'v1alpha/{+parent}/customDimensions', options)
1330
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse::Representation
1331
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
1332
+ command.params['parent'] = parent unless parent.nil?
1333
+ command.query['pageSize'] = page_size unless page_size.nil?
1334
+ command.query['pageToken'] = page_token unless page_token.nil?
1267
1335
  command.query['fields'] = fields unless fields.nil?
1268
1336
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1269
1337
  execute_or_queue_command(command, &block)
1270
1338
  end
1271
1339
 
1272
- # Returns child MeasurementProtocolSecrets under the specified parent Property.
1273
- # @param [String] parent
1274
- # Required. The resource name of the parent stream. Any type of stream (
1275
- # WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format:
1276
- # properties/`property`/webDataStreams/`webDataStream`/
1277
- # measurementProtocolSecrets
1278
- # @param [Fixnum] page_size
1279
- # The maximum number of resources to return. If unspecified, at most 10
1280
- # resources will be returned. The maximum value is 10. Higher values will be
1281
- # coerced to the maximum.
1282
- # @param [String] page_token
1283
- # A page token, received from a previous `ListMeasurementProtocolSecrets` call.
1284
- # Provide this to retrieve the subsequent page. When paginating, all other
1285
- # parameters provided to `ListMeasurementProtocolSecrets` must match the call
1286
- # that provided the page token.
1340
+ # Updates a CustomDimension on a property.
1341
+ # @param [String] name
1342
+ # Output only. Resource name for this CustomDimension resource. Format:
1343
+ # properties/`property`/customDimensions/`customDimension`
1344
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] google_analytics_admin_v1alpha_custom_dimension_object
1345
+ # @param [String] update_mask
1346
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1347
+ # To replace the entire entity, use one path with the string "*" to match all
1348
+ # fields.
1287
1349
  # @param [String] fields
1288
1350
  # Selector specifying which fields to include in a partial response.
1289
1351
  # @param [String] quota_user
@@ -1293,34 +1355,32 @@ module Google
1293
1355
  # Request-specific options
1294
1356
  #
1295
1357
  # @yield [result, err] Result & error if block supplied
1296
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse] parsed result object
1358
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1297
1359
  # @yieldparam err [StandardError] error object if request failed
1298
1360
  #
1299
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse]
1361
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1300
1362
  #
1301
1363
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1302
1364
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1303
1365
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1304
- def list_property_android_app_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1305
- command = make_simple_command(:get, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
1306
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse::Representation
1307
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
1308
- command.params['parent'] = parent unless parent.nil?
1309
- command.query['pageSize'] = page_size unless page_size.nil?
1310
- command.query['pageToken'] = page_token unless page_token.nil?
1366
+ def patch_property_custom_dimension(name, google_analytics_admin_v1alpha_custom_dimension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1367
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1368
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1369
+ command.request_object = google_analytics_admin_v1alpha_custom_dimension_object
1370
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1371
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1372
+ command.params['name'] = name unless name.nil?
1373
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1311
1374
  command.query['fields'] = fields unless fields.nil?
1312
1375
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1313
1376
  execute_or_queue_command(command, &block)
1314
1377
  end
1315
1378
 
1316
- # Updates a measurement protocol secret.
1379
+ # Archives a CustomMetric on a property.
1317
1380
  # @param [String] name
1318
- # Output only. Resource name of this secret. This secret may be a child of any
1319
- # type of stream. Format: properties/`property`/webDataStreams/`webDataStream`/
1320
- # measurementProtocolSecrets/`measurementProtocolSecret`
1321
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
1322
- # @param [String] update_mask
1323
- # The list of fields to be updated. Omitted fields will not be updated.
1381
+ # Required. The name of the CustomMetric to archive. Example format: properties/
1382
+ # 1234/customMetrics/5678
1383
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest] google_analytics_admin_v1alpha_archive_custom_metric_request_object
1324
1384
  # @param [String] fields
1325
1385
  # Selector specifying which fields to include in a partial response.
1326
1386
  # @param [String] quota_user
@@ -1330,32 +1390,30 @@ module Google
1330
1390
  # Request-specific options
1331
1391
  #
1332
1392
  # @yield [result, err] Result & error if block supplied
1333
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
1393
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1334
1394
  # @yieldparam err [StandardError] error object if request failed
1335
1395
  #
1336
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
1396
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1337
1397
  #
1338
1398
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1339
1399
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1340
1400
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1341
- def patch_property_android_app_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1342
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1343
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1344
- command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
1345
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1346
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1401
+ def archive_property_custom_metric(name, google_analytics_admin_v1alpha_archive_custom_metric_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1402
+ command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1403
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest::Representation
1404
+ command.request_object = google_analytics_admin_v1alpha_archive_custom_metric_request_object
1405
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1406
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1347
1407
  command.params['name'] = name unless name.nil?
1348
- command.query['updateMask'] = update_mask unless update_mask.nil?
1349
1408
  command.query['fields'] = fields unless fields.nil?
1350
1409
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1351
1410
  execute_or_queue_command(command, &block)
1352
1411
  end
1353
1412
 
1354
- # Creates a conversion event with the specified attributes.
1413
+ # Creates a CustomMetric.
1355
1414
  # @param [String] parent
1356
- # Required. The resource name of the parent property where this conversion event
1357
- # will be created. Format: properties/123
1358
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] google_analytics_admin_v1alpha_conversion_event_object
1415
+ # Required. Example format: properties/1234
1416
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] google_analytics_admin_v1alpha_custom_metric_object
1359
1417
  # @param [String] fields
1360
1418
  # Selector specifying which fields to include in a partial response.
1361
1419
  # @param [String] quota_user
@@ -1365,31 +1423,30 @@ module Google
1365
1423
  # Request-specific options
1366
1424
  #
1367
1425
  # @yield [result, err] Result & error if block supplied
1368
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] parsed result object
1426
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1369
1427
  # @yieldparam err [StandardError] error object if request failed
1370
1428
  #
1371
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
1429
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1372
1430
  #
1373
1431
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1374
1432
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1375
1433
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1376
- def create_property_conversion_event(parent, google_analytics_admin_v1alpha_conversion_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1377
- command = make_simple_command(:post, 'v1alpha/{+parent}/conversionEvents', options)
1378
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1379
- command.request_object = google_analytics_admin_v1alpha_conversion_event_object
1380
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1381
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent
1434
+ def create_property_custom_metric(parent, google_analytics_admin_v1alpha_custom_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1435
+ command = make_simple_command(:post, 'v1alpha/{+parent}/customMetrics', options)
1436
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1437
+ command.request_object = google_analytics_admin_v1alpha_custom_metric_object
1438
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1439
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1382
1440
  command.params['parent'] = parent unless parent.nil?
1383
1441
  command.query['fields'] = fields unless fields.nil?
1384
1442
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1385
1443
  execute_or_queue_command(command, &block)
1386
1444
  end
1387
1445
 
1388
- # Deletes a conversion event in a property.
1446
+ # Lookup for a single CustomMetric.
1389
1447
  # @param [String] name
1390
- # Required. The resource name of the conversion event to delete. Format:
1391
- # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
1392
- # 123/conversionEvents/456"
1448
+ # Required. The name of the CustomMetric to get. Example format: properties/1234/
1449
+ # customMetrics/5678
1393
1450
  # @param [String] fields
1394
1451
  # Selector specifying which fields to include in a partial response.
1395
1452
  # @param [String] quota_user
@@ -1399,29 +1456,74 @@ module Google
1399
1456
  # Request-specific options
1400
1457
  #
1401
1458
  # @yield [result, err] Result & error if block supplied
1402
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1459
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1403
1460
  # @yieldparam err [StandardError] error object if request failed
1404
1461
  #
1405
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1462
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1406
1463
  #
1407
1464
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1408
1465
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1409
1466
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1410
- def delete_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
1411
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1412
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1413
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1467
+ def get_property_custom_metric(name, fields: nil, quota_user: nil, options: nil, &block)
1468
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1469
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1470
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1414
1471
  command.params['name'] = name unless name.nil?
1415
1472
  command.query['fields'] = fields unless fields.nil?
1416
1473
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1417
1474
  execute_or_queue_command(command, &block)
1418
1475
  end
1419
1476
 
1420
- # Retrieve a single conversion event.
1477
+ # Lists CustomMetrics on a property.
1478
+ # @param [String] parent
1479
+ # Required. Example format: properties/1234
1480
+ # @param [Fixnum] page_size
1481
+ # The maximum number of resources to return. If unspecified, at most 50
1482
+ # resources will be returned. The maximum value is 200 (higher values will be
1483
+ # coerced to the maximum).
1484
+ # @param [String] page_token
1485
+ # A page token, received from a previous `ListCustomMetrics` call. Provide this
1486
+ # to retrieve the subsequent page. When paginating, all other parameters
1487
+ # provided to `ListCustomMetrics` must match the call that provided the page
1488
+ # token.
1489
+ # @param [String] fields
1490
+ # Selector specifying which fields to include in a partial response.
1491
+ # @param [String] quota_user
1492
+ # Available to use for quota purposes for server-side applications. Can be any
1493
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1494
+ # @param [Google::Apis::RequestOptions] options
1495
+ # Request-specific options
1496
+ #
1497
+ # @yield [result, err] Result & error if block supplied
1498
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse] parsed result object
1499
+ # @yieldparam err [StandardError] error object if request failed
1500
+ #
1501
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse]
1502
+ #
1503
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1504
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1505
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1506
+ def list_property_custom_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1507
+ command = make_simple_command(:get, 'v1alpha/{+parent}/customMetrics', options)
1508
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse::Representation
1509
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
1510
+ command.params['parent'] = parent unless parent.nil?
1511
+ command.query['pageSize'] = page_size unless page_size.nil?
1512
+ command.query['pageToken'] = page_token unless page_token.nil?
1513
+ command.query['fields'] = fields unless fields.nil?
1514
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1515
+ execute_or_queue_command(command, &block)
1516
+ end
1517
+
1518
+ # Updates a CustomMetric on a property.
1421
1519
  # @param [String] name
1422
- # Required. The resource name of the conversion event to retrieve. Format:
1423
- # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
1424
- # 123/conversionEvents/456"
1520
+ # Output only. Resource name for this CustomMetric resource. Format: properties/`
1521
+ # property`/customMetrics/`customMetric`
1522
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] google_analytics_admin_v1alpha_custom_metric_object
1523
+ # @param [String] update_mask
1524
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1525
+ # To replace the entire entity, use one path with the string "*" to match all
1526
+ # fields.
1425
1527
  # @param [String] fields
1426
1528
  # Selector specifying which fields to include in a partial response.
1427
1529
  # @param [String] quota_user
@@ -1431,37 +1533,31 @@ module Google
1431
1533
  # Request-specific options
1432
1534
  #
1433
1535
  # @yield [result, err] Result & error if block supplied
1434
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] parsed result object
1536
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1435
1537
  # @yieldparam err [StandardError] error object if request failed
1436
1538
  #
1437
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
1539
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1438
1540
  #
1439
1541
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1440
1542
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1441
1543
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1442
- def get_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
1443
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
1444
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1445
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent
1544
+ def patch_property_custom_metric(name, google_analytics_admin_v1alpha_custom_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1545
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1546
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1547
+ command.request_object = google_analytics_admin_v1alpha_custom_metric_object
1548
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1549
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1446
1550
  command.params['name'] = name unless name.nil?
1551
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1447
1552
  command.query['fields'] = fields unless fields.nil?
1448
1553
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1449
1554
  execute_or_queue_command(command, &block)
1450
1555
  end
1451
1556
 
1452
- # Returns a list of conversion events in the specified parent property. Returns
1453
- # an empty list if no conversion events are found.
1557
+ # Creates a DataStream.
1454
1558
  # @param [String] parent
1455
- # Required. The resource name of the parent property. Example: 'properties/123'
1456
- # @param [Fixnum] page_size
1457
- # The maximum number of resources to return. If unspecified, at most 50
1458
- # resources will be returned. The maximum value is 200; (higher values will be
1459
- # coerced to the maximum)
1460
- # @param [String] page_token
1461
- # A page token, received from a previous `ListConversionEvents` call. Provide
1462
- # this to retrieve the subsequent page. When paginating, all other parameters
1463
- # provided to `ListConversionEvents` must match the call that provided the page
1464
- # token.
1559
+ # Required. Example format: properties/1234
1560
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream] google_analytics_admin_v1alpha_data_stream_object
1465
1561
  # @param [String] fields
1466
1562
  # Selector specifying which fields to include in a partial response.
1467
1563
  # @param [String] quota_user
@@ -1471,31 +1567,30 @@ module Google
1471
1567
  # Request-specific options
1472
1568
  #
1473
1569
  # @yield [result, err] Result & error if block supplied
1474
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse] parsed result object
1570
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream] parsed result object
1475
1571
  # @yieldparam err [StandardError] error object if request failed
1476
1572
  #
1477
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse]
1573
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream]
1478
1574
  #
1479
1575
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1480
1576
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1481
1577
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1482
- def list_property_conversion_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1483
- command = make_simple_command(:get, 'v1alpha/{+parent}/conversionEvents', options)
1484
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse::Representation
1485
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1578
+ def create_property_data_stream(parent, google_analytics_admin_v1alpha_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1579
+ command = make_simple_command(:post, 'v1alpha/{+parent}/dataStreams', options)
1580
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream::Representation
1581
+ command.request_object = google_analytics_admin_v1alpha_data_stream_object
1582
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream::Representation
1583
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream
1486
1584
  command.params['parent'] = parent unless parent.nil?
1487
- command.query['pageSize'] = page_size unless page_size.nil?
1488
- command.query['pageToken'] = page_token unless page_token.nil?
1489
1585
  command.query['fields'] = fields unless fields.nil?
1490
1586
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1491
1587
  execute_or_queue_command(command, &block)
1492
1588
  end
1493
1589
 
1494
- # Archives a CustomDimension on a property.
1590
+ # Deletes a DataStream on a property.
1495
1591
  # @param [String] name
1496
- # Required. The name of the CustomDimension to archive. Example format:
1497
- # properties/1234/customDimensions/5678
1498
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest] google_analytics_admin_v1alpha_archive_custom_dimension_request_object
1592
+ # Required. The name of the DataStream to delete. Example format: properties/
1593
+ # 1234/dataStreams/5678
1499
1594
  # @param [String] fields
1500
1595
  # Selector specifying which fields to include in a partial response.
1501
1596
  # @param [String] quota_user
@@ -1513,10 +1608,8 @@ module Google
1513
1608
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1514
1609
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1515
1610
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1516
- def archive_property_custom_dimension(name, google_analytics_admin_v1alpha_archive_custom_dimension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1517
- command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1518
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest::Representation
1519
- command.request_object = google_analytics_admin_v1alpha_archive_custom_dimension_request_object
1611
+ def delete_property_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
1612
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1520
1613
  command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1521
1614
  command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1522
1615
  command.params['name'] = name unless name.nil?
@@ -1525,10 +1618,10 @@ module Google
1525
1618
  execute_or_queue_command(command, &block)
1526
1619
  end
1527
1620
 
1528
- # Creates a CustomDimension.
1529
- # @param [String] parent
1530
- # Required. Example format: properties/1234
1531
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] google_analytics_admin_v1alpha_custom_dimension_object
1621
+ # Lookup for a single DataStream.
1622
+ # @param [String] name
1623
+ # Required. The name of the DataStream to get. Example format: properties/1234/
1624
+ # dataStreams/5678
1532
1625
  # @param [String] fields
1533
1626
  # Selector specifying which fields to include in a partial response.
1534
1627
  # @param [String] quota_user
@@ -1538,30 +1631,31 @@ module Google
1538
1631
  # Request-specific options
1539
1632
  #
1540
1633
  # @yield [result, err] Result & error if block supplied
1541
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1634
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream] parsed result object
1542
1635
  # @yieldparam err [StandardError] error object if request failed
1543
1636
  #
1544
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1637
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream]
1545
1638
  #
1546
1639
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1547
1640
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1548
1641
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1549
- def create_property_custom_dimension(parent, google_analytics_admin_v1alpha_custom_dimension_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1550
- command = make_simple_command(:post, 'v1alpha/{+parent}/customDimensions', options)
1551
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1552
- command.request_object = google_analytics_admin_v1alpha_custom_dimension_object
1553
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1554
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1555
- command.params['parent'] = parent unless parent.nil?
1642
+ def get_property_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
1643
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1644
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream::Representation
1645
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream
1646
+ command.params['name'] = name unless name.nil?
1556
1647
  command.query['fields'] = fields unless fields.nil?
1557
1648
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1558
1649
  execute_or_queue_command(command, &block)
1559
1650
  end
1560
1651
 
1561
- # Lookup for a single CustomDimension.
1652
+ # Returns the Site Tag for the specified web stream. Site Tags are immutable
1653
+ # singletons.
1562
1654
  # @param [String] name
1563
- # Required. The name of the CustomDimension to get. Example format: properties/
1564
- # 1234/customDimensions/5678
1655
+ # Required. The name of the site tag to lookup. Note that site tags are
1656
+ # singletons and do not have unique IDs. Format: properties/`property_id`/
1657
+ # dataStreams/`stream_id`/globalSiteTag Example: "properties/123/dataStreams/456/
1658
+ # globalSiteTag"
1565
1659
  # @param [String] fields
1566
1660
  # Selector specifying which fields to include in a partial response.
1567
1661
  # @param [String] quota_user
@@ -1571,25 +1665,25 @@ module Google
1571
1665
  # Request-specific options
1572
1666
  #
1573
1667
  # @yield [result, err] Result & error if block supplied
1574
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1668
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag] parsed result object
1575
1669
  # @yieldparam err [StandardError] error object if request failed
1576
1670
  #
1577
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1671
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag]
1578
1672
  #
1579
1673
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1580
1674
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1581
1675
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1582
- def get_property_custom_dimension(name, fields: nil, quota_user: nil, options: nil, &block)
1676
+ def get_property_data_stream_global_site_tag(name, fields: nil, quota_user: nil, options: nil, &block)
1583
1677
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
1584
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1585
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1678
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag::Representation
1679
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag
1586
1680
  command.params['name'] = name unless name.nil?
1587
1681
  command.query['fields'] = fields unless fields.nil?
1588
1682
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1589
1683
  execute_or_queue_command(command, &block)
1590
1684
  end
1591
1685
 
1592
- # Lists CustomDimensions on a property.
1686
+ # Lists DataStreams on a property.
1593
1687
  # @param [String] parent
1594
1688
  # Required. Example format: properties/1234
1595
1689
  # @param [Fixnum] page_size
@@ -1597,10 +1691,9 @@ module Google
1597
1691
  # resources will be returned. The maximum value is 200 (higher values will be
1598
1692
  # coerced to the maximum).
1599
1693
  # @param [String] page_token
1600
- # A page token, received from a previous `ListCustomDimensions` call. Provide
1601
- # this to retrieve the subsequent page. When paginating, all other parameters
1602
- # provided to `ListCustomDimensions` must match the call that provided the page
1603
- # token.
1694
+ # A page token, received from a previous `ListDataStreams` call. Provide this to
1695
+ # retrieve the subsequent page. When paginating, all other parameters provided
1696
+ # to `ListDataStreams` must match the call that provided the page token.
1604
1697
  # @param [String] fields
1605
1698
  # Selector specifying which fields to include in a partial response.
1606
1699
  # @param [String] quota_user
@@ -1610,18 +1703,18 @@ module Google
1610
1703
  # Request-specific options
1611
1704
  #
1612
1705
  # @yield [result, err] Result & error if block supplied
1613
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse] parsed result object
1706
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListDataStreamsResponse] parsed result object
1614
1707
  # @yieldparam err [StandardError] error object if request failed
1615
1708
  #
1616
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse]
1709
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListDataStreamsResponse]
1617
1710
  #
1618
1711
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1619
1712
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1620
1713
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1621
- def list_property_custom_dimensions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1622
- command = make_simple_command(:get, 'v1alpha/{+parent}/customDimensions', options)
1623
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse::Representation
1624
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
1714
+ def list_property_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1715
+ command = make_simple_command(:get, 'v1alpha/{+parent}/dataStreams', options)
1716
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListDataStreamsResponse::Representation
1717
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListDataStreamsResponse
1625
1718
  command.params['parent'] = parent unless parent.nil?
1626
1719
  command.query['pageSize'] = page_size unless page_size.nil?
1627
1720
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -1630,11 +1723,12 @@ module Google
1630
1723
  execute_or_queue_command(command, &block)
1631
1724
  end
1632
1725
 
1633
- # Updates a CustomDimension on a property.
1726
+ # Updates a DataStream on a property.
1634
1727
  # @param [String] name
1635
- # Output only. Resource name for this CustomDimension resource. Format:
1636
- # properties/`property`/customDimensions/`customDimension`
1637
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] google_analytics_admin_v1alpha_custom_dimension_object
1728
+ # Output only. Resource name of this Data Stream. Format: properties/`
1729
+ # property_id`/dataStreams/`stream_id` Example: "properties/1000/dataStreams/
1730
+ # 2000"
1731
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream] google_analytics_admin_v1alpha_data_stream_object
1638
1732
  # @param [String] update_mask
1639
1733
  # Required. The list of fields to be updated. Omitted fields will not be updated.
1640
1734
  # To replace the entire entity, use one path with the string "*" to match all
@@ -1648,20 +1742,20 @@ module Google
1648
1742
  # Request-specific options
1649
1743
  #
1650
1744
  # @yield [result, err] Result & error if block supplied
1651
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1745
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream] parsed result object
1652
1746
  # @yieldparam err [StandardError] error object if request failed
1653
1747
  #
1654
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1748
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream]
1655
1749
  #
1656
1750
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1657
1751
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1658
1752
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1659
- def patch_property_custom_dimension(name, google_analytics_admin_v1alpha_custom_dimension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1753
+ def patch_property_data_stream(name, google_analytics_admin_v1alpha_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1660
1754
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1661
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1662
- command.request_object = google_analytics_admin_v1alpha_custom_dimension_object
1663
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1664
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1755
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream::Representation
1756
+ command.request_object = google_analytics_admin_v1alpha_data_stream_object
1757
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream::Representation
1758
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream
1665
1759
  command.params['name'] = name unless name.nil?
1666
1760
  command.query['updateMask'] = update_mask unless update_mask.nil?
1667
1761
  command.query['fields'] = fields unless fields.nil?
@@ -1669,11 +1763,11 @@ module Google
1669
1763
  execute_or_queue_command(command, &block)
1670
1764
  end
1671
1765
 
1672
- # Archives a CustomMetric on a property.
1673
- # @param [String] name
1674
- # Required. The name of the CustomMetric to archive. Example format: properties/
1675
- # 1234/customMetrics/5678
1676
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest] google_analytics_admin_v1alpha_archive_custom_metric_request_object
1766
+ # Creates a measurement protocol secret.
1767
+ # @param [String] parent
1768
+ # Required. The parent resource where this secret will be created. Format:
1769
+ # properties/`property`/dataStreams/`dataStream`
1770
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
1677
1771
  # @param [String] fields
1678
1772
  # Selector specifying which fields to include in a partial response.
1679
1773
  # @param [String] quota_user
@@ -1683,30 +1777,31 @@ module Google
1683
1777
  # Request-specific options
1684
1778
  #
1685
1779
  # @yield [result, err] Result & error if block supplied
1686
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1780
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
1687
1781
  # @yieldparam err [StandardError] error object if request failed
1688
1782
  #
1689
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1783
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
1690
1784
  #
1691
1785
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1692
1786
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1693
1787
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1694
- def archive_property_custom_metric(name, google_analytics_admin_v1alpha_archive_custom_metric_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1695
- command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1696
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest::Representation
1697
- command.request_object = google_analytics_admin_v1alpha_archive_custom_metric_request_object
1698
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1699
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1700
- command.params['name'] = name unless name.nil?
1788
+ def create_property_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1789
+ command = make_simple_command(:post, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
1790
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1791
+ command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
1792
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1793
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1794
+ command.params['parent'] = parent unless parent.nil?
1701
1795
  command.query['fields'] = fields unless fields.nil?
1702
1796
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1703
1797
  execute_or_queue_command(command, &block)
1704
1798
  end
1705
1799
 
1706
- # Creates a CustomMetric.
1707
- # @param [String] parent
1708
- # Required. Example format: properties/1234
1709
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] google_analytics_admin_v1alpha_custom_metric_object
1800
+ # Deletes target MeasurementProtocolSecret.
1801
+ # @param [String] name
1802
+ # Required. The name of the MeasurementProtocolSecret to delete. Format:
1803
+ # properties/`property`/dataStreams/`dataStream`/measurementProtocolSecrets/`
1804
+ # measurementProtocolSecret`
1710
1805
  # @param [String] fields
1711
1806
  # Selector specifying which fields to include in a partial response.
1712
1807
  # @param [String] quota_user
@@ -1716,30 +1811,29 @@ module Google
1716
1811
  # Request-specific options
1717
1812
  #
1718
1813
  # @yield [result, err] Result & error if block supplied
1719
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1814
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1720
1815
  # @yieldparam err [StandardError] error object if request failed
1721
1816
  #
1722
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1817
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1723
1818
  #
1724
1819
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1725
1820
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1726
1821
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1727
- def create_property_custom_metric(parent, google_analytics_admin_v1alpha_custom_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1728
- command = make_simple_command(:post, 'v1alpha/{+parent}/customMetrics', options)
1729
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1730
- command.request_object = google_analytics_admin_v1alpha_custom_metric_object
1731
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1732
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1733
- command.params['parent'] = parent unless parent.nil?
1822
+ def delete_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
1823
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1824
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1825
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1826
+ command.params['name'] = name unless name.nil?
1734
1827
  command.query['fields'] = fields unless fields.nil?
1735
1828
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1736
1829
  execute_or_queue_command(command, &block)
1737
1830
  end
1738
1831
 
1739
- # Lookup for a single CustomMetric.
1832
+ # Lookup for a single "GA4" MeasurementProtocolSecret.
1740
1833
  # @param [String] name
1741
- # Required. The name of the CustomMetric to get. Example format: properties/1234/
1742
- # customMetrics/5678
1834
+ # Required. The name of the measurement protocol secret to lookup. Format:
1835
+ # properties/`property`/dataStreams/`dataStream`/measurementProtocolSecrets/`
1836
+ # measurementProtocolSecret`
1743
1837
  # @param [String] fields
1744
1838
  # Selector specifying which fields to include in a partial response.
1745
1839
  # @param [String] quota_user
@@ -1749,36 +1843,37 @@ module Google
1749
1843
  # Request-specific options
1750
1844
  #
1751
1845
  # @yield [result, err] Result & error if block supplied
1752
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1846
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
1753
1847
  # @yieldparam err [StandardError] error object if request failed
1754
1848
  #
1755
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1849
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
1756
1850
  #
1757
1851
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1758
1852
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1759
1853
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1760
- def get_property_custom_metric(name, fields: nil, quota_user: nil, options: nil, &block)
1854
+ def get_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
1761
1855
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
1762
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1763
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1856
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1857
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1764
1858
  command.params['name'] = name unless name.nil?
1765
1859
  command.query['fields'] = fields unless fields.nil?
1766
1860
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1767
1861
  execute_or_queue_command(command, &block)
1768
1862
  end
1769
1863
 
1770
- # Lists CustomMetrics on a property.
1864
+ # Returns child MeasurementProtocolSecrets under the specified parent Property.
1771
1865
  # @param [String] parent
1772
- # Required. Example format: properties/1234
1866
+ # Required. The resource name of the parent stream. Format: properties/`property`
1867
+ # /dataStreams/`dataStream`/measurementProtocolSecrets
1773
1868
  # @param [Fixnum] page_size
1774
- # The maximum number of resources to return. If unspecified, at most 50
1775
- # resources will be returned. The maximum value is 200 (higher values will be
1776
- # coerced to the maximum).
1869
+ # The maximum number of resources to return. If unspecified, at most 10
1870
+ # resources will be returned. The maximum value is 10. Higher values will be
1871
+ # coerced to the maximum.
1777
1872
  # @param [String] page_token
1778
- # A page token, received from a previous `ListCustomMetrics` call. Provide this
1779
- # to retrieve the subsequent page. When paginating, all other parameters
1780
- # provided to `ListCustomMetrics` must match the call that provided the page
1781
- # token.
1873
+ # A page token, received from a previous `ListMeasurementProtocolSecrets` call.
1874
+ # Provide this to retrieve the subsequent page. When paginating, all other
1875
+ # parameters provided to `ListMeasurementProtocolSecrets` must match the call
1876
+ # that provided the page token.
1782
1877
  # @param [String] fields
1783
1878
  # Selector specifying which fields to include in a partial response.
1784
1879
  # @param [String] quota_user
@@ -1788,18 +1883,18 @@ module Google
1788
1883
  # Request-specific options
1789
1884
  #
1790
1885
  # @yield [result, err] Result & error if block supplied
1791
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse] parsed result object
1886
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse] parsed result object
1792
1887
  # @yieldparam err [StandardError] error object if request failed
1793
1888
  #
1794
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse]
1889
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse]
1795
1890
  #
1796
1891
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1797
1892
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1798
1893
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1799
- def list_property_custom_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1800
- command = make_simple_command(:get, 'v1alpha/{+parent}/customMetrics', options)
1801
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse::Representation
1802
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
1894
+ def list_property_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1895
+ command = make_simple_command(:get, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
1896
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse::Representation
1897
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
1803
1898
  command.params['parent'] = parent unless parent.nil?
1804
1899
  command.query['pageSize'] = page_size unless page_size.nil?
1805
1900
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -1808,15 +1903,14 @@ module Google
1808
1903
  execute_or_queue_command(command, &block)
1809
1904
  end
1810
1905
 
1811
- # Updates a CustomMetric on a property.
1906
+ # Updates a measurement protocol secret.
1812
1907
  # @param [String] name
1813
- # Output only. Resource name for this CustomMetric resource. Format: properties/`
1814
- # property`/customMetrics/`customMetric`
1815
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] google_analytics_admin_v1alpha_custom_metric_object
1908
+ # Output only. Resource name of this secret. This secret may be a child of any
1909
+ # type of stream. Format: properties/`property`/webDataStreams/`webDataStream`/
1910
+ # measurementProtocolSecrets/`measurementProtocolSecret`
1911
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
1816
1912
  # @param [String] update_mask
1817
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1818
- # To replace the entire entity, use one path with the string "*" to match all
1819
- # fields.
1913
+ # The list of fields to be updated. Omitted fields will not be updated.
1820
1914
  # @param [String] fields
1821
1915
  # Selector specifying which fields to include in a partial response.
1822
1916
  # @param [String] quota_user
@@ -1826,20 +1920,20 @@ module Google
1826
1920
  # Request-specific options
1827
1921
  #
1828
1922
  # @yield [result, err] Result & error if block supplied
1829
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1923
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
1830
1924
  # @yieldparam err [StandardError] error object if request failed
1831
1925
  #
1832
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1926
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
1833
1927
  #
1834
1928
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1835
1929
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1836
1930
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1837
- def patch_property_custom_metric(name, google_analytics_admin_v1alpha_custom_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1931
+ def patch_property_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1838
1932
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1839
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1840
- command.request_object = google_analytics_admin_v1alpha_custom_metric_object
1841
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1842
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1933
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1934
+ command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
1935
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
1936
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1843
1937
  command.params['name'] = name unless name.nil?
1844
1938
  command.query['updateMask'] = update_mask unless update_mask.nil?
1845
1939
  command.query['fields'] = fields unless fields.nil?
@@ -2487,11 +2581,15 @@ module Google
2487
2581
  execute_or_queue_command(command, &block)
2488
2582
  end
2489
2583
 
2490
- # Deletes an iOS app stream on a property.
2491
- # @param [String] name
2492
- # Required. The name of the iOS app data stream to delete. Format: properties/`
2493
- # property_id`/iosAppDataStreams/`stream_id` Example: "properties/123/
2494
- # iosAppDataStreams/456"
2584
+ # Lists all user links on an account or property, including implicit ones that
2585
+ # come from effective permissions granted by groups or organization admin roles.
2586
+ # If a returned user link does not have direct permissions, they cannot be
2587
+ # removed from the account or property directly with the DeleteUserLink command.
2588
+ # They have to be removed from the group/etc that gives them permissions, which
2589
+ # is currently only usable/discoverable in the GA or GMP UIs.
2590
+ # @param [String] parent
2591
+ # Required. Example format: accounts/1234
2592
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest] google_analytics_admin_v1alpha_audit_user_links_request_object
2495
2593
  # @param [String] fields
2496
2594
  # Selector specifying which fields to include in a partial response.
2497
2595
  # @param [String] quota_user
@@ -2501,29 +2599,34 @@ module Google
2501
2599
  # Request-specific options
2502
2600
  #
2503
2601
  # @yield [result, err] Result & error if block supplied
2504
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
2602
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse] parsed result object
2505
2603
  # @yieldparam err [StandardError] error object if request failed
2506
2604
  #
2507
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
2605
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse]
2508
2606
  #
2509
2607
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2510
2608
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2511
2609
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2512
- def delete_property_ios_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
2513
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2514
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
2515
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
2516
- command.params['name'] = name unless name.nil?
2610
+ def audit_property_user_link(parent, google_analytics_admin_v1alpha_audit_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2611
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:audit', options)
2612
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest::Representation
2613
+ command.request_object = google_analytics_admin_v1alpha_audit_user_links_request_object
2614
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse::Representation
2615
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
2616
+ command.params['parent'] = parent unless parent.nil?
2517
2617
  command.query['fields'] = fields unless fields.nil?
2518
2618
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2519
2619
  execute_or_queue_command(command, &block)
2520
2620
  end
2521
2621
 
2522
- # Lookup for a single IosAppDataStream
2523
- # @param [String] name
2524
- # Required. The name of the iOS app data stream to lookup. Format: properties/`
2525
- # property_id`/iosAppDataStreams/`stream_id` Example: "properties/123/
2526
- # iosAppDataStreams/456"
2622
+ # Creates information about multiple users' links to an account or property.
2623
+ # This method is transactional. If any UserLink cannot be created, none of the
2624
+ # UserLinks will be created.
2625
+ # @param [String] parent
2626
+ # Required. The account or property that all user links in the request are for.
2627
+ # This field is required. The parent field in the CreateUserLinkRequest messages
2628
+ # must either be empty or match this field. Example format: accounts/1234
2629
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest] google_analytics_admin_v1alpha_batch_create_user_links_request_object
2527
2630
  # @param [String] fields
2528
2631
  # Selector specifying which fields to include in a partial response.
2529
2632
  # @param [String] quota_user
@@ -2533,39 +2636,32 @@ module Google
2533
2636
  # Request-specific options
2534
2637
  #
2535
2638
  # @yield [result, err] Result & error if block supplied
2536
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] parsed result object
2639
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse] parsed result object
2537
2640
  # @yieldparam err [StandardError] error object if request failed
2538
2641
  #
2539
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
2642
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse]
2540
2643
  #
2541
2644
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2542
2645
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2543
2646
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2544
- def get_property_ios_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
2545
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
2546
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
2547
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream
2548
- command.params['name'] = name unless name.nil?
2647
+ def batch_property_user_link_create(parent, google_analytics_admin_v1alpha_batch_create_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2648
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchCreate', options)
2649
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest::Representation
2650
+ command.request_object = google_analytics_admin_v1alpha_batch_create_user_links_request_object
2651
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse::Representation
2652
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
2653
+ command.params['parent'] = parent unless parent.nil?
2549
2654
  command.query['fields'] = fields unless fields.nil?
2550
2655
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2551
2656
  execute_or_queue_command(command, &block)
2552
2657
  end
2553
2658
 
2554
- # Returns child iOS app data streams under the specified parent property. iOS
2555
- # app data streams will be excluded if the caller does not have access. Returns
2556
- # an empty list if no relevant iOS app data streams are found.
2659
+ # Deletes information about multiple users' links to an account or property.
2557
2660
  # @param [String] parent
2558
- # Required. The name of the parent property. For example, to list results of app
2559
- # streams under the property with Id 123: "properties/123"
2560
- # @param [Fixnum] page_size
2561
- # The maximum number of resources to return. If unspecified, at most 50
2562
- # resources will be returned. The maximum value is 200; (higher values will be
2563
- # coerced to the maximum)
2564
- # @param [String] page_token
2565
- # A page token, received from a previous `ListIosAppDataStreams` call. Provide
2566
- # this to retrieve the subsequent page. When paginating, all other parameters
2567
- # provided to `ListIosAppDataStreams` must match the call that provided the page
2568
- # token.
2661
+ # Required. The account or property that all user links in the request are for.
2662
+ # The parent of all values for user link names to delete must match this field.
2663
+ # Example format: accounts/1234
2664
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest] google_analytics_admin_v1alpha_batch_delete_user_links_request_object
2569
2665
  # @param [String] fields
2570
2666
  # Selector specifying which fields to include in a partial response.
2571
2667
  # @param [String] quota_user
@@ -2575,36 +2671,35 @@ module Google
2575
2671
  # Request-specific options
2576
2672
  #
2577
2673
  # @yield [result, err] Result & error if block supplied
2578
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse] parsed result object
2674
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
2579
2675
  # @yieldparam err [StandardError] error object if request failed
2580
2676
  #
2581
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse]
2677
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
2582
2678
  #
2583
2679
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2584
2680
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2585
2681
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2586
- def list_property_ios_app_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2587
- command = make_simple_command(:get, 'v1alpha/{+parent}/iosAppDataStreams', options)
2588
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse::Representation
2589
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse
2682
+ def batch_property_user_link_delete(parent, google_analytics_admin_v1alpha_batch_delete_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2683
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchDelete', options)
2684
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest::Representation
2685
+ command.request_object = google_analytics_admin_v1alpha_batch_delete_user_links_request_object
2686
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
2687
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
2590
2688
  command.params['parent'] = parent unless parent.nil?
2591
- command.query['pageSize'] = page_size unless page_size.nil?
2592
- command.query['pageToken'] = page_token unless page_token.nil?
2593
2689
  command.query['fields'] = fields unless fields.nil?
2594
2690
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2595
2691
  execute_or_queue_command(command, &block)
2596
2692
  end
2597
2693
 
2598
- # Updates an iOS app stream on a property.
2599
- # @param [String] name
2600
- # Output only. Resource name of this Data Stream. Format: properties/`
2601
- # property_id`/iosAppDataStreams/`stream_id` Example: "properties/1000/
2602
- # iosAppDataStreams/2000"
2603
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] google_analytics_admin_v1alpha_ios_app_data_stream_object
2604
- # @param [String] update_mask
2605
- # Required. The list of fields to be updated. Field names must be in snake case (
2606
- # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
2607
- # entire entity, use one path with the string "*" to match all fields.
2694
+ # Gets information about multiple users' links to an account or property.
2695
+ # @param [String] parent
2696
+ # Required. The account or property that all user links in the request are for.
2697
+ # The parent of all provided values for the 'names' field must match this field.
2698
+ # Example format: accounts/1234
2699
+ # @param [Array<String>, String] names
2700
+ # Required. The names of the user links to retrieve. A maximum of 1000 user
2701
+ # links can be retrieved in a batch. Format: accounts/`accountId`/userLinks/`
2702
+ # userLinkId`
2608
2703
  # @param [String] fields
2609
2704
  # Selector specifying which fields to include in a partial response.
2610
2705
  # @param [String] quota_user
@@ -2614,33 +2709,31 @@ module Google
2614
2709
  # Request-specific options
2615
2710
  #
2616
2711
  # @yield [result, err] Result & error if block supplied
2617
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] parsed result object
2712
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse] parsed result object
2618
2713
  # @yieldparam err [StandardError] error object if request failed
2619
2714
  #
2620
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
2715
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse]
2621
2716
  #
2622
2717
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2623
2718
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2624
2719
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2625
- def patch_property_ios_app_data_stream(name, google_analytics_admin_v1alpha_ios_app_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2626
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2627
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
2628
- command.request_object = google_analytics_admin_v1alpha_ios_app_data_stream_object
2629
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
2630
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream
2631
- command.params['name'] = name unless name.nil?
2632
- command.query['updateMask'] = update_mask unless update_mask.nil?
2720
+ def batch_property_user_link_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
2721
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks:batchGet', options)
2722
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse::Representation
2723
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
2724
+ command.params['parent'] = parent unless parent.nil?
2725
+ command.query['names'] = names unless names.nil?
2633
2726
  command.query['fields'] = fields unless fields.nil?
2634
2727
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2635
2728
  execute_or_queue_command(command, &block)
2636
2729
  end
2637
2730
 
2638
- # Creates a measurement protocol secret.
2731
+ # Updates information about multiple users' links to an account or property.
2639
2732
  # @param [String] parent
2640
- # Required. The parent resource where this secret will be created. Any type of
2641
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
2642
- # Format: properties/`property`/webDataStreams/`webDataStream`
2643
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
2733
+ # Required. The account or property that all user links in the request are for.
2734
+ # The parent field in the UpdateUserLinkRequest messages must either be empty or
2735
+ # match this field. Example format: accounts/1234
2736
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest] google_analytics_admin_v1alpha_batch_update_user_links_request_object
2644
2737
  # @param [String] fields
2645
2738
  # Selector specifying which fields to include in a partial response.
2646
2739
  # @param [String] quota_user
@@ -2650,32 +2743,69 @@ module Google
2650
2743
  # Request-specific options
2651
2744
  #
2652
2745
  # @yield [result, err] Result & error if block supplied
2653
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
2746
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse] parsed result object
2654
2747
  # @yieldparam err [StandardError] error object if request failed
2655
2748
  #
2656
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
2749
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse]
2657
2750
  #
2658
2751
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2659
2752
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2660
2753
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2661
- def create_property_ios_app_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2662
- command = make_simple_command(:post, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
2663
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
2664
- command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
2665
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
2666
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
2754
+ def batch_property_user_link_update(parent, google_analytics_admin_v1alpha_batch_update_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2755
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchUpdate', options)
2756
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest::Representation
2757
+ command.request_object = google_analytics_admin_v1alpha_batch_update_user_links_request_object
2758
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse::Representation
2759
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
2667
2760
  command.params['parent'] = parent unless parent.nil?
2668
2761
  command.query['fields'] = fields unless fields.nil?
2669
2762
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2670
2763
  execute_or_queue_command(command, &block)
2671
2764
  end
2672
2765
 
2673
- # Deletes target MeasurementProtocolSecret.
2766
+ # Creates a user link on an account or property. If the user with the specified
2767
+ # email already has permissions on the account or property, then the user's
2768
+ # existing permissions will be unioned with the permissions specified in the new
2769
+ # UserLink.
2770
+ # @param [String] parent
2771
+ # Required. Example format: accounts/1234
2772
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
2773
+ # @param [Boolean] notify_new_user
2774
+ # Optional. If set, then email the new user notifying them that they've been
2775
+ # granted permissions to the resource.
2776
+ # @param [String] fields
2777
+ # Selector specifying which fields to include in a partial response.
2778
+ # @param [String] quota_user
2779
+ # Available to use for quota purposes for server-side applications. Can be any
2780
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2781
+ # @param [Google::Apis::RequestOptions] options
2782
+ # Request-specific options
2783
+ #
2784
+ # @yield [result, err] Result & error if block supplied
2785
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
2786
+ # @yieldparam err [StandardError] error object if request failed
2787
+ #
2788
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
2789
+ #
2790
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2791
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2792
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2793
+ def create_property_user_link(parent, google_analytics_admin_v1alpha_user_link_object = nil, notify_new_user: nil, fields: nil, quota_user: nil, options: nil, &block)
2794
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks', options)
2795
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
2796
+ command.request_object = google_analytics_admin_v1alpha_user_link_object
2797
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
2798
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
2799
+ command.params['parent'] = parent unless parent.nil?
2800
+ command.query['notifyNewUser'] = notify_new_user unless notify_new_user.nil?
2801
+ command.query['fields'] = fields unless fields.nil?
2802
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2803
+ execute_or_queue_command(command, &block)
2804
+ end
2805
+
2806
+ # Deletes a user link on an account or property.
2674
2807
  # @param [String] name
2675
- # Required. The name of the MeasurementProtocolSecret to delete. Format:
2676
- # properties/`property`/webDataStreams/`webDataStream`/
2677
- # measurementProtocolSecrets/`measurementProtocolSecret` Note: Any type of
2678
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
2808
+ # Required. Example format: accounts/1234/userLinks/5678
2679
2809
  # @param [String] fields
2680
2810
  # Selector specifying which fields to include in a partial response.
2681
2811
  # @param [String] quota_user
@@ -2693,7 +2823,7 @@ module Google
2693
2823
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2694
2824
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2695
2825
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2696
- def delete_property_ios_app_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
2826
+ def delete_property_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
2697
2827
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2698
2828
  command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
2699
2829
  command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
@@ -2703,12 +2833,9 @@ module Google
2703
2833
  execute_or_queue_command(command, &block)
2704
2834
  end
2705
2835
 
2706
- # Lookup for a single "GA4" MeasurementProtocolSecret.
2836
+ # Gets information about a user's link to an account or property.
2707
2837
  # @param [String] name
2708
- # Required. The name of the measurement protocol secret to lookup. Format:
2709
- # properties/`property`/webDataStreams/`webDataStream`/
2710
- # measurementProtocolSecrets/`measurementProtocolSecret` Note: Any type of
2711
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
2838
+ # Required. Example format: accounts/1234/userLinks/5678
2712
2839
  # @param [String] fields
2713
2840
  # Selector specifying which fields to include in a partial response.
2714
2841
  # @param [String] quota_user
@@ -2718,39 +2845,35 @@ module Google
2718
2845
  # Request-specific options
2719
2846
  #
2720
2847
  # @yield [result, err] Result & error if block supplied
2721
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
2848
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
2722
2849
  # @yieldparam err [StandardError] error object if request failed
2723
2850
  #
2724
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
2851
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
2725
2852
  #
2726
2853
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2727
2854
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2728
2855
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2729
- def get_property_ios_app_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
2856
+ def get_property_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
2730
2857
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
2731
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
2732
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
2858
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
2859
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
2733
2860
  command.params['name'] = name unless name.nil?
2734
2861
  command.query['fields'] = fields unless fields.nil?
2735
2862
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2736
2863
  execute_or_queue_command(command, &block)
2737
2864
  end
2738
2865
 
2739
- # Returns child MeasurementProtocolSecrets under the specified parent Property.
2866
+ # Lists all user links on an account or property.
2740
2867
  # @param [String] parent
2741
- # Required. The resource name of the parent stream. Any type of stream (
2742
- # WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format:
2743
- # properties/`property`/webDataStreams/`webDataStream`/
2744
- # measurementProtocolSecrets
2868
+ # Required. Example format: accounts/1234
2745
2869
  # @param [Fixnum] page_size
2746
- # The maximum number of resources to return. If unspecified, at most 10
2747
- # resources will be returned. The maximum value is 10. Higher values will be
2748
- # coerced to the maximum.
2870
+ # The maximum number of user links to return. The service may return fewer than
2871
+ # this value. If unspecified, at most 200 user links will be returned. The
2872
+ # maximum value is 500; values above 500 will be coerced to 500.
2749
2873
  # @param [String] page_token
2750
- # A page token, received from a previous `ListMeasurementProtocolSecrets` call.
2751
- # Provide this to retrieve the subsequent page. When paginating, all other
2752
- # parameters provided to `ListMeasurementProtocolSecrets` must match the call
2753
- # that provided the page token.
2874
+ # A page token, received from a previous `ListUserLinks` call. Provide this to
2875
+ # retrieve the subsequent page. When paginating, all other parameters provided
2876
+ # to `ListUserLinks` must match the call that provided the page token.
2754
2877
  # @param [String] fields
2755
2878
  # Selector specifying which fields to include in a partial response.
2756
2879
  # @param [String] quota_user
@@ -2760,18 +2883,18 @@ module Google
2760
2883
  # Request-specific options
2761
2884
  #
2762
2885
  # @yield [result, err] Result & error if block supplied
2763
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse] parsed result object
2886
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse] parsed result object
2764
2887
  # @yieldparam err [StandardError] error object if request failed
2765
2888
  #
2766
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse]
2889
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse]
2767
2890
  #
2768
2891
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2769
2892
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2770
2893
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2771
- def list_property_ios_app_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2772
- command = make_simple_command(:get, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
2773
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse::Representation
2774
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
2894
+ def list_property_user_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2895
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks', options)
2896
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse::Representation
2897
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse
2775
2898
  command.params['parent'] = parent unless parent.nil?
2776
2899
  command.query['pageSize'] = page_size unless page_size.nil?
2777
2900
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -2780,14 +2903,10 @@ module Google
2780
2903
  execute_or_queue_command(command, &block)
2781
2904
  end
2782
2905
 
2783
- # Updates a measurement protocol secret.
2906
+ # Updates a user link on an account or property.
2784
2907
  # @param [String] name
2785
- # Output only. Resource name of this secret. This secret may be a child of any
2786
- # type of stream. Format: properties/`property`/webDataStreams/`webDataStream`/
2787
- # measurementProtocolSecrets/`measurementProtocolSecret`
2788
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
2789
- # @param [String] update_mask
2790
- # The list of fields to be updated. Omitted fields will not be updated.
2908
+ # Output only. Example format: properties/1234/userLinks/5678
2909
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
2791
2910
  # @param [String] fields
2792
2911
  # Selector specifying which fields to include in a partial response.
2793
2912
  # @param [String] quota_user
@@ -2797,852 +2916,21 @@ module Google
2797
2916
  # Request-specific options
2798
2917
  #
2799
2918
  # @yield [result, err] Result & error if block supplied
2800
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
2919
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
2801
2920
  # @yieldparam err [StandardError] error object if request failed
2802
2921
  #
2803
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
2922
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
2804
2923
  #
2805
2924
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2806
2925
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2807
2926
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2808
- def patch_property_ios_app_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2927
+ def patch_property_user_link(name, google_analytics_admin_v1alpha_user_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2809
2928
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2810
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
2811
- command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
2812
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
2813
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
2929
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
2930
+ command.request_object = google_analytics_admin_v1alpha_user_link_object
2931
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
2932
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
2814
2933
  command.params['name'] = name unless name.nil?
2815
- command.query['updateMask'] = update_mask unless update_mask.nil?
2816
- command.query['fields'] = fields unless fields.nil?
2817
- command.query['quotaUser'] = quota_user unless quota_user.nil?
2818
- execute_or_queue_command(command, &block)
2819
- end
2820
-
2821
- # Lists all user links on an account or property, including implicit ones that
2822
- # come from effective permissions granted by groups or organization admin roles.
2823
- # If a returned user link does not have direct permissions, they cannot be
2824
- # removed from the account or property directly with the DeleteUserLink command.
2825
- # They have to be removed from the group/etc that gives them permissions, which
2826
- # is currently only usable/discoverable in the GA or GMP UIs.
2827
- # @param [String] parent
2828
- # Required. Example format: accounts/1234
2829
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest] google_analytics_admin_v1alpha_audit_user_links_request_object
2830
- # @param [String] fields
2831
- # Selector specifying which fields to include in a partial response.
2832
- # @param [String] quota_user
2833
- # Available to use for quota purposes for server-side applications. Can be any
2834
- # arbitrary string assigned to a user, but should not exceed 40 characters.
2835
- # @param [Google::Apis::RequestOptions] options
2836
- # Request-specific options
2837
- #
2838
- # @yield [result, err] Result & error if block supplied
2839
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse] parsed result object
2840
- # @yieldparam err [StandardError] error object if request failed
2841
- #
2842
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse]
2843
- #
2844
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2845
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2846
- # @raise [Google::Apis::AuthorizationError] Authorization is required
2847
- def audit_property_user_link(parent, google_analytics_admin_v1alpha_audit_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2848
- command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:audit', options)
2849
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest::Representation
2850
- command.request_object = google_analytics_admin_v1alpha_audit_user_links_request_object
2851
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse::Representation
2852
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
2853
- command.params['parent'] = parent unless parent.nil?
2854
- command.query['fields'] = fields unless fields.nil?
2855
- command.query['quotaUser'] = quota_user unless quota_user.nil?
2856
- execute_or_queue_command(command, &block)
2857
- end
2858
-
2859
- # Creates information about multiple users' links to an account or property.
2860
- # This method is transactional. If any UserLink cannot be created, none of the
2861
- # UserLinks will be created.
2862
- # @param [String] parent
2863
- # Required. The account or property that all user links in the request are for.
2864
- # This field is required. The parent field in the CreateUserLinkRequest messages
2865
- # must either be empty or match this field. Example format: accounts/1234
2866
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest] google_analytics_admin_v1alpha_batch_create_user_links_request_object
2867
- # @param [String] fields
2868
- # Selector specifying which fields to include in a partial response.
2869
- # @param [String] quota_user
2870
- # Available to use for quota purposes for server-side applications. Can be any
2871
- # arbitrary string assigned to a user, but should not exceed 40 characters.
2872
- # @param [Google::Apis::RequestOptions] options
2873
- # Request-specific options
2874
- #
2875
- # @yield [result, err] Result & error if block supplied
2876
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse] parsed result object
2877
- # @yieldparam err [StandardError] error object if request failed
2878
- #
2879
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse]
2880
- #
2881
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2882
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2883
- # @raise [Google::Apis::AuthorizationError] Authorization is required
2884
- def batch_property_user_link_create(parent, google_analytics_admin_v1alpha_batch_create_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2885
- command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchCreate', options)
2886
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest::Representation
2887
- command.request_object = google_analytics_admin_v1alpha_batch_create_user_links_request_object
2888
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse::Representation
2889
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
2890
- command.params['parent'] = parent unless parent.nil?
2891
- command.query['fields'] = fields unless fields.nil?
2892
- command.query['quotaUser'] = quota_user unless quota_user.nil?
2893
- execute_or_queue_command(command, &block)
2894
- end
2895
-
2896
- # Deletes information about multiple users' links to an account or property.
2897
- # @param [String] parent
2898
- # Required. The account or property that all user links in the request are for.
2899
- # The parent of all values for user link names to delete must match this field.
2900
- # Example format: accounts/1234
2901
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest] google_analytics_admin_v1alpha_batch_delete_user_links_request_object
2902
- # @param [String] fields
2903
- # Selector specifying which fields to include in a partial response.
2904
- # @param [String] quota_user
2905
- # Available to use for quota purposes for server-side applications. Can be any
2906
- # arbitrary string assigned to a user, but should not exceed 40 characters.
2907
- # @param [Google::Apis::RequestOptions] options
2908
- # Request-specific options
2909
- #
2910
- # @yield [result, err] Result & error if block supplied
2911
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
2912
- # @yieldparam err [StandardError] error object if request failed
2913
- #
2914
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
2915
- #
2916
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2917
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2918
- # @raise [Google::Apis::AuthorizationError] Authorization is required
2919
- def batch_property_user_link_delete(parent, google_analytics_admin_v1alpha_batch_delete_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2920
- command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchDelete', options)
2921
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest::Representation
2922
- command.request_object = google_analytics_admin_v1alpha_batch_delete_user_links_request_object
2923
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
2924
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
2925
- command.params['parent'] = parent unless parent.nil?
2926
- command.query['fields'] = fields unless fields.nil?
2927
- command.query['quotaUser'] = quota_user unless quota_user.nil?
2928
- execute_or_queue_command(command, &block)
2929
- end
2930
-
2931
- # Gets information about multiple users' links to an account or property.
2932
- # @param [String] parent
2933
- # Required. The account or property that all user links in the request are for.
2934
- # The parent of all provided values for the 'names' field must match this field.
2935
- # Example format: accounts/1234
2936
- # @param [Array<String>, String] names
2937
- # Required. The names of the user links to retrieve. A maximum of 1000 user
2938
- # links can be retrieved in a batch. Format: accounts/`accountId`/userLinks/`
2939
- # userLinkId`
2940
- # @param [String] fields
2941
- # Selector specifying which fields to include in a partial response.
2942
- # @param [String] quota_user
2943
- # Available to use for quota purposes for server-side applications. Can be any
2944
- # arbitrary string assigned to a user, but should not exceed 40 characters.
2945
- # @param [Google::Apis::RequestOptions] options
2946
- # Request-specific options
2947
- #
2948
- # @yield [result, err] Result & error if block supplied
2949
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse] parsed result object
2950
- # @yieldparam err [StandardError] error object if request failed
2951
- #
2952
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse]
2953
- #
2954
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2955
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2956
- # @raise [Google::Apis::AuthorizationError] Authorization is required
2957
- def batch_property_user_link_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
2958
- command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks:batchGet', options)
2959
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse::Representation
2960
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
2961
- command.params['parent'] = parent unless parent.nil?
2962
- command.query['names'] = names unless names.nil?
2963
- command.query['fields'] = fields unless fields.nil?
2964
- command.query['quotaUser'] = quota_user unless quota_user.nil?
2965
- execute_or_queue_command(command, &block)
2966
- end
2967
-
2968
- # Updates information about multiple users' links to an account or property.
2969
- # @param [String] parent
2970
- # Required. The account or property that all user links in the request are for.
2971
- # The parent field in the UpdateUserLinkRequest messages must either be empty or
2972
- # match this field. Example format: accounts/1234
2973
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest] google_analytics_admin_v1alpha_batch_update_user_links_request_object
2974
- # @param [String] fields
2975
- # Selector specifying which fields to include in a partial response.
2976
- # @param [String] quota_user
2977
- # Available to use for quota purposes for server-side applications. Can be any
2978
- # arbitrary string assigned to a user, but should not exceed 40 characters.
2979
- # @param [Google::Apis::RequestOptions] options
2980
- # Request-specific options
2981
- #
2982
- # @yield [result, err] Result & error if block supplied
2983
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse] parsed result object
2984
- # @yieldparam err [StandardError] error object if request failed
2985
- #
2986
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse]
2987
- #
2988
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2989
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2990
- # @raise [Google::Apis::AuthorizationError] Authorization is required
2991
- def batch_property_user_link_update(parent, google_analytics_admin_v1alpha_batch_update_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2992
- command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchUpdate', options)
2993
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest::Representation
2994
- command.request_object = google_analytics_admin_v1alpha_batch_update_user_links_request_object
2995
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse::Representation
2996
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
2997
- command.params['parent'] = parent unless parent.nil?
2998
- command.query['fields'] = fields unless fields.nil?
2999
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3000
- execute_or_queue_command(command, &block)
3001
- end
3002
-
3003
- # Creates a user link on an account or property. If the user with the specified
3004
- # email already has permissions on the account or property, then the user's
3005
- # existing permissions will be unioned with the permissions specified in the new
3006
- # UserLink.
3007
- # @param [String] parent
3008
- # Required. Example format: accounts/1234
3009
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
3010
- # @param [Boolean] notify_new_user
3011
- # Optional. If set, then email the new user notifying them that they've been
3012
- # granted permissions to the resource.
3013
- # @param [String] fields
3014
- # Selector specifying which fields to include in a partial response.
3015
- # @param [String] quota_user
3016
- # Available to use for quota purposes for server-side applications. Can be any
3017
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3018
- # @param [Google::Apis::RequestOptions] options
3019
- # Request-specific options
3020
- #
3021
- # @yield [result, err] Result & error if block supplied
3022
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
3023
- # @yieldparam err [StandardError] error object if request failed
3024
- #
3025
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
3026
- #
3027
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3028
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3029
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3030
- def create_property_user_link(parent, google_analytics_admin_v1alpha_user_link_object = nil, notify_new_user: nil, fields: nil, quota_user: nil, options: nil, &block)
3031
- command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks', options)
3032
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
3033
- command.request_object = google_analytics_admin_v1alpha_user_link_object
3034
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
3035
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
3036
- command.params['parent'] = parent unless parent.nil?
3037
- command.query['notifyNewUser'] = notify_new_user unless notify_new_user.nil?
3038
- command.query['fields'] = fields unless fields.nil?
3039
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3040
- execute_or_queue_command(command, &block)
3041
- end
3042
-
3043
- # Deletes a user link on an account or property.
3044
- # @param [String] name
3045
- # Required. Example format: accounts/1234/userLinks/5678
3046
- # @param [String] fields
3047
- # Selector specifying which fields to include in a partial response.
3048
- # @param [String] quota_user
3049
- # Available to use for quota purposes for server-side applications. Can be any
3050
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3051
- # @param [Google::Apis::RequestOptions] options
3052
- # Request-specific options
3053
- #
3054
- # @yield [result, err] Result & error if block supplied
3055
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
3056
- # @yieldparam err [StandardError] error object if request failed
3057
- #
3058
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
3059
- #
3060
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3061
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3062
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3063
- def delete_property_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
3064
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
3065
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
3066
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
3067
- command.params['name'] = name unless name.nil?
3068
- command.query['fields'] = fields unless fields.nil?
3069
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3070
- execute_or_queue_command(command, &block)
3071
- end
3072
-
3073
- # Gets information about a user's link to an account or property.
3074
- # @param [String] name
3075
- # Required. Example format: accounts/1234/userLinks/5678
3076
- # @param [String] fields
3077
- # Selector specifying which fields to include in a partial response.
3078
- # @param [String] quota_user
3079
- # Available to use for quota purposes for server-side applications. Can be any
3080
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3081
- # @param [Google::Apis::RequestOptions] options
3082
- # Request-specific options
3083
- #
3084
- # @yield [result, err] Result & error if block supplied
3085
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
3086
- # @yieldparam err [StandardError] error object if request failed
3087
- #
3088
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
3089
- #
3090
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3091
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3092
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3093
- def get_property_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
3094
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3095
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
3096
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
3097
- command.params['name'] = name unless name.nil?
3098
- command.query['fields'] = fields unless fields.nil?
3099
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3100
- execute_or_queue_command(command, &block)
3101
- end
3102
-
3103
- # Lists all user links on an account or property.
3104
- # @param [String] parent
3105
- # Required. Example format: accounts/1234
3106
- # @param [Fixnum] page_size
3107
- # The maximum number of user links to return. The service may return fewer than
3108
- # this value. If unspecified, at most 200 user links will be returned. The
3109
- # maximum value is 500; values above 500 will be coerced to 500.
3110
- # @param [String] page_token
3111
- # A page token, received from a previous `ListUserLinks` call. Provide this to
3112
- # retrieve the subsequent page. When paginating, all other parameters provided
3113
- # to `ListUserLinks` must match the call that provided the page token.
3114
- # @param [String] fields
3115
- # Selector specifying which fields to include in a partial response.
3116
- # @param [String] quota_user
3117
- # Available to use for quota purposes for server-side applications. Can be any
3118
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3119
- # @param [Google::Apis::RequestOptions] options
3120
- # Request-specific options
3121
- #
3122
- # @yield [result, err] Result & error if block supplied
3123
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse] parsed result object
3124
- # @yieldparam err [StandardError] error object if request failed
3125
- #
3126
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse]
3127
- #
3128
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3129
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3130
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3131
- def list_property_user_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3132
- command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks', options)
3133
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse::Representation
3134
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse
3135
- command.params['parent'] = parent unless parent.nil?
3136
- command.query['pageSize'] = page_size unless page_size.nil?
3137
- command.query['pageToken'] = page_token unless page_token.nil?
3138
- command.query['fields'] = fields unless fields.nil?
3139
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3140
- execute_or_queue_command(command, &block)
3141
- end
3142
-
3143
- # Updates a user link on an account or property.
3144
- # @param [String] name
3145
- # Output only. Example format: properties/1234/userLinks/5678
3146
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
3147
- # @param [String] fields
3148
- # Selector specifying which fields to include in a partial response.
3149
- # @param [String] quota_user
3150
- # Available to use for quota purposes for server-side applications. Can be any
3151
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3152
- # @param [Google::Apis::RequestOptions] options
3153
- # Request-specific options
3154
- #
3155
- # @yield [result, err] Result & error if block supplied
3156
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
3157
- # @yieldparam err [StandardError] error object if request failed
3158
- #
3159
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
3160
- #
3161
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3162
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3163
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3164
- def patch_property_user_link(name, google_analytics_admin_v1alpha_user_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3165
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3166
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
3167
- command.request_object = google_analytics_admin_v1alpha_user_link_object
3168
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
3169
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
3170
- command.params['name'] = name unless name.nil?
3171
- command.query['fields'] = fields unless fields.nil?
3172
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3173
- execute_or_queue_command(command, &block)
3174
- end
3175
-
3176
- # Creates a web stream with the specified location and attributes.
3177
- # @param [String] parent
3178
- # Required. The parent resource where this web data stream will be created.
3179
- # Format: properties/123
3180
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] google_analytics_admin_v1alpha_web_data_stream_object
3181
- # @param [String] fields
3182
- # Selector specifying which fields to include in a partial response.
3183
- # @param [String] quota_user
3184
- # Available to use for quota purposes for server-side applications. Can be any
3185
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3186
- # @param [Google::Apis::RequestOptions] options
3187
- # Request-specific options
3188
- #
3189
- # @yield [result, err] Result & error if block supplied
3190
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] parsed result object
3191
- # @yieldparam err [StandardError] error object if request failed
3192
- #
3193
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
3194
- #
3195
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3196
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3197
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3198
- def create_property_web_data_stream(parent, google_analytics_admin_v1alpha_web_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3199
- command = make_simple_command(:post, 'v1alpha/{+parent}/webDataStreams', options)
3200
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
3201
- command.request_object = google_analytics_admin_v1alpha_web_data_stream_object
3202
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
3203
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream
3204
- command.params['parent'] = parent unless parent.nil?
3205
- command.query['fields'] = fields unless fields.nil?
3206
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3207
- execute_or_queue_command(command, &block)
3208
- end
3209
-
3210
- # Deletes a web stream on a property.
3211
- # @param [String] name
3212
- # Required. The name of the web data stream to delete. Format: properties/`
3213
- # property_id`/webDataStreams/`stream_id` Example: "properties/123/
3214
- # webDataStreams/456"
3215
- # @param [String] fields
3216
- # Selector specifying which fields to include in a partial response.
3217
- # @param [String] quota_user
3218
- # Available to use for quota purposes for server-side applications. Can be any
3219
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3220
- # @param [Google::Apis::RequestOptions] options
3221
- # Request-specific options
3222
- #
3223
- # @yield [result, err] Result & error if block supplied
3224
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
3225
- # @yieldparam err [StandardError] error object if request failed
3226
- #
3227
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
3228
- #
3229
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3230
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3231
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3232
- def delete_property_web_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
3233
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
3234
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
3235
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
3236
- command.params['name'] = name unless name.nil?
3237
- command.query['fields'] = fields unless fields.nil?
3238
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3239
- execute_or_queue_command(command, &block)
3240
- end
3241
-
3242
- # Lookup for a single WebDataStream
3243
- # @param [String] name
3244
- # Required. The name of the web data stream to lookup. Format: properties/`
3245
- # property_id`/webDataStreams/`stream_id` Example: "properties/123/
3246
- # webDataStreams/456"
3247
- # @param [String] fields
3248
- # Selector specifying which fields to include in a partial response.
3249
- # @param [String] quota_user
3250
- # Available to use for quota purposes for server-side applications. Can be any
3251
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3252
- # @param [Google::Apis::RequestOptions] options
3253
- # Request-specific options
3254
- #
3255
- # @yield [result, err] Result & error if block supplied
3256
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] parsed result object
3257
- # @yieldparam err [StandardError] error object if request failed
3258
- #
3259
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
3260
- #
3261
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3262
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3263
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3264
- def get_property_web_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
3265
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3266
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
3267
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream
3268
- command.params['name'] = name unless name.nil?
3269
- command.query['fields'] = fields unless fields.nil?
3270
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3271
- execute_or_queue_command(command, &block)
3272
- end
3273
-
3274
- # Returns the singleton enhanced measurement settings for this web stream. Note
3275
- # that the stream must enable enhanced measurement for these settings to take
3276
- # effect.
3277
- # @param [String] name
3278
- # Required. The name of the settings to lookup. Format: properties/`property_id`/
3279
- # webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "properties/
3280
- # 1000/webDataStreams/2000/enhancedMeasurementSettings"
3281
- # @param [String] fields
3282
- # Selector specifying which fields to include in a partial response.
3283
- # @param [String] quota_user
3284
- # Available to use for quota purposes for server-side applications. Can be any
3285
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3286
- # @param [Google::Apis::RequestOptions] options
3287
- # Request-specific options
3288
- #
3289
- # @yield [result, err] Result & error if block supplied
3290
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] parsed result object
3291
- # @yieldparam err [StandardError] error object if request failed
3292
- #
3293
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings]
3294
- #
3295
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3296
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3297
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3298
- def get_property_web_data_stream_enhanced_measurement_settings(name, fields: nil, quota_user: nil, options: nil, &block)
3299
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3300
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
3301
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
3302
- command.params['name'] = name unless name.nil?
3303
- command.query['fields'] = fields unless fields.nil?
3304
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3305
- execute_or_queue_command(command, &block)
3306
- end
3307
-
3308
- # Returns the Site Tag for the specified web stream. Site Tags are immutable
3309
- # singletons.
3310
- # @param [String] name
3311
- # Required. The name of the site tag to lookup. Note that site tags are
3312
- # singletons and do not have unique IDs. Format: properties/`property_id`/
3313
- # webDataStreams/`stream_id`/globalSiteTag Example: "properties/123/
3314
- # webDataStreams/456/globalSiteTag"
3315
- # @param [String] fields
3316
- # Selector specifying which fields to include in a partial response.
3317
- # @param [String] quota_user
3318
- # Available to use for quota purposes for server-side applications. Can be any
3319
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3320
- # @param [Google::Apis::RequestOptions] options
3321
- # Request-specific options
3322
- #
3323
- # @yield [result, err] Result & error if block supplied
3324
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag] parsed result object
3325
- # @yieldparam err [StandardError] error object if request failed
3326
- #
3327
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag]
3328
- #
3329
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3330
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3331
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3332
- def get_property_web_data_stream_global_site_tag(name, fields: nil, quota_user: nil, options: nil, &block)
3333
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3334
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag::Representation
3335
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag
3336
- command.params['name'] = name unless name.nil?
3337
- command.query['fields'] = fields unless fields.nil?
3338
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3339
- execute_or_queue_command(command, &block)
3340
- end
3341
-
3342
- # Returns child web data streams under the specified parent property. Web data
3343
- # streams will be excluded if the caller does not have access. Returns an empty
3344
- # list if no relevant web data streams are found.
3345
- # @param [String] parent
3346
- # Required. The name of the parent property. For example, to list results of web
3347
- # streams under the property with Id 123: "properties/123"
3348
- # @param [Fixnum] page_size
3349
- # The maximum number of resources to return. If unspecified, at most 50
3350
- # resources will be returned. The maximum value is 200; (higher values will be
3351
- # coerced to the maximum)
3352
- # @param [String] page_token
3353
- # A page token, received from a previous `ListWebDataStreams` call. Provide this
3354
- # to retrieve the subsequent page. When paginating, all other parameters
3355
- # provided to `ListWebDataStreams` must match the call that provided the page
3356
- # token.
3357
- # @param [String] fields
3358
- # Selector specifying which fields to include in a partial response.
3359
- # @param [String] quota_user
3360
- # Available to use for quota purposes for server-side applications. Can be any
3361
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3362
- # @param [Google::Apis::RequestOptions] options
3363
- # Request-specific options
3364
- #
3365
- # @yield [result, err] Result & error if block supplied
3366
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse] parsed result object
3367
- # @yieldparam err [StandardError] error object if request failed
3368
- #
3369
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse]
3370
- #
3371
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3372
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3373
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3374
- def list_property_web_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3375
- command = make_simple_command(:get, 'v1alpha/{+parent}/webDataStreams', options)
3376
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse::Representation
3377
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse
3378
- command.params['parent'] = parent unless parent.nil?
3379
- command.query['pageSize'] = page_size unless page_size.nil?
3380
- command.query['pageToken'] = page_token unless page_token.nil?
3381
- command.query['fields'] = fields unless fields.nil?
3382
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3383
- execute_or_queue_command(command, &block)
3384
- end
3385
-
3386
- # Updates a web stream on a property.
3387
- # @param [String] name
3388
- # Output only. Resource name of this Data Stream. Format: properties/`
3389
- # property_id`/webDataStreams/`stream_id` Example: "properties/1000/
3390
- # webDataStreams/2000"
3391
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] google_analytics_admin_v1alpha_web_data_stream_object
3392
- # @param [String] update_mask
3393
- # Required. The list of fields to be updated. Field names must be in snake case (
3394
- # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
3395
- # entire entity, use one path with the string "*" to match all fields.
3396
- # @param [String] fields
3397
- # Selector specifying which fields to include in a partial response.
3398
- # @param [String] quota_user
3399
- # Available to use for quota purposes for server-side applications. Can be any
3400
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3401
- # @param [Google::Apis::RequestOptions] options
3402
- # Request-specific options
3403
- #
3404
- # @yield [result, err] Result & error if block supplied
3405
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] parsed result object
3406
- # @yieldparam err [StandardError] error object if request failed
3407
- #
3408
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
3409
- #
3410
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3411
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3412
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3413
- def patch_property_web_data_stream(name, google_analytics_admin_v1alpha_web_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3414
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3415
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
3416
- command.request_object = google_analytics_admin_v1alpha_web_data_stream_object
3417
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
3418
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream
3419
- command.params['name'] = name unless name.nil?
3420
- command.query['updateMask'] = update_mask unless update_mask.nil?
3421
- command.query['fields'] = fields unless fields.nil?
3422
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3423
- execute_or_queue_command(command, &block)
3424
- end
3425
-
3426
- # Updates the singleton enhanced measurement settings for this web stream. Note
3427
- # that the stream must enable enhanced measurement for these settings to take
3428
- # effect.
3429
- # @param [String] name
3430
- # Output only. Resource name of this Data Stream. Format: properties/`
3431
- # property_id`/webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "
3432
- # properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
3433
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] google_analytics_admin_v1alpha_enhanced_measurement_settings_object
3434
- # @param [String] update_mask
3435
- # Required. The list of fields to be updated. Field names must be in snake case (
3436
- # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
3437
- # entire entity, use one path with the string "*" to match all fields.
3438
- # @param [String] fields
3439
- # Selector specifying which fields to include in a partial response.
3440
- # @param [String] quota_user
3441
- # Available to use for quota purposes for server-side applications. Can be any
3442
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3443
- # @param [Google::Apis::RequestOptions] options
3444
- # Request-specific options
3445
- #
3446
- # @yield [result, err] Result & error if block supplied
3447
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] parsed result object
3448
- # @yieldparam err [StandardError] error object if request failed
3449
- #
3450
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings]
3451
- #
3452
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3453
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3454
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3455
- def update_property_web_data_stream_enhanced_measurement_settings(name, google_analytics_admin_v1alpha_enhanced_measurement_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3456
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3457
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
3458
- command.request_object = google_analytics_admin_v1alpha_enhanced_measurement_settings_object
3459
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
3460
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
3461
- command.params['name'] = name unless name.nil?
3462
- command.query['updateMask'] = update_mask unless update_mask.nil?
3463
- command.query['fields'] = fields unless fields.nil?
3464
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3465
- execute_or_queue_command(command, &block)
3466
- end
3467
-
3468
- # Creates a measurement protocol secret.
3469
- # @param [String] parent
3470
- # Required. The parent resource where this secret will be created. Any type of
3471
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
3472
- # Format: properties/`property`/webDataStreams/`webDataStream`
3473
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
3474
- # @param [String] fields
3475
- # Selector specifying which fields to include in a partial response.
3476
- # @param [String] quota_user
3477
- # Available to use for quota purposes for server-side applications. Can be any
3478
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3479
- # @param [Google::Apis::RequestOptions] options
3480
- # Request-specific options
3481
- #
3482
- # @yield [result, err] Result & error if block supplied
3483
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
3484
- # @yieldparam err [StandardError] error object if request failed
3485
- #
3486
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
3487
- #
3488
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3489
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3490
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3491
- def create_property_web_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3492
- command = make_simple_command(:post, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
3493
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
3494
- command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
3495
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
3496
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
3497
- command.params['parent'] = parent unless parent.nil?
3498
- command.query['fields'] = fields unless fields.nil?
3499
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3500
- execute_or_queue_command(command, &block)
3501
- end
3502
-
3503
- # Deletes target MeasurementProtocolSecret.
3504
- # @param [String] name
3505
- # Required. The name of the MeasurementProtocolSecret to delete. Format:
3506
- # properties/`property`/webDataStreams/`webDataStream`/
3507
- # measurementProtocolSecrets/`measurementProtocolSecret` Note: Any type of
3508
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
3509
- # @param [String] fields
3510
- # Selector specifying which fields to include in a partial response.
3511
- # @param [String] quota_user
3512
- # Available to use for quota purposes for server-side applications. Can be any
3513
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3514
- # @param [Google::Apis::RequestOptions] options
3515
- # Request-specific options
3516
- #
3517
- # @yield [result, err] Result & error if block supplied
3518
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
3519
- # @yieldparam err [StandardError] error object if request failed
3520
- #
3521
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
3522
- #
3523
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3524
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3525
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3526
- def delete_property_web_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
3527
- command = make_simple_command(:delete, 'v1alpha/{+name}', options)
3528
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
3529
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
3530
- command.params['name'] = name unless name.nil?
3531
- command.query['fields'] = fields unless fields.nil?
3532
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3533
- execute_or_queue_command(command, &block)
3534
- end
3535
-
3536
- # Lookup for a single "GA4" MeasurementProtocolSecret.
3537
- # @param [String] name
3538
- # Required. The name of the measurement protocol secret to lookup. Format:
3539
- # properties/`property`/webDataStreams/`webDataStream`/
3540
- # measurementProtocolSecrets/`measurementProtocolSecret` Note: Any type of
3541
- # stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.
3542
- # @param [String] fields
3543
- # Selector specifying which fields to include in a partial response.
3544
- # @param [String] quota_user
3545
- # Available to use for quota purposes for server-side applications. Can be any
3546
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3547
- # @param [Google::Apis::RequestOptions] options
3548
- # Request-specific options
3549
- #
3550
- # @yield [result, err] Result & error if block supplied
3551
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
3552
- # @yieldparam err [StandardError] error object if request failed
3553
- #
3554
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
3555
- #
3556
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3557
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3558
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3559
- def get_property_web_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
3560
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
3561
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
3562
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
3563
- command.params['name'] = name unless name.nil?
3564
- command.query['fields'] = fields unless fields.nil?
3565
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3566
- execute_or_queue_command(command, &block)
3567
- end
3568
-
3569
- # Returns child MeasurementProtocolSecrets under the specified parent Property.
3570
- # @param [String] parent
3571
- # Required. The resource name of the parent stream. Any type of stream (
3572
- # WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format:
3573
- # properties/`property`/webDataStreams/`webDataStream`/
3574
- # measurementProtocolSecrets
3575
- # @param [Fixnum] page_size
3576
- # The maximum number of resources to return. If unspecified, at most 10
3577
- # resources will be returned. The maximum value is 10. Higher values will be
3578
- # coerced to the maximum.
3579
- # @param [String] page_token
3580
- # A page token, received from a previous `ListMeasurementProtocolSecrets` call.
3581
- # Provide this to retrieve the subsequent page. When paginating, all other
3582
- # parameters provided to `ListMeasurementProtocolSecrets` must match the call
3583
- # that provided the page token.
3584
- # @param [String] fields
3585
- # Selector specifying which fields to include in a partial response.
3586
- # @param [String] quota_user
3587
- # Available to use for quota purposes for server-side applications. Can be any
3588
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3589
- # @param [Google::Apis::RequestOptions] options
3590
- # Request-specific options
3591
- #
3592
- # @yield [result, err] Result & error if block supplied
3593
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse] parsed result object
3594
- # @yieldparam err [StandardError] error object if request failed
3595
- #
3596
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse]
3597
- #
3598
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3599
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3600
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3601
- def list_property_web_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3602
- command = make_simple_command(:get, 'v1alpha/{+parent}/measurementProtocolSecrets', options)
3603
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse::Representation
3604
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
3605
- command.params['parent'] = parent unless parent.nil?
3606
- command.query['pageSize'] = page_size unless page_size.nil?
3607
- command.query['pageToken'] = page_token unless page_token.nil?
3608
- command.query['fields'] = fields unless fields.nil?
3609
- command.query['quotaUser'] = quota_user unless quota_user.nil?
3610
- execute_or_queue_command(command, &block)
3611
- end
3612
-
3613
- # Updates a measurement protocol secret.
3614
- # @param [String] name
3615
- # Output only. Resource name of this secret. This secret may be a child of any
3616
- # type of stream. Format: properties/`property`/webDataStreams/`webDataStream`/
3617
- # measurementProtocolSecrets/`measurementProtocolSecret`
3618
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] google_analytics_admin_v1alpha_measurement_protocol_secret_object
3619
- # @param [String] update_mask
3620
- # The list of fields to be updated. Omitted fields will not be updated.
3621
- # @param [String] fields
3622
- # Selector specifying which fields to include in a partial response.
3623
- # @param [String] quota_user
3624
- # Available to use for quota purposes for server-side applications. Can be any
3625
- # arbitrary string assigned to a user, but should not exceed 40 characters.
3626
- # @param [Google::Apis::RequestOptions] options
3627
- # Request-specific options
3628
- #
3629
- # @yield [result, err] Result & error if block supplied
3630
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret] parsed result object
3631
- # @yieldparam err [StandardError] error object if request failed
3632
- #
3633
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
3634
- #
3635
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3636
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3637
- # @raise [Google::Apis::AuthorizationError] Authorization is required
3638
- def patch_property_web_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1alpha_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3639
- command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3640
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
3641
- command.request_object = google_analytics_admin_v1alpha_measurement_protocol_secret_object
3642
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret::Representation
3643
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
3644
- command.params['name'] = name unless name.nil?
3645
- command.query['updateMask'] = update_mask unless update_mask.nil?
3646
2934
  command.query['fields'] = fields unless fields.nil?
3647
2935
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3648
2936
  execute_or_queue_command(command, &block)