| // This is a generated file (see the discoveryapis_generator project). |
| |
| // ignore_for_file: camel_case_types |
| // ignore_for_file: comment_references |
| // ignore_for_file: deprecated_member_use_from_same_package |
| // ignore_for_file: doc_directive_unknown |
| // ignore_for_file: lines_longer_than_80_chars |
| // ignore_for_file: non_constant_identifier_names |
| // ignore_for_file: prefer_interpolation_to_compose_strings |
| // ignore_for_file: unintended_html_in_doc_comment |
| // ignore_for_file: unnecessary_brace_in_string_interps |
| // ignore_for_file: unnecessary_lambdas |
| // ignore_for_file: unnecessary_string_interpolations |
| |
| /// Google Analytics Admin API - v1beta |
| /// |
| /// Manage properties in Google Analytics. Warning: Creating multiple Customer |
| /// Applications, Accounts, or Projects to simulate or act as a single Customer |
| /// Application, Account, or Project (respectively) or to circumvent |
| /// Service-specific usage limits or quotas is a direct violation of Google |
| /// Cloud Platform Terms of Service as well as Google APIs Terms of Service. |
| /// These actions can result in immediate termination of your GCP project(s) |
| /// without any warning. |
| /// |
| /// For more information, see |
| /// <http://code.google.com/apis/analytics/docs/mgmt/home.html> |
| /// |
| /// Create an instance of [GoogleAnalyticsAdminApi] to access these resources: |
| /// |
| /// - [AccountSummariesResource] |
| /// - [AccountsResource] |
| /// - [PropertiesResource] |
| /// - [PropertiesConversionEventsResource] |
| /// - [PropertiesCustomDimensionsResource] |
| /// - [PropertiesCustomMetricsResource] |
| /// - [PropertiesDataStreamsResource] |
| /// - [PropertiesDataStreamsMeasurementProtocolSecretsResource] |
| /// - [PropertiesFirebaseLinksResource] |
| /// - [PropertiesGoogleAdsLinksResource] |
| /// - [PropertiesKeyEventsResource] |
| library; |
| |
| import 'dart:async' as async; |
| import 'dart:convert' as convert; |
| import 'dart:core' as core; |
| |
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
| import 'package:http/http.dart' as http; |
| |
| import '../shared.dart'; |
| import '../src/user_agent.dart'; |
| |
| export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' |
| show ApiRequestError, DetailedApiRequestError; |
| |
| /// Manage properties in Google Analytics. |
| /// |
| /// Warning: Creating multiple Customer Applications, Accounts, or Projects to |
| /// simulate or act as a single Customer Application, Account, or Project |
| /// (respectively) or to circumvent Service-specific usage limits or quotas is a |
| /// direct violation of Google Cloud Platform Terms of Service as well as Google |
| /// APIs Terms of Service. These actions can result in immediate termination of |
| /// your GCP project(s) without any warning. |
| class GoogleAnalyticsAdminApi { |
| /// Edit Google Analytics management entities |
| static const analyticsEditScope = |
| 'https://www.googleapis.com/auth/analytics.edit'; |
| |
| /// See and download your Google Analytics data |
| static const analyticsReadonlyScope = |
| 'https://www.googleapis.com/auth/analytics.readonly'; |
| |
| final commons.ApiRequester _requester; |
| |
| AccountSummariesResource get accountSummaries => |
| AccountSummariesResource(_requester); |
| AccountsResource get accounts => AccountsResource(_requester); |
| PropertiesResource get properties => PropertiesResource(_requester); |
| |
| GoogleAnalyticsAdminApi( |
| http.Client client, { |
| core.String rootUrl = 'https://analyticsadmin.googleapis.com/', |
| core.String servicePath = '', |
| }) : _requester = commons.ApiRequester( |
| client, |
| rootUrl, |
| servicePath, |
| requestHeaders, |
| ); |
| } |
| |
| class AccountSummariesResource { |
| final commons.ApiRequester _requester; |
| |
| AccountSummariesResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Returns summaries of all accounts accessible by the caller. |
| /// |
| /// Request parameters: |
| /// |
| /// [pageSize] - The maximum number of AccountSummary resources to return. The |
| /// service may return fewer than this value, even if there are additional |
| /// pages. If unspecified, at most 50 resources will be returned. The maximum |
| /// value is 200; (higher values will be coerced to the maximum) |
| /// |
| /// [pageToken] - A page token, received from a previous |
| /// `ListAccountSummaries` call. Provide this to retrieve the subsequent page. |
| /// When paginating, all other parameters provided to `ListAccountSummaries` |
| /// must match the call that provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListAccountSummariesResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListAccountSummariesResponse> list({ |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const url_ = 'v1beta/accountSummaries'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListAccountSummariesResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class AccountsResource { |
| final commons.ApiRequester _requester; |
| |
| AccountsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Marks target Account as soft-deleted (ie: "trashed") and returns it. |
| /// |
| /// This API does not have a method to restore soft-deleted accounts. However, |
| /// they can be restored using the Trash Can UI. If the accounts are not |
| /// restored before the expiration time, the account and all child resources |
| /// (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be |
| /// permanently purged. https://support.google.com/analytics/answer/6154772 |
| /// Returns an error if the target is not found. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the Account to soft-delete. Format: |
| /// accounts/{account} Example: "accounts/100" |
| /// Value must have pattern `^accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lookup for a single Account. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the account to lookup. Format: |
| /// accounts/{account} Example: "accounts/100" |
| /// Value must have pattern `^accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaAccount]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaAccount> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaAccount.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Get data sharing settings on an account. |
| /// |
| /// Data sharing settings are singletons. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the settings to lookup. Format: |
| /// accounts/{account}/dataSharingSettings Example: |
| /// `accounts/1000/dataSharingSettings` |
| /// Value must have pattern `^accounts/\[^/\]+/dataSharingSettings$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaDataSharingSettings]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaDataSharingSettings> |
| getDataSharingSettings(core.String name, {core.String? $fields}) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaDataSharingSettings.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns all accounts accessible by the caller. |
| /// |
| /// Note that these accounts might not currently have GA properties. |
| /// Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an |
| /// empty list if no relevant accounts are found. |
| /// |
| /// Request parameters: |
| /// |
| /// [pageSize] - The maximum number of resources to return. The service may |
| /// return fewer than this value, even if there are additional pages. If |
| /// unspecified, at most 50 resources will be returned. The maximum value is |
| /// 200; (higher values will be coerced to the maximum) |
| /// |
| /// [pageToken] - A page token, received from a previous `ListAccounts` call. |
| /// Provide this to retrieve the subsequent page. When paginating, all other |
| /// parameters provided to `ListAccounts` must match the call that provided |
| /// the page token. |
| /// |
| /// [showDeleted] - Whether to include soft-deleted (ie: "trashed") Accounts |
| /// in the results. Accounts can be inspected to determine whether they are |
| /// deleted or not. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListAccountsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListAccountsResponse> list({ |
| core.int? pageSize, |
| core.String? pageToken, |
| core.bool? showDeleted, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if (showDeleted != null) 'showDeleted': ['${showDeleted}'], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const url_ = 'v1beta/accounts'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListAccountsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates an account. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name of this account. Format: |
| /// accounts/{account} Example: "accounts/100" |
| /// Value must have pattern `^accounts/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Field names |
| /// must be in snake case (for example, "field_to_update"). Omitted fields |
| /// will not be updated. To replace the entire entity, use one path with the |
| /// string "*" to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaAccount]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaAccount> patch( |
| GoogleAnalyticsAdminV1betaAccount request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaAccount.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Requests a ticket for creating an account. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a |
| /// [GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse> |
| provisionAccountTicket( |
| GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest request, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const url_ = 'v1beta/accounts:provisionAccountTicket'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns a customized report of data access records. |
| /// |
| /// The report provides records of each time a user reads Google Analytics |
| /// reporting data. Access records are retained for up to 2 years. Data Access |
| /// Reports can be requested for a property. Reports may be requested for any |
| /// property, but dimensions that aren't related to quota can only be |
| /// requested on Google Analytics 360 properties. This method is only |
| /// available to Administrators. These data access records include GA UI |
| /// Reporting, GA UI Explorations, GA Data API, and other products like |
| /// Firebase & Admob that can retrieve data from Google Analytics through a |
| /// linkage. These records don't include property configuration changes like |
| /// adding a stream or changing a property's time zone. For configuration |
| /// change history, see |
| /// [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). |
| /// To give your feedback on this API, complete the |
| /// [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) |
| /// form. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [entity] - The Data Access Report supports requesting at the property |
| /// level or account level. If requested at the account level, Data Access |
| /// Reports include all access for all properties under that account. To |
| /// request at the property level, entity should be for example |
| /// 'properties/123' if "123" is your Google Analytics property ID. To request |
| /// at the account level, entity should be for example 'accounts/1234' if |
| /// "1234" is your Google Analytics Account ID. |
| /// Value must have pattern `^accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaRunAccessReportResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaRunAccessReportResponse> |
| runAccessReport( |
| GoogleAnalyticsAdminV1betaRunAccessReportRequest request, |
| core.String entity, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + core.Uri.encodeFull('$entity') + ':runAccessReport'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaRunAccessReportResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Searches through all changes to an account or its children given the |
| /// specified set of filters. |
| /// |
| /// Only returns the subset of changes supported by the API. The UI may return |
| /// additional changes. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [account] - Required. The account resource for which to return change |
| /// history resources. Format: accounts/{account} Example: `accounts/100` |
| /// Value must have pattern `^accounts/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a |
| /// [GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse> |
| searchChangeHistoryEvents( |
| GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest request, |
| core.String account, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + |
| core.Uri.encodeFull('$account') + |
| ':searchChangeHistoryEvents'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesConversionEventsResource get conversionEvents => |
| PropertiesConversionEventsResource(_requester); |
| PropertiesCustomDimensionsResource get customDimensions => |
| PropertiesCustomDimensionsResource(_requester); |
| PropertiesCustomMetricsResource get customMetrics => |
| PropertiesCustomMetricsResource(_requester); |
| PropertiesDataStreamsResource get dataStreams => |
| PropertiesDataStreamsResource(_requester); |
| PropertiesFirebaseLinksResource get firebaseLinks => |
| PropertiesFirebaseLinksResource(_requester); |
| PropertiesGoogleAdsLinksResource get googleAdsLinks => |
| PropertiesGoogleAdsLinksResource(_requester); |
| PropertiesKeyEventsResource get keyEvents => |
| PropertiesKeyEventsResource(_requester); |
| |
| PropertiesResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Acknowledges the terms of user data collection for the specified property. |
| /// |
| /// This acknowledgement must be completed (either in the Google Analytics UI |
| /// or through this API) before MeasurementProtocolSecret resources may be |
| /// created. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [property] - Required. The property for which to acknowledge user data |
| /// collection. |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a |
| /// [GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse> |
| acknowledgeUserDataCollection( |
| GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest request, |
| core.String property, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + |
| core.Uri.encodeFull('$property') + |
| ':acknowledgeUserDataCollection'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Creates a Google Analytics property with the specified location and |
| /// attributes. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaProperty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaProperty> create( |
| GoogleAnalyticsAdminV1betaProperty request, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const url_ = 'v1beta/properties'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaProperty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Marks target Property as soft-deleted (ie: "trashed") and returns it. |
| /// |
| /// This API does not have a method to restore soft-deleted properties. |
| /// However, they can be restored using the Trash Can UI. If the properties |
| /// are not restored before the expiration time, the Property and all child |
| /// resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be |
| /// permanently purged. https://support.google.com/analytics/answer/6154772 |
| /// Returns an error if the target is not found. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the Property to soft-delete. Format: |
| /// properties/{property_id} Example: "properties/1000" |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaProperty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaProperty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaProperty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lookup for a single GA Property. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the property to lookup. Format: |
| /// properties/{property_id} Example: "properties/1000" |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaProperty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaProperty> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaProperty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns the singleton data retention settings for this property. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the settings to lookup. Format: |
| /// properties/{property}/dataRetentionSettings Example: |
| /// "properties/1000/dataRetentionSettings" |
| /// Value must have pattern `^properties/\[^/\]+/dataRetentionSettings$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaDataRetentionSettings]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaDataRetentionSettings> |
| getDataRetentionSettings(core.String name, {core.String? $fields}) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaDataRetentionSettings.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns child Properties under the specified parent Account. |
| /// |
| /// Properties will be excluded if the caller does not have access. |
| /// Soft-deleted (ie: "trashed") properties are excluded by default. Returns |
| /// an empty list if no relevant properties are found. |
| /// |
| /// Request parameters: |
| /// |
| /// [filter] - Required. An expression for filtering the results of the |
| /// request. Fields eligible for filtering are: `parent:`(The resource name of |
| /// the parent account/property) or `ancestor:`(The resource name of the |
| /// parent account) or `firebase_project:`(The id or number of the linked |
| /// firebase project). Some examples of filters: ``` | Filter | Description | |
| /// |-----------------------------|-------------------------------------------| |
| /// | parent:accounts/123 | The account with account id: 123. | | |
| /// parent:properties/123 | The property with property id: 123. | | |
| /// ancestor:accounts/123 | The account with account id: 123. | | |
| /// firebase_project:project-id | The firebase project with id: project-id. | |
| /// | firebase_project:123 | The firebase project with number: 123. | ``` |
| /// |
| /// [pageSize] - The maximum number of resources to return. The service may |
| /// return fewer than this value, even if there are additional pages. If |
| /// unspecified, at most 50 resources will be returned. The maximum value is |
| /// 200; (higher values will be coerced to the maximum) |
| /// |
| /// [pageToken] - A page token, received from a previous `ListProperties` |
| /// call. Provide this to retrieve the subsequent page. When paginating, all |
| /// other parameters provided to `ListProperties` must match the call that |
| /// provided the page token. |
| /// |
| /// [showDeleted] - Whether to include soft-deleted (ie: "trashed") Properties |
| /// in the results. Properties can be inspected to determine whether they are |
| /// deleted or not. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListPropertiesResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListPropertiesResponse> list({ |
| core.String? filter, |
| core.int? pageSize, |
| core.String? pageToken, |
| core.bool? showDeleted, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (filter != null) 'filter': [filter], |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if (showDeleted != null) 'showDeleted': ['${showDeleted}'], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const url_ = 'v1beta/properties'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListPropertiesResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name of this property. Format: |
| /// properties/{property_id} Example: "properties/1000" |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Field names |
| /// must be in snake case (e.g., "field_to_update"). Omitted fields will not |
| /// be updated. To replace the entire entity, use one path with the string "*" |
| /// to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaProperty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaProperty> patch( |
| GoogleAnalyticsAdminV1betaProperty request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaProperty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns a customized report of data access records. |
| /// |
| /// The report provides records of each time a user reads Google Analytics |
| /// reporting data. Access records are retained for up to 2 years. Data Access |
| /// Reports can be requested for a property. Reports may be requested for any |
| /// property, but dimensions that aren't related to quota can only be |
| /// requested on Google Analytics 360 properties. This method is only |
| /// available to Administrators. These data access records include GA UI |
| /// Reporting, GA UI Explorations, GA Data API, and other products like |
| /// Firebase & Admob that can retrieve data from Google Analytics through a |
| /// linkage. These records don't include property configuration changes like |
| /// adding a stream or changing a property's time zone. For configuration |
| /// change history, see |
| /// [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). |
| /// To give your feedback on this API, complete the |
| /// [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) |
| /// form. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [entity] - The Data Access Report supports requesting at the property |
| /// level or account level. If requested at the account level, Data Access |
| /// Reports include all access for all properties under that account. To |
| /// request at the property level, entity should be for example |
| /// 'properties/123' if "123" is your Google Analytics property ID. To request |
| /// at the account level, entity should be for example 'accounts/1234' if |
| /// "1234" is your Google Analytics Account ID. |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaRunAccessReportResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaRunAccessReportResponse> |
| runAccessReport( |
| GoogleAnalyticsAdminV1betaRunAccessReportRequest request, |
| core.String entity, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + core.Uri.encodeFull('$entity') + ':runAccessReport'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaRunAccessReportResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates the singleton data retention settings for this property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name for this DataRetentionSetting |
| /// resource. Format: properties/{property}/dataRetentionSettings |
| /// Value must have pattern `^properties/\[^/\]+/dataRetentionSettings$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Field names |
| /// must be in snake case (e.g., "field_to_update"). Omitted fields will not |
| /// be updated. To replace the entire entity, use one path with the string "*" |
| /// to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaDataRetentionSettings]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaDataRetentionSettings> |
| updateDataRetentionSettings( |
| GoogleAnalyticsAdminV1betaDataRetentionSettings request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaDataRetentionSettings.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| @core.Deprecated( |
| 'Not supported. Member documentation may have more information.', |
| ) |
| class PropertiesConversionEventsResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesConversionEventsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Deprecated: Use `CreateKeyEvent` instead. |
| /// |
| /// Creates a conversion event with the specified attributes. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name of the parent property where this |
| /// conversion event will be created. Format: properties/123 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaConversionEvent]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| @core.Deprecated( |
| 'Not supported. Member documentation may have more information.', |
| ) |
| async.Future<GoogleAnalyticsAdminV1betaConversionEvent> create( |
| GoogleAnalyticsAdminV1betaConversionEvent request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + core.Uri.encodeFull('$parent') + '/conversionEvents'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaConversionEvent.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deprecated: Use `DeleteKeyEvent` instead. |
| /// |
| /// Deletes a conversion event in a property. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The resource name of the conversion event to delete. |
| /// Format: properties/{property}/conversionEvents/{conversion_event} Example: |
| /// "properties/123/conversionEvents/456" |
| /// Value must have pattern `^properties/\[^/\]+/conversionEvents/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| @core.Deprecated( |
| 'Not supported. Member documentation may have more information.', |
| ) |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deprecated: Use `GetKeyEvent` instead. |
| /// |
| /// Retrieve a single conversion event. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The resource name of the conversion event to retrieve. |
| /// Format: properties/{property}/conversionEvents/{conversion_event} Example: |
| /// "properties/123/conversionEvents/456" |
| /// Value must have pattern `^properties/\[^/\]+/conversionEvents/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaConversionEvent]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| @core.Deprecated( |
| 'Not supported. Member documentation may have more information.', |
| ) |
| async.Future<GoogleAnalyticsAdminV1betaConversionEvent> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaConversionEvent.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deprecated: Use `ListKeyEvents` instead. |
| /// |
| /// Returns a list of conversion events in the specified parent property. |
| /// Returns an empty list if no conversion events are found. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name of the parent property. Example: |
| /// 'properties/123' |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 50 resources will be returned. The maximum value is 200; (higher |
| /// values will be coerced to the maximum) |
| /// |
| /// [pageToken] - A page token, received from a previous |
| /// `ListConversionEvents` call. Provide this to retrieve the subsequent page. |
| /// When paginating, all other parameters provided to `ListConversionEvents` |
| /// must match the call that provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListConversionEventsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| @core.Deprecated( |
| 'Not supported. Member documentation may have more information.', |
| ) |
| async.Future<GoogleAnalyticsAdminV1betaListConversionEventsResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + core.Uri.encodeFull('$parent') + '/conversionEvents'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListConversionEventsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deprecated: Use `UpdateKeyEvent` instead. |
| /// |
| /// Updates a conversion event with the specified attributes. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name of this conversion event. Format: |
| /// properties/{property}/conversionEvents/{conversion_event} |
| /// Value must have pattern `^properties/\[^/\]+/conversionEvents/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Field names |
| /// must be in snake case (e.g., "field_to_update"). Omitted fields will not |
| /// be updated. To replace the entire entity, use one path with the string "*" |
| /// to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaConversionEvent]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| @core.Deprecated( |
| 'Not supported. Member documentation may have more information.', |
| ) |
| async.Future<GoogleAnalyticsAdminV1betaConversionEvent> patch( |
| GoogleAnalyticsAdminV1betaConversionEvent request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaConversionEvent.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesCustomDimensionsResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesCustomDimensionsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Archives a CustomDimension on a property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the CustomDimension to archive. Example |
| /// format: properties/1234/customDimensions/5678 |
| /// Value must have pattern `^properties/\[^/\]+/customDimensions/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> archive( |
| GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest request, |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name') + ':archive'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Creates a CustomDimension. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaCustomDimension]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaCustomDimension> create( |
| GoogleAnalyticsAdminV1betaCustomDimension request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + core.Uri.encodeFull('$parent') + '/customDimensions'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaCustomDimension.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lookup for a single CustomDimension. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the CustomDimension to get. Example format: |
| /// properties/1234/customDimensions/5678 |
| /// Value must have pattern `^properties/\[^/\]+/customDimensions/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaCustomDimension]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaCustomDimension> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaCustomDimension.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists CustomDimensions on a property. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 50 resources will be returned. The maximum value is 200 (higher |
| /// values will be coerced to the maximum). |
| /// |
| /// [pageToken] - A page token, received from a previous |
| /// `ListCustomDimensions` call. Provide this to retrieve the subsequent page. |
| /// When paginating, all other parameters provided to `ListCustomDimensions` |
| /// must match the call that provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListCustomDimensionsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListCustomDimensionsResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + core.Uri.encodeFull('$parent') + '/customDimensions'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListCustomDimensionsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a CustomDimension on a property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name for this CustomDimension resource. |
| /// Format: properties/{property}/customDimensions/{customDimension} |
| /// Value must have pattern `^properties/\[^/\]+/customDimensions/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Omitted fields |
| /// will not be updated. To replace the entire entity, use one path with the |
| /// string "*" to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaCustomDimension]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaCustomDimension> patch( |
| GoogleAnalyticsAdminV1betaCustomDimension request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaCustomDimension.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesCustomMetricsResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesCustomMetricsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Archives a CustomMetric on a property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the CustomMetric to archive. Example |
| /// format: properties/1234/customMetrics/5678 |
| /// Value must have pattern `^properties/\[^/\]+/customMetrics/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> archive( |
| GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest request, |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name') + ':archive'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Creates a CustomMetric. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaCustomMetric]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaCustomMetric> create( |
| GoogleAnalyticsAdminV1betaCustomMetric request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/customMetrics'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaCustomMetric.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lookup for a single CustomMetric. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the CustomMetric to get. Example format: |
| /// properties/1234/customMetrics/5678 |
| /// Value must have pattern `^properties/\[^/\]+/customMetrics/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaCustomMetric]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaCustomMetric> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaCustomMetric.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists CustomMetrics on a property. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 50 resources will be returned. The maximum value is 200 (higher |
| /// values will be coerced to the maximum). |
| /// |
| /// [pageToken] - A page token, received from a previous `ListCustomMetrics` |
| /// call. Provide this to retrieve the subsequent page. When paginating, all |
| /// other parameters provided to `ListCustomMetrics` must match the call that |
| /// provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListCustomMetricsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListCustomMetricsResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/customMetrics'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListCustomMetricsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a CustomMetric on a property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name for this CustomMetric resource. |
| /// Format: properties/{property}/customMetrics/{customMetric} |
| /// Value must have pattern `^properties/\[^/\]+/customMetrics/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Omitted fields |
| /// will not be updated. To replace the entire entity, use one path with the |
| /// string "*" to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaCustomMetric]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaCustomMetric> patch( |
| GoogleAnalyticsAdminV1betaCustomMetric request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaCustomMetric.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesDataStreamsResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesDataStreamsMeasurementProtocolSecretsResource |
| get measurementProtocolSecrets => |
| PropertiesDataStreamsMeasurementProtocolSecretsResource(_requester); |
| |
| PropertiesDataStreamsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a DataStream. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaDataStream]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaDataStream> create( |
| GoogleAnalyticsAdminV1betaDataStream request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/dataStreams'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaDataStream.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deletes a DataStream on a property. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the DataStream to delete. Example format: |
| /// properties/1234/dataStreams/5678 |
| /// Value must have pattern `^properties/\[^/\]+/dataStreams/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lookup for a single DataStream. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the DataStream to get. Example format: |
| /// properties/1234/dataStreams/5678 |
| /// Value must have pattern `^properties/\[^/\]+/dataStreams/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaDataStream]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaDataStream> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaDataStream.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists DataStreams on a property. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 50 resources will be returned. The maximum value is 200 (higher |
| /// values will be coerced to the maximum). |
| /// |
| /// [pageToken] - A page token, received from a previous `ListDataStreams` |
| /// call. Provide this to retrieve the subsequent page. When paginating, all |
| /// other parameters provided to `ListDataStreams` must match the call that |
| /// provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListDataStreamsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListDataStreamsResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/dataStreams'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListDataStreamsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a DataStream on a property. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name of this Data Stream. Format: |
| /// properties/{property_id}/dataStreams/{stream_id} Example: |
| /// "properties/1000/dataStreams/2000" |
| /// Value must have pattern `^properties/\[^/\]+/dataStreams/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Omitted fields |
| /// will not be updated. To replace the entire entity, use one path with the |
| /// string "*" to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaDataStream]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaDataStream> patch( |
| GoogleAnalyticsAdminV1betaDataStream request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaDataStream.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesDataStreamsMeasurementProtocolSecretsResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesDataStreamsMeasurementProtocolSecretsResource( |
| commons.ApiRequester client, |
| ) : _requester = client; |
| |
| /// Creates a measurement protocol secret. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The parent resource where this secret will be |
| /// created. Format: properties/{property}/dataStreams/{dataStream} |
| /// Value must have pattern `^properties/\[^/\]+/dataStreams/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaMeasurementProtocolSecret> create( |
| GoogleAnalyticsAdminV1betaMeasurementProtocolSecret request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + |
| core.Uri.encodeFull('$parent') + |
| '/measurementProtocolSecrets'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaMeasurementProtocolSecret.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deletes target MeasurementProtocolSecret. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the MeasurementProtocolSecret to delete. |
| /// Format: |
| /// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
| /// Value must have pattern |
| /// `^properties/\[^/\]+/dataStreams/\[^/\]+/measurementProtocolSecrets/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lookup for a single MeasurementProtocolSecret. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The name of the measurement protocol secret to lookup. |
| /// Format: |
| /// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
| /// Value must have pattern |
| /// `^properties/\[^/\]+/dataStreams/\[^/\]+/measurementProtocolSecrets/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaMeasurementProtocolSecret> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaMeasurementProtocolSecret.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns child MeasurementProtocolSecrets under the specified parent |
| /// Property. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name of the parent stream. Format: |
| /// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets |
| /// Value must have pattern `^properties/\[^/\]+/dataStreams/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 10 resources will be returned. The maximum value is 10. Higher values |
| /// will be coerced to the maximum. |
| /// |
| /// [pageToken] - A page token, received from a previous |
| /// `ListMeasurementProtocolSecrets` call. Provide this to retrieve the |
| /// subsequent page. When paginating, all other parameters provided to |
| /// `ListMeasurementProtocolSecrets` must match the call that provided the |
| /// page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a |
| /// [GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse> |
| list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = |
| 'v1beta/' + |
| core.Uri.encodeFull('$parent') + |
| '/measurementProtocolSecrets'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a measurement protocol secret. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name of this secret. This secret may be a |
| /// child of any type of stream. Format: |
| /// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
| /// Value must have pattern |
| /// `^properties/\[^/\]+/dataStreams/\[^/\]+/measurementProtocolSecrets/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Omitted fields |
| /// will not be updated. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaMeasurementProtocolSecret> patch( |
| GoogleAnalyticsAdminV1betaMeasurementProtocolSecret request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaMeasurementProtocolSecret.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesFirebaseLinksResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesFirebaseLinksResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a FirebaseLink. |
| /// |
| /// Properties can have at most one FirebaseLink. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Format: properties/{property_id} Example: |
| /// `properties/1234` |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaFirebaseLink]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaFirebaseLink> create( |
| GoogleAnalyticsAdminV1betaFirebaseLink request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/firebaseLinks'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaFirebaseLink.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deletes a FirebaseLink on a property |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Format: |
| /// properties/{property_id}/firebaseLinks/{firebase_link_id} Example: |
| /// `properties/1234/firebaseLinks/5678` |
| /// Value must have pattern `^properties/\[^/\]+/firebaseLinks/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists FirebaseLinks on a property. |
| /// |
| /// Properties can have at most one FirebaseLink. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Format: properties/{property_id} Example: |
| /// `properties/1234` |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. The service may |
| /// return fewer than this value, even if there are additional pages. If |
| /// unspecified, at most 50 resources will be returned. The maximum value is |
| /// 200; (higher values will be coerced to the maximum) |
| /// |
| /// [pageToken] - A page token, received from a previous `ListFirebaseLinks` |
| /// call. Provide this to retrieve the subsequent page. When paginating, all |
| /// other parameters provided to `ListFirebaseLinks` must match the call that |
| /// provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListFirebaseLinksResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListFirebaseLinksResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/firebaseLinks'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListFirebaseLinksResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesGoogleAdsLinksResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesGoogleAdsLinksResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a GoogleAdsLink. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaGoogleAdsLink]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaGoogleAdsLink> create( |
| GoogleAnalyticsAdminV1betaGoogleAdsLink request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/googleAdsLinks'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaGoogleAdsLink.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deletes a GoogleAdsLink on a property |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Example format: properties/1234/googleAdsLinks/5678 |
| /// Value must have pattern `^properties/\[^/\]+/googleAdsLinks/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists GoogleAdsLinks on a property. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example format: properties/1234 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 50 resources will be returned. The maximum value is 200 (higher |
| /// values will be coerced to the maximum). |
| /// |
| /// [pageToken] - A page token, received from a previous `ListGoogleAdsLinks` |
| /// call. Provide this to retrieve the subsequent page. When paginating, all |
| /// other parameters provided to `ListGoogleAdsLinks` must match the call that |
| /// provided the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/googleAdsLinks'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a GoogleAdsLink on a property |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Format: |
| /// properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: |
| /// googleAdsLinkId is not the Google Ads customer ID. |
| /// Value must have pattern `^properties/\[^/\]+/googleAdsLinks/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Field names |
| /// must be in snake case (e.g., "field_to_update"). Omitted fields will not |
| /// be updated. To replace the entire entity, use one path with the string "*" |
| /// to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaGoogleAdsLink]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaGoogleAdsLink> patch( |
| GoogleAnalyticsAdminV1betaGoogleAdsLink request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaGoogleAdsLink.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class PropertiesKeyEventsResource { |
| final commons.ApiRequester _requester; |
| |
| PropertiesKeyEventsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a Key Event. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name of the parent property where this |
| /// Key Event will be created. Format: properties/123 |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaKeyEvent]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaKeyEvent> create( |
| GoogleAnalyticsAdminV1betaKeyEvent request, |
| core.String parent, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/keyEvents'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaKeyEvent.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Deletes a Key Event. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The resource name of the Key Event to delete. Format: |
| /// properties/{property}/keyEvents/{key_event} Example: |
| /// "properties/123/keyEvents/456" |
| /// Value must have pattern `^properties/\[^/\]+/keyEvents/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleProtobufEmpty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleProtobufEmpty> delete( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return GoogleProtobufEmpty.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Retrieve a single Key Event. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The resource name of the Key Event to retrieve. Format: |
| /// properties/{property}/keyEvents/{key_event} Example: |
| /// "properties/123/keyEvents/456" |
| /// Value must have pattern `^properties/\[^/\]+/keyEvents/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaKeyEvent]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaKeyEvent> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaKeyEvent.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Returns a list of Key Events in the specified parent property. |
| /// |
| /// Returns an empty list if no Key Events are found. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name of the parent property. Example: |
| /// 'properties/123' |
| /// Value must have pattern `^properties/\[^/\]+$`. |
| /// |
| /// [pageSize] - The maximum number of resources to return. If unspecified, at |
| /// most 50 resources will be returned. The maximum value is 200; (higher |
| /// values will be coerced to the maximum) |
| /// |
| /// [pageToken] - A page token, received from a previous `ListKeyEvents` call. |
| /// Provide this to retrieve the subsequent page. When paginating, all other |
| /// parameters provided to `ListKeyEvents` must match the call that provided |
| /// the page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaListKeyEventsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaListKeyEventsResponse> list( |
| core.String parent, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$parent') + '/keyEvents'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaListKeyEventsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a Key Event. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Resource name of this key event. Format: |
| /// properties/{property}/keyEvents/{key_event} |
| /// Value must have pattern `^properties/\[^/\]+/keyEvents/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. The list of fields to be updated. Field names |
| /// must be in snake case (e.g., "field_to_update"). Omitted fields will not |
| /// be updated. To replace the entire entity, use one path with the string "*" |
| /// to match all fields. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleAnalyticsAdminV1betaKeyEvent]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<GoogleAnalyticsAdminV1betaKeyEvent> patch( |
| GoogleAnalyticsAdminV1betaKeyEvent request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| if (updateMask != null) 'updateMask': [updateMask], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final url_ = 'v1beta/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return GoogleAnalyticsAdminV1betaKeyEvent.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| /// To express that the result needs to be between two numbers (inclusive). |
| class GoogleAnalyticsAdminV1betaAccessBetweenFilter { |
| /// Begins with this number. |
| GoogleAnalyticsAdminV1betaNumericValue? fromValue; |
| |
| /// Ends with this number. |
| GoogleAnalyticsAdminV1betaNumericValue? toValue; |
| |
| GoogleAnalyticsAdminV1betaAccessBetweenFilter({this.fromValue, this.toValue}); |
| |
| GoogleAnalyticsAdminV1betaAccessBetweenFilter.fromJson(core.Map json_) |
| : this( |
| fromValue: |
| json_.containsKey('fromValue') |
| ? GoogleAnalyticsAdminV1betaNumericValue.fromJson( |
| json_['fromValue'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| toValue: |
| json_.containsKey('toValue') |
| ? GoogleAnalyticsAdminV1betaNumericValue.fromJson( |
| json_['toValue'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (fromValue != null) 'fromValue': fromValue!, |
| if (toValue != null) 'toValue': toValue!, |
| }; |
| } |
| |
| /// A contiguous range of days: startDate, startDate + 1, ..., endDate. |
| typedef GoogleAnalyticsAdminV1betaAccessDateRange = $AccessDateRange; |
| |
| /// Dimensions are attributes of your data. |
| /// |
| /// For example, the dimension `userEmail` indicates the email of the user that |
| /// accessed reporting data. Dimension values in report responses are strings. |
| typedef GoogleAnalyticsAdminV1betaAccessDimension = $AccessDimension; |
| |
| /// Describes a dimension column in the report. |
| /// |
| /// Dimensions requested in a report produce column entries within rows and |
| /// DimensionHeaders. However, dimensions used exclusively within filters or |
| /// expressions do not produce columns in a report; correspondingly, those |
| /// dimensions do not produce headers. |
| typedef GoogleAnalyticsAdminV1betaAccessDimensionHeader = |
| $AccessDimensionHeader; |
| |
| /// The value of a dimension. |
| typedef GoogleAnalyticsAdminV1betaAccessDimensionValue = $AccessDimensionValue; |
| |
| /// An expression to filter dimension or metric values. |
| class GoogleAnalyticsAdminV1betaAccessFilter { |
| /// A filter for two values. |
| GoogleAnalyticsAdminV1betaAccessBetweenFilter? betweenFilter; |
| |
| /// The dimension name or metric name. |
| core.String? fieldName; |
| |
| /// A filter for in list values. |
| GoogleAnalyticsAdminV1betaAccessInListFilter? inListFilter; |
| |
| /// A filter for numeric or date values. |
| GoogleAnalyticsAdminV1betaAccessNumericFilter? numericFilter; |
| |
| /// Strings related filter. |
| GoogleAnalyticsAdminV1betaAccessStringFilter? stringFilter; |
| |
| GoogleAnalyticsAdminV1betaAccessFilter({ |
| this.betweenFilter, |
| this.fieldName, |
| this.inListFilter, |
| this.numericFilter, |
| this.stringFilter, |
| }); |
| |
| GoogleAnalyticsAdminV1betaAccessFilter.fromJson(core.Map json_) |
| : this( |
| betweenFilter: |
| json_.containsKey('betweenFilter') |
| ? GoogleAnalyticsAdminV1betaAccessBetweenFilter.fromJson( |
| json_['betweenFilter'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| fieldName: json_['fieldName'] as core.String?, |
| inListFilter: |
| json_.containsKey('inListFilter') |
| ? GoogleAnalyticsAdminV1betaAccessInListFilter.fromJson( |
| json_['inListFilter'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| numericFilter: |
| json_.containsKey('numericFilter') |
| ? GoogleAnalyticsAdminV1betaAccessNumericFilter.fromJson( |
| json_['numericFilter'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| stringFilter: |
| json_.containsKey('stringFilter') |
| ? GoogleAnalyticsAdminV1betaAccessStringFilter.fromJson( |
| json_['stringFilter'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (betweenFilter != null) 'betweenFilter': betweenFilter!, |
| if (fieldName != null) 'fieldName': fieldName!, |
| if (inListFilter != null) 'inListFilter': inListFilter!, |
| if (numericFilter != null) 'numericFilter': numericFilter!, |
| if (stringFilter != null) 'stringFilter': stringFilter!, |
| }; |
| } |
| |
| /// Expresses dimension or metric filters. |
| /// |
| /// The fields in the same expression need to be either all dimensions or all |
| /// metrics. |
| class GoogleAnalyticsAdminV1betaAccessFilterExpression { |
| /// A primitive filter. |
| /// |
| /// In the same FilterExpression, all of the filter's field names need to be |
| /// either all dimensions or all metrics. |
| GoogleAnalyticsAdminV1betaAccessFilter? accessFilter; |
| |
| /// Each of the FilterExpressions in the and_group has an AND relationship. |
| GoogleAnalyticsAdminV1betaAccessFilterExpressionList? andGroup; |
| |
| /// The FilterExpression is NOT of not_expression. |
| GoogleAnalyticsAdminV1betaAccessFilterExpression? notExpression; |
| |
| /// Each of the FilterExpressions in the or_group has an OR relationship. |
| GoogleAnalyticsAdminV1betaAccessFilterExpressionList? orGroup; |
| |
| GoogleAnalyticsAdminV1betaAccessFilterExpression({ |
| this.accessFilter, |
| this.andGroup, |
| this.notExpression, |
| this.orGroup, |
| }); |
| |
| GoogleAnalyticsAdminV1betaAccessFilterExpression.fromJson(core.Map json_) |
| : this( |
| accessFilter: |
| json_.containsKey('accessFilter') |
| ? GoogleAnalyticsAdminV1betaAccessFilter.fromJson( |
| json_['accessFilter'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| andGroup: |
| json_.containsKey('andGroup') |
| ? GoogleAnalyticsAdminV1betaAccessFilterExpressionList.fromJson( |
| json_['andGroup'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| notExpression: |
| json_.containsKey('notExpression') |
| ? GoogleAnalyticsAdminV1betaAccessFilterExpression.fromJson( |
| json_['notExpression'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| orGroup: |
| json_.containsKey('orGroup') |
| ? GoogleAnalyticsAdminV1betaAccessFilterExpressionList.fromJson( |
| json_['orGroup'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (accessFilter != null) 'accessFilter': accessFilter!, |
| if (andGroup != null) 'andGroup': andGroup!, |
| if (notExpression != null) 'notExpression': notExpression!, |
| if (orGroup != null) 'orGroup': orGroup!, |
| }; |
| } |
| |
| /// A list of filter expressions. |
| class GoogleAnalyticsAdminV1betaAccessFilterExpressionList { |
| /// A list of filter expressions. |
| core.List<GoogleAnalyticsAdminV1betaAccessFilterExpression>? expressions; |
| |
| GoogleAnalyticsAdminV1betaAccessFilterExpressionList({this.expressions}); |
| |
| GoogleAnalyticsAdminV1betaAccessFilterExpressionList.fromJson(core.Map json_) |
| : this( |
| expressions: |
| (json_['expressions'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaAccessFilterExpression.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (expressions != null) 'expressions': expressions!, |
| }; |
| } |
| |
| /// The result needs to be in a list of string values. |
| typedef GoogleAnalyticsAdminV1betaAccessInListFilter = $InListFilter; |
| |
| /// The quantitative measurements of a report. |
| /// |
| /// For example, the metric `accessCount` is the total number of data access |
| /// records. |
| typedef GoogleAnalyticsAdminV1betaAccessMetric = $AccessMetric; |
| |
| /// Describes a metric column in the report. |
| /// |
| /// Visible metrics requested in a report produce column entries within rows and |
| /// MetricHeaders. However, metrics used exclusively within filters or |
| /// expressions do not produce columns in a report; correspondingly, those |
| /// metrics do not produce headers. |
| typedef GoogleAnalyticsAdminV1betaAccessMetricHeader = $AccessMetricHeader; |
| |
| /// The value of a metric. |
| typedef GoogleAnalyticsAdminV1betaAccessMetricValue = $AccessMetricValue; |
| |
| /// Filters for numeric or date values. |
| class GoogleAnalyticsAdminV1betaAccessNumericFilter { |
| /// The operation type for this filter. |
| /// Possible string values are: |
| /// - "OPERATION_UNSPECIFIED" : Unspecified. |
| /// - "EQUAL" : Equal |
| /// - "LESS_THAN" : Less than |
| /// - "LESS_THAN_OR_EQUAL" : Less than or equal |
| /// - "GREATER_THAN" : Greater than |
| /// - "GREATER_THAN_OR_EQUAL" : Greater than or equal |
| core.String? operation; |
| |
| /// A numeric value or a date value. |
| GoogleAnalyticsAdminV1betaNumericValue? value; |
| |
| GoogleAnalyticsAdminV1betaAccessNumericFilter({this.operation, this.value}); |
| |
| GoogleAnalyticsAdminV1betaAccessNumericFilter.fromJson(core.Map json_) |
| : this( |
| operation: json_['operation'] as core.String?, |
| value: |
| json_.containsKey('value') |
| ? GoogleAnalyticsAdminV1betaNumericValue.fromJson( |
| json_['value'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (operation != null) 'operation': operation!, |
| if (value != null) 'value': value!, |
| }; |
| } |
| |
| /// Order bys define how rows will be sorted in the response. |
| /// |
| /// For example, ordering rows by descending access count is one ordering, and |
| /// ordering rows by the country string is a different ordering. |
| class GoogleAnalyticsAdminV1betaAccessOrderBy { |
| /// If true, sorts by descending order. |
| /// |
| /// If false or unspecified, sorts in ascending order. |
| core.bool? desc; |
| |
| /// Sorts results by a dimension's values. |
| GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy? dimension; |
| |
| /// Sorts results by a metric's values. |
| GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy? metric; |
| |
| GoogleAnalyticsAdminV1betaAccessOrderBy({ |
| this.desc, |
| this.dimension, |
| this.metric, |
| }); |
| |
| GoogleAnalyticsAdminV1betaAccessOrderBy.fromJson(core.Map json_) |
| : this( |
| desc: json_['desc'] as core.bool?, |
| dimension: |
| json_.containsKey('dimension') |
| ? GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy.fromJson( |
| json_['dimension'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| metric: |
| json_.containsKey('metric') |
| ? GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy.fromJson( |
| json_['metric'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (desc != null) 'desc': desc!, |
| if (dimension != null) 'dimension': dimension!, |
| if (metric != null) 'metric': metric!, |
| }; |
| } |
| |
| /// Sorts by dimension values. |
| typedef GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy = |
| $DimensionOrderBy; |
| |
| /// Sorts by metric values. |
| typedef GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy = $MetricOrderBy; |
| |
| /// Current state of all quotas for this Analytics property. |
| /// |
| /// If any quota for a property is exhausted, all requests to that property will |
| /// return Resource Exhausted errors. |
| class GoogleAnalyticsAdminV1betaAccessQuota { |
| /// Properties can use up to 50 concurrent requests. |
| GoogleAnalyticsAdminV1betaAccessQuotaStatus? concurrentRequests; |
| |
| /// Properties and cloud project pairs can have up to 50 server errors per |
| /// hour. |
| GoogleAnalyticsAdminV1betaAccessQuotaStatus? serverErrorsPerProjectPerHour; |
| |
| /// Properties can use 250,000 tokens per day. |
| /// |
| /// Most requests consume fewer than 10 tokens. |
| GoogleAnalyticsAdminV1betaAccessQuotaStatus? tokensPerDay; |
| |
| /// Properties can use 50,000 tokens per hour. |
| /// |
| /// An API request consumes a single number of tokens, and that number is |
| /// deducted from all of the hourly, daily, and per project hourly quotas. |
| GoogleAnalyticsAdminV1betaAccessQuotaStatus? tokensPerHour; |
| |
| /// Properties can use up to 25% of their tokens per project per hour. |
| /// |
| /// This amounts to Analytics 360 Properties can use 12,500 tokens per project |
| /// per hour. An API request consumes a single number of tokens, and that |
| /// number is deducted from all of the hourly, daily, and per project hourly |
| /// quotas. |
| GoogleAnalyticsAdminV1betaAccessQuotaStatus? tokensPerProjectPerHour; |
| |
| GoogleAnalyticsAdminV1betaAccessQuota({ |
| this.concurrentRequests, |
| this.serverErrorsPerProjectPerHour, |
| this.tokensPerDay, |
| this.tokensPerHour, |
| this.tokensPerProjectPerHour, |
| }); |
| |
| GoogleAnalyticsAdminV1betaAccessQuota.fromJson(core.Map json_) |
| : this( |
| concurrentRequests: |
| json_.containsKey('concurrentRequests') |
| ? GoogleAnalyticsAdminV1betaAccessQuotaStatus.fromJson( |
| json_['concurrentRequests'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| serverErrorsPerProjectPerHour: |
| json_.containsKey('serverErrorsPerProjectPerHour') |
| ? GoogleAnalyticsAdminV1betaAccessQuotaStatus.fromJson( |
| json_['serverErrorsPerProjectPerHour'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| tokensPerDay: |
| json_.containsKey('tokensPerDay') |
| ? GoogleAnalyticsAdminV1betaAccessQuotaStatus.fromJson( |
| json_['tokensPerDay'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| tokensPerHour: |
| json_.containsKey('tokensPerHour') |
| ? GoogleAnalyticsAdminV1betaAccessQuotaStatus.fromJson( |
| json_['tokensPerHour'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| tokensPerProjectPerHour: |
| json_.containsKey('tokensPerProjectPerHour') |
| ? GoogleAnalyticsAdminV1betaAccessQuotaStatus.fromJson( |
| json_['tokensPerProjectPerHour'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (concurrentRequests != null) 'concurrentRequests': concurrentRequests!, |
| if (serverErrorsPerProjectPerHour != null) |
| 'serverErrorsPerProjectPerHour': serverErrorsPerProjectPerHour!, |
| if (tokensPerDay != null) 'tokensPerDay': tokensPerDay!, |
| if (tokensPerHour != null) 'tokensPerHour': tokensPerHour!, |
| if (tokensPerProjectPerHour != null) |
| 'tokensPerProjectPerHour': tokensPerProjectPerHour!, |
| }; |
| } |
| |
| /// Current state for a particular quota group. |
| typedef GoogleAnalyticsAdminV1betaAccessQuotaStatus = $QuotaStatus; |
| |
| /// Access report data for each row. |
| class GoogleAnalyticsAdminV1betaAccessRow { |
| /// List of dimension values. |
| /// |
| /// These values are in the same order as specified in the request. |
| core.List<GoogleAnalyticsAdminV1betaAccessDimensionValue>? dimensionValues; |
| |
| /// List of metric values. |
| /// |
| /// These values are in the same order as specified in the request. |
| core.List<GoogleAnalyticsAdminV1betaAccessMetricValue>? metricValues; |
| |
| GoogleAnalyticsAdminV1betaAccessRow({ |
| this.dimensionValues, |
| this.metricValues, |
| }); |
| |
| GoogleAnalyticsAdminV1betaAccessRow.fromJson(core.Map json_) |
| : this( |
| dimensionValues: |
| (json_['dimensionValues'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaAccessDimensionValue.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| metricValues: |
| (json_['metricValues'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaAccessMetricValue.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (dimensionValues != null) 'dimensionValues': dimensionValues!, |
| if (metricValues != null) 'metricValues': metricValues!, |
| }; |
| } |
| |
| /// The filter for strings. |
| typedef GoogleAnalyticsAdminV1betaAccessStringFilter = $StringFilter; |
| |
| /// A resource message representing a Google Analytics account. |
| typedef GoogleAnalyticsAdminV1betaAccount = $Account; |
| |
| /// A virtual resource representing an overview of an account and all its child |
| /// Google Analytics properties. |
| class GoogleAnalyticsAdminV1betaAccountSummary { |
| /// Resource name of account referred to by this account summary Format: |
| /// accounts/{account_id} Example: "accounts/1000" |
| core.String? account; |
| |
| /// Display name for the account referred to in this account summary. |
| core.String? displayName; |
| |
| /// Resource name for this account summary. |
| /// |
| /// Format: accountSummaries/{account_id} Example: "accountSummaries/1000" |
| core.String? name; |
| |
| /// List of summaries for child accounts of this account. |
| core.List<GoogleAnalyticsAdminV1betaPropertySummary>? propertySummaries; |
| |
| GoogleAnalyticsAdminV1betaAccountSummary({ |
| this.account, |
| this.displayName, |
| this.name, |
| this.propertySummaries, |
| }); |
| |
| GoogleAnalyticsAdminV1betaAccountSummary.fromJson(core.Map json_) |
| : this( |
| account: json_['account'] as core.String?, |
| displayName: json_['displayName'] as core.String?, |
| name: json_['name'] as core.String?, |
| propertySummaries: |
| (json_['propertySummaries'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaPropertySummary.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (account != null) 'account': account!, |
| if (displayName != null) 'displayName': displayName!, |
| if (name != null) 'name': name!, |
| if (propertySummaries != null) 'propertySummaries': propertySummaries!, |
| }; |
| } |
| |
| /// Request message for AcknowledgeUserDataCollection RPC. |
| typedef GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest = |
| $AcknowledgeUserDataCollectionRequest; |
| |
| /// Response message for AcknowledgeUserDataCollection RPC. |
| typedef GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse = |
| $Empty; |
| |
| /// Request message for ArchiveCustomDimension RPC. |
| typedef GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest = $Empty; |
| |
| /// Request message for ArchiveCustomMetric RPC. |
| typedef GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest = $Empty; |
| |
| /// A description of a change to a single Google Analytics resource. |
| class GoogleAnalyticsAdminV1betaChangeHistoryChange { |
| /// The type of action that changed this resource. |
| /// Possible string values are: |
| /// - "ACTION_TYPE_UNSPECIFIED" : Action type unknown or not specified. |
| /// - "CREATED" : Resource was created in this change. |
| /// - "UPDATED" : Resource was updated in this change. |
| /// - "DELETED" : Resource was deleted in this change. |
| core.String? action; |
| |
| /// Resource name of the resource whose changes are described by this entry. |
| core.String? resource; |
| |
| /// Resource contents from after the change was made. |
| /// |
| /// If this resource was deleted in this change, this field will be missing. |
| GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource? |
| resourceAfterChange; |
| |
| /// Resource contents from before the change was made. |
| /// |
| /// If this resource was created in this change, this field will be missing. |
| GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource? |
| resourceBeforeChange; |
| |
| GoogleAnalyticsAdminV1betaChangeHistoryChange({ |
| this.action, |
| this.resource, |
| this.resourceAfterChange, |
| this.resourceBeforeChange, |
| }); |
| |
| GoogleAnalyticsAdminV1betaChangeHistoryChange.fromJson(core.Map json_) |
| : this( |
| action: json_['action'] as core.String?, |
| resource: json_['resource'] as core.String?, |
| resourceAfterChange: |
| json_.containsKey('resourceAfterChange') |
| ? GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource.fromJson( |
| json_['resourceAfterChange'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| resourceBeforeChange: |
| json_.containsKey('resourceBeforeChange') |
| ? GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource.fromJson( |
| json_['resourceBeforeChange'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (action != null) 'action': action!, |
| if (resource != null) 'resource': resource!, |
| if (resourceAfterChange != null) |
| 'resourceAfterChange': resourceAfterChange!, |
| if (resourceBeforeChange != null) |
| 'resourceBeforeChange': resourceBeforeChange!, |
| }; |
| } |
| |
| /// A snapshot of a resource as before or after the result of a change in change |
| /// history. |
| class GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource { |
| /// A snapshot of an Account resource in change history. |
| GoogleAnalyticsAdminV1betaAccount? account; |
| |
| /// A snapshot of a ConversionEvent resource in change history. |
| GoogleAnalyticsAdminV1betaConversionEvent? conversionEvent; |
| |
| /// A snapshot of a data retention settings resource in change history. |
| GoogleAnalyticsAdminV1betaDataRetentionSettings? dataRetentionSettings; |
| |
| /// A snapshot of a DataStream resource in change history. |
| GoogleAnalyticsAdminV1betaDataStream? dataStream; |
| |
| /// A snapshot of a FirebaseLink resource in change history. |
| GoogleAnalyticsAdminV1betaFirebaseLink? firebaseLink; |
| |
| /// A snapshot of a GoogleAdsLink resource in change history. |
| GoogleAnalyticsAdminV1betaGoogleAdsLink? googleAdsLink; |
| |
| /// A snapshot of a MeasurementProtocolSecret resource in change history. |
| GoogleAnalyticsAdminV1betaMeasurementProtocolSecret? |
| measurementProtocolSecret; |
| |
| /// A snapshot of a Property resource in change history. |
| GoogleAnalyticsAdminV1betaProperty? property; |
| |
| GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource({ |
| this.account, |
| this.conversionEvent, |
| this.dataRetentionSettings, |
| this.dataStream, |
| this.firebaseLink, |
| this.googleAdsLink, |
| this.measurementProtocolSecret, |
| this.property, |
| }); |
| |
| GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource.fromJson( |
| core.Map json_, |
| ) : this( |
| account: |
| json_.containsKey('account') |
| ? GoogleAnalyticsAdminV1betaAccount.fromJson( |
| json_['account'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| conversionEvent: |
| json_.containsKey('conversionEvent') |
| ? GoogleAnalyticsAdminV1betaConversionEvent.fromJson( |
| json_['conversionEvent'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| dataRetentionSettings: |
| json_.containsKey('dataRetentionSettings') |
| ? GoogleAnalyticsAdminV1betaDataRetentionSettings.fromJson( |
| json_['dataRetentionSettings'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| dataStream: |
| json_.containsKey('dataStream') |
| ? GoogleAnalyticsAdminV1betaDataStream.fromJson( |
| json_['dataStream'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| firebaseLink: |
| json_.containsKey('firebaseLink') |
| ? GoogleAnalyticsAdminV1betaFirebaseLink.fromJson( |
| json_['firebaseLink'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| googleAdsLink: |
| json_.containsKey('googleAdsLink') |
| ? GoogleAnalyticsAdminV1betaGoogleAdsLink.fromJson( |
| json_['googleAdsLink'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| measurementProtocolSecret: |
| json_.containsKey('measurementProtocolSecret') |
| ? GoogleAnalyticsAdminV1betaMeasurementProtocolSecret.fromJson( |
| json_['measurementProtocolSecret'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| property: |
| json_.containsKey('property') |
| ? GoogleAnalyticsAdminV1betaProperty.fromJson( |
| json_['property'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (account != null) 'account': account!, |
| if (conversionEvent != null) 'conversionEvent': conversionEvent!, |
| if (dataRetentionSettings != null) |
| 'dataRetentionSettings': dataRetentionSettings!, |
| if (dataStream != null) 'dataStream': dataStream!, |
| if (firebaseLink != null) 'firebaseLink': firebaseLink!, |
| if (googleAdsLink != null) 'googleAdsLink': googleAdsLink!, |
| if (measurementProtocolSecret != null) |
| 'measurementProtocolSecret': measurementProtocolSecret!, |
| if (property != null) 'property': property!, |
| }; |
| } |
| |
| /// A set of changes within a Google Analytics account or its child properties |
| /// that resulted from the same cause. |
| /// |
| /// Common causes would be updates made in the Google Analytics UI, changes from |
| /// customer support, or automatic Google Analytics system changes. |
| class GoogleAnalyticsAdminV1betaChangeHistoryEvent { |
| /// The type of actor that made this change. |
| /// Possible string values are: |
| /// - "ACTOR_TYPE_UNSPECIFIED" : Unknown or unspecified actor type. |
| /// - "USER" : Changes made by the user specified in actor_email. |
| /// - "SYSTEM" : Changes made by the Google Analytics system. |
| /// - "SUPPORT" : Changes made by Google Analytics support team staff. |
| core.String? actorType; |
| |
| /// Time when change was made. |
| core.String? changeTime; |
| |
| /// A list of changes made in this change history event that fit the filters |
| /// specified in SearchChangeHistoryEventsRequest. |
| core.List<GoogleAnalyticsAdminV1betaChangeHistoryChange>? changes; |
| |
| /// If true, then the list of changes returned was filtered, and does not |
| /// represent all changes that occurred in this event. |
| core.bool? changesFiltered; |
| |
| /// ID of this change history event. |
| /// |
| /// This ID is unique across Google Analytics. |
| core.String? id; |
| |
| /// Email address of the Google account that made the change. |
| /// |
| /// This will be a valid email address if the actor field is set to USER, and |
| /// empty otherwise. Google accounts that have been deleted will cause an |
| /// error. |
| core.String? userActorEmail; |
| |
| GoogleAnalyticsAdminV1betaChangeHistoryEvent({ |
| this.actorType, |
| this.changeTime, |
| this.changes, |
| this.changesFiltered, |
| this.id, |
| this.userActorEmail, |
| }); |
| |
| GoogleAnalyticsAdminV1betaChangeHistoryEvent.fromJson(core.Map json_) |
| : this( |
| actorType: json_['actorType'] as core.String?, |
| changeTime: json_['changeTime'] as core.String?, |
| changes: |
| (json_['changes'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaChangeHistoryChange.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| changesFiltered: json_['changesFiltered'] as core.bool?, |
| id: json_['id'] as core.String?, |
| userActorEmail: json_['userActorEmail'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (actorType != null) 'actorType': actorType!, |
| if (changeTime != null) 'changeTime': changeTime!, |
| if (changes != null) 'changes': changes!, |
| if (changesFiltered != null) 'changesFiltered': changesFiltered!, |
| if (id != null) 'id': id!, |
| if (userActorEmail != null) 'userActorEmail': userActorEmail!, |
| }; |
| } |
| |
| /// A conversion event in a Google Analytics property. |
| class GoogleAnalyticsAdminV1betaConversionEvent { |
| /// The method by which conversions will be counted across multiple events |
| /// within a session. |
| /// |
| /// If this value is not provided, it will be set to `ONCE_PER_EVENT`. |
| /// |
| /// Optional. |
| /// Possible string values are: |
| /// - "CONVERSION_COUNTING_METHOD_UNSPECIFIED" : Counting method not |
| /// specified. |
| /// - "ONCE_PER_EVENT" : Each Event instance is considered a Conversion. |
| /// - "ONCE_PER_SESSION" : An Event instance is considered a Conversion at |
| /// most once per session per user. |
| core.String? countingMethod; |
| |
| /// Time when this conversion event was created in the property. |
| /// |
| /// Output only. |
| core.String? createTime; |
| |
| /// If set to true, this conversion event refers to a custom event. |
| /// |
| /// If set to false, this conversion event refers to a default event in GA. |
| /// Default events typically have special meaning in GA. Default events are |
| /// usually created for you by the GA system, but in some cases can be created |
| /// by property admins. Custom events count towards the maximum number of |
| /// custom conversion events that may be created per property. |
| /// |
| /// Output only. |
| core.bool? custom; |
| |
| /// Defines a default value/currency for a conversion event. |
| /// |
| /// Optional. |
| GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue? |
| defaultConversionValue; |
| |
| /// If set, this event can currently be deleted with DeleteConversionEvent. |
| /// |
| /// Output only. |
| core.bool? deletable; |
| |
| /// The event name for this conversion event. |
| /// |
| /// Examples: 'click', 'purchase' |
| /// |
| /// Immutable. |
| core.String? eventName; |
| |
| /// Resource name of this conversion event. |
| /// |
| /// Format: properties/{property}/conversionEvents/{conversion_event} |
| /// |
| /// Output only. |
| core.String? name; |
| |
| GoogleAnalyticsAdminV1betaConversionEvent({ |
| this.countingMethod, |
| this.createTime, |
| this.custom, |
| this.defaultConversionValue, |
| this.deletable, |
| this.eventName, |
| this.name, |
| }); |
| |
| GoogleAnalyticsAdminV1betaConversionEvent.fromJson(core.Map json_) |
| : this( |
| countingMethod: json_['countingMethod'] as core.String?, |
| createTime: json_['createTime'] as core.String?, |
| custom: json_['custom'] as core.bool?, |
| defaultConversionValue: |
| json_.containsKey('defaultConversionValue') |
| ? GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue.fromJson( |
| json_['defaultConversionValue'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| deletable: json_['deletable'] as core.bool?, |
| eventName: json_['eventName'] as core.String?, |
| name: json_['name'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (countingMethod != null) 'countingMethod': countingMethod!, |
| if (createTime != null) 'createTime': createTime!, |
| if (custom != null) 'custom': custom!, |
| if (defaultConversionValue != null) |
| 'defaultConversionValue': defaultConversionValue!, |
| if (deletable != null) 'deletable': deletable!, |
| if (eventName != null) 'eventName': eventName!, |
| if (name != null) 'name': name!, |
| }; |
| } |
| |
| /// Defines a default value/currency for a conversion event. |
| /// |
| /// Both value and currency must be provided. |
| typedef GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue = |
| $ConversionEventDefaultConversionValue; |
| |
| /// A definition for a CustomDimension. |
| typedef GoogleAnalyticsAdminV1betaCustomDimension = $CustomDimension; |
| |
| /// A definition for a custom metric. |
| typedef GoogleAnalyticsAdminV1betaCustomMetric = $CustomMetric; |
| |
| /// Settings values for data retention. |
| /// |
| /// This is a singleton resource. |
| typedef GoogleAnalyticsAdminV1betaDataRetentionSettings = |
| $DataRetentionSettings; |
| |
| /// A resource message representing data sharing settings of a Google Analytics |
| /// account. |
| typedef GoogleAnalyticsAdminV1betaDataSharingSettings = $DataSharingSettings; |
| |
| /// A resource message representing a data stream. |
| class GoogleAnalyticsAdminV1betaDataStream { |
| /// Data specific to Android app streams. |
| /// |
| /// Must be populated if type is ANDROID_APP_DATA_STREAM. |
| GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData? |
| androidAppStreamData; |
| |
| /// Time when this stream was originally created. |
| /// |
| /// Output only. |
| core.String? createTime; |
| |
| /// Human-readable display name for the Data Stream. |
| /// |
| /// Required for web data streams. The max allowed display name length is 255 |
| /// UTF-16 code units. |
| core.String? displayName; |
| |
| /// Data specific to iOS app streams. |
| /// |
| /// Must be populated if type is IOS_APP_DATA_STREAM. |
| GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData? iosAppStreamData; |
| |
| /// Resource name of this Data Stream. |
| /// |
| /// Format: properties/{property_id}/dataStreams/{stream_id} Example: |
| /// "properties/1000/dataStreams/2000" |
| /// |
| /// Output only. |
| core.String? name; |
| |
| /// The type of this DataStream resource. |
| /// |
| /// Required. Immutable. |
| /// Possible string values are: |
| /// - "DATA_STREAM_TYPE_UNSPECIFIED" : Type unknown or not specified. |
| /// - "WEB_DATA_STREAM" : Web data stream. |
| /// - "ANDROID_APP_DATA_STREAM" : Android app data stream. |
| /// - "IOS_APP_DATA_STREAM" : iOS app data stream. |
| core.String? type; |
| |
| /// Time when stream payload fields were last updated. |
| /// |
| /// Output only. |
| core.String? updateTime; |
| |
| /// Data specific to web streams. |
| /// |
| /// Must be populated if type is WEB_DATA_STREAM. |
| GoogleAnalyticsAdminV1betaDataStreamWebStreamData? webStreamData; |
| |
| GoogleAnalyticsAdminV1betaDataStream({ |
| this.androidAppStreamData, |
| this.createTime, |
| this.displayName, |
| this.iosAppStreamData, |
| this.name, |
| this.type, |
| this.updateTime, |
| this.webStreamData, |
| }); |
| |
| GoogleAnalyticsAdminV1betaDataStream.fromJson(core.Map json_) |
| : this( |
| androidAppStreamData: |
| json_.containsKey('androidAppStreamData') |
| ? GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData.fromJson( |
| json_['androidAppStreamData'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| createTime: json_['createTime'] as core.String?, |
| displayName: json_['displayName'] as core.String?, |
| iosAppStreamData: |
| json_.containsKey('iosAppStreamData') |
| ? GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData.fromJson( |
| json_['iosAppStreamData'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| name: json_['name'] as core.String?, |
| type: json_['type'] as core.String?, |
| updateTime: json_['updateTime'] as core.String?, |
| webStreamData: |
| json_.containsKey('webStreamData') |
| ? GoogleAnalyticsAdminV1betaDataStreamWebStreamData.fromJson( |
| json_['webStreamData'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (androidAppStreamData != null) |
| 'androidAppStreamData': androidAppStreamData!, |
| if (createTime != null) 'createTime': createTime!, |
| if (displayName != null) 'displayName': displayName!, |
| if (iosAppStreamData != null) 'iosAppStreamData': iosAppStreamData!, |
| if (name != null) 'name': name!, |
| if (type != null) 'type': type!, |
| if (updateTime != null) 'updateTime': updateTime!, |
| if (webStreamData != null) 'webStreamData': webStreamData!, |
| }; |
| } |
| |
| /// Data specific to Android app streams. |
| typedef GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData = |
| $DataStreamAndroidAppStreamData; |
| |
| /// Data specific to iOS app streams. |
| typedef GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData = |
| $DataStreamIosAppStreamData; |
| |
| /// Data specific to web streams. |
| typedef GoogleAnalyticsAdminV1betaDataStreamWebStreamData = |
| $DataStreamWebStreamData; |
| |
| /// A link between a Google Analytics property and a Firebase project. |
| typedef GoogleAnalyticsAdminV1betaFirebaseLink = $FirebaseLink; |
| |
| /// A link between a Google Analytics property and a Google Ads account. |
| typedef GoogleAnalyticsAdminV1betaGoogleAdsLink = $GoogleAdsLink; |
| |
| /// A key event in a Google Analytics property. |
| class GoogleAnalyticsAdminV1betaKeyEvent { |
| /// The method by which Key Events will be counted across multiple events |
| /// within a session. |
| /// |
| /// Required. |
| /// Possible string values are: |
| /// - "COUNTING_METHOD_UNSPECIFIED" : Counting method not specified. |
| /// - "ONCE_PER_EVENT" : Each Event instance is considered a Key Event. |
| /// - "ONCE_PER_SESSION" : An Event instance is considered a Key Event at most |
| /// once per session per user. |
| core.String? countingMethod; |
| |
| /// Time when this key event was created in the property. |
| /// |
| /// Output only. |
| core.String? createTime; |
| |
| /// If set to true, this key event refers to a custom event. |
| /// |
| /// If set to false, this key event refers to a default event in GA. Default |
| /// events typically have special meaning in GA. Default events are usually |
| /// created for you by the GA system, but in some cases can be created by |
| /// property admins. Custom events count towards the maximum number of custom |
| /// key events that may be created per property. |
| /// |
| /// Output only. |
| core.bool? custom; |
| |
| /// Defines a default value/currency for a key event. |
| /// |
| /// Optional. |
| GoogleAnalyticsAdminV1betaKeyEventDefaultValue? defaultValue; |
| |
| /// If set to true, this event can be deleted. |
| /// |
| /// Output only. |
| core.bool? deletable; |
| |
| /// The event name for this key event. |
| /// |
| /// Examples: 'click', 'purchase' |
| /// |
| /// Immutable. |
| core.String? eventName; |
| |
| /// Resource name of this key event. |
| /// |
| /// Format: properties/{property}/keyEvents/{key_event} |
| /// |
| /// Output only. |
| core.String? name; |
| |
| GoogleAnalyticsAdminV1betaKeyEvent({ |
| this.countingMethod, |
| this.createTime, |
| this.custom, |
| this.defaultValue, |
| this.deletable, |
| this.eventName, |
| this.name, |
| }); |
| |
| GoogleAnalyticsAdminV1betaKeyEvent.fromJson(core.Map json_) |
| : this( |
| countingMethod: json_['countingMethod'] as core.String?, |
| createTime: json_['createTime'] as core.String?, |
| custom: json_['custom'] as core.bool?, |
| defaultValue: |
| json_.containsKey('defaultValue') |
| ? GoogleAnalyticsAdminV1betaKeyEventDefaultValue.fromJson( |
| json_['defaultValue'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| deletable: json_['deletable'] as core.bool?, |
| eventName: json_['eventName'] as core.String?, |
| name: json_['name'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (countingMethod != null) 'countingMethod': countingMethod!, |
| if (createTime != null) 'createTime': createTime!, |
| if (custom != null) 'custom': custom!, |
| if (defaultValue != null) 'defaultValue': defaultValue!, |
| if (deletable != null) 'deletable': deletable!, |
| if (eventName != null) 'eventName': eventName!, |
| if (name != null) 'name': name!, |
| }; |
| } |
| |
| /// Defines a default value/currency for a key event. |
| typedef GoogleAnalyticsAdminV1betaKeyEventDefaultValue = $KeyEventDefaultValue; |
| |
| /// Response message for ListAccountSummaries RPC. |
| class GoogleAnalyticsAdminV1betaListAccountSummariesResponse { |
| /// Account summaries of all accounts the caller has access to. |
| core.List<GoogleAnalyticsAdminV1betaAccountSummary>? accountSummaries; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListAccountSummariesResponse({ |
| this.accountSummaries, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListAccountSummariesResponse.fromJson( |
| core.Map json_, |
| ) : this( |
| accountSummaries: |
| (json_['accountSummaries'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccountSummary.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (accountSummaries != null) 'accountSummaries': accountSummaries!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Request message for ListAccounts RPC. |
| class GoogleAnalyticsAdminV1betaListAccountsResponse { |
| /// Results that were accessible to the caller. |
| core.List<GoogleAnalyticsAdminV1betaAccount>? accounts; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListAccountsResponse({ |
| this.accounts, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListAccountsResponse.fromJson(core.Map json_) |
| : this( |
| accounts: |
| (json_['accounts'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccount.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (accounts != null) 'accounts': accounts!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListConversionEvents RPC. |
| class GoogleAnalyticsAdminV1betaListConversionEventsResponse { |
| /// The requested conversion events |
| core.List<GoogleAnalyticsAdminV1betaConversionEvent>? conversionEvents; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListConversionEventsResponse({ |
| this.conversionEvents, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListConversionEventsResponse.fromJson( |
| core.Map json_, |
| ) : this( |
| conversionEvents: |
| (json_['conversionEvents'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaConversionEvent.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (conversionEvents != null) 'conversionEvents': conversionEvents!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListCustomDimensions RPC. |
| class GoogleAnalyticsAdminV1betaListCustomDimensionsResponse { |
| /// List of CustomDimensions. |
| core.List<GoogleAnalyticsAdminV1betaCustomDimension>? customDimensions; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListCustomDimensionsResponse({ |
| this.customDimensions, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListCustomDimensionsResponse.fromJson( |
| core.Map json_, |
| ) : this( |
| customDimensions: |
| (json_['customDimensions'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaCustomDimension.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (customDimensions != null) 'customDimensions': customDimensions!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListCustomMetrics RPC. |
| class GoogleAnalyticsAdminV1betaListCustomMetricsResponse { |
| /// List of CustomMetrics. |
| core.List<GoogleAnalyticsAdminV1betaCustomMetric>? customMetrics; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListCustomMetricsResponse({ |
| this.customMetrics, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListCustomMetricsResponse.fromJson(core.Map json_) |
| : this( |
| customMetrics: |
| (json_['customMetrics'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaCustomMetric.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (customMetrics != null) 'customMetrics': customMetrics!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListDataStreams RPC. |
| class GoogleAnalyticsAdminV1betaListDataStreamsResponse { |
| /// List of DataStreams. |
| core.List<GoogleAnalyticsAdminV1betaDataStream>? dataStreams; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListDataStreamsResponse({ |
| this.dataStreams, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListDataStreamsResponse.fromJson(core.Map json_) |
| : this( |
| dataStreams: |
| (json_['dataStreams'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaDataStream.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (dataStreams != null) 'dataStreams': dataStreams!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListFirebaseLinks RPC |
| class GoogleAnalyticsAdminV1betaListFirebaseLinksResponse { |
| /// List of FirebaseLinks. |
| /// |
| /// This will have at most one value. |
| core.List<GoogleAnalyticsAdminV1betaFirebaseLink>? firebaseLinks; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. Currently, Google |
| /// Analytics supports only one FirebaseLink per property, so this will never |
| /// be populated. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListFirebaseLinksResponse({ |
| this.firebaseLinks, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListFirebaseLinksResponse.fromJson(core.Map json_) |
| : this( |
| firebaseLinks: |
| (json_['firebaseLinks'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaFirebaseLink.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (firebaseLinks != null) 'firebaseLinks': firebaseLinks!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListGoogleAdsLinks RPC. |
| class GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse { |
| /// List of GoogleAdsLinks. |
| core.List<GoogleAnalyticsAdminV1betaGoogleAdsLink>? googleAdsLinks; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse({ |
| this.googleAdsLinks, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse.fromJson(core.Map json_) |
| : this( |
| googleAdsLinks: |
| (json_['googleAdsLinks'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaGoogleAdsLink.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (googleAdsLinks != null) 'googleAdsLinks': googleAdsLinks!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListKeyEvents RPC. |
| class GoogleAnalyticsAdminV1betaListKeyEventsResponse { |
| /// The requested Key Events |
| core.List<GoogleAnalyticsAdminV1betaKeyEvent>? keyEvents; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListKeyEventsResponse({ |
| this.keyEvents, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListKeyEventsResponse.fromJson(core.Map json_) |
| : this( |
| keyEvents: |
| (json_['keyEvents'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaKeyEvent.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (keyEvents != null) 'keyEvents': keyEvents!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListMeasurementProtocolSecret RPC |
| class GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse { |
| /// A list of secrets for the parent stream specified in the request. |
| core.List<GoogleAnalyticsAdminV1betaMeasurementProtocolSecret>? |
| measurementProtocolSecrets; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse({ |
| this.measurementProtocolSecrets, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse.fromJson( |
| core.Map json_, |
| ) : this( |
| measurementProtocolSecrets: |
| (json_['measurementProtocolSecrets'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaMeasurementProtocolSecret.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (measurementProtocolSecrets != null) |
| 'measurementProtocolSecrets': measurementProtocolSecrets!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// Response message for ListProperties RPC. |
| class GoogleAnalyticsAdminV1betaListPropertiesResponse { |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| /// Results that matched the filter criteria and were accessible to the |
| /// caller. |
| core.List<GoogleAnalyticsAdminV1betaProperty>? properties; |
| |
| GoogleAnalyticsAdminV1betaListPropertiesResponse({ |
| this.nextPageToken, |
| this.properties, |
| }); |
| |
| GoogleAnalyticsAdminV1betaListPropertiesResponse.fromJson(core.Map json_) |
| : this( |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| properties: |
| (json_['properties'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaProperty.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| if (properties != null) 'properties': properties!, |
| }; |
| } |
| |
| /// A secret value used for sending hits to Measurement Protocol. |
| typedef GoogleAnalyticsAdminV1betaMeasurementProtocolSecret = |
| $MeasurementProtocolSecret; |
| |
| /// To represent a number. |
| typedef GoogleAnalyticsAdminV1betaNumericValue = $NumericValue; |
| |
| /// A resource message representing a Google Analytics property. |
| typedef GoogleAnalyticsAdminV1betaProperty = $Property; |
| |
| /// A virtual resource representing metadata for a Google Analytics property. |
| typedef GoogleAnalyticsAdminV1betaPropertySummary = $PropertySummary; |
| |
| /// Request message for ProvisionAccountTicket RPC. |
| class GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest { |
| /// The account to create. |
| GoogleAnalyticsAdminV1betaAccount? account; |
| |
| /// Redirect URI where the user will be sent after accepting Terms of Service. |
| /// |
| /// Must be configured in Cloud Console as a Redirect URI. |
| core.String? redirectUri; |
| |
| GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest({ |
| this.account, |
| this.redirectUri, |
| }); |
| |
| GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest.fromJson( |
| core.Map json_, |
| ) : this( |
| account: |
| json_.containsKey('account') |
| ? GoogleAnalyticsAdminV1betaAccount.fromJson( |
| json_['account'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| redirectUri: json_['redirectUri'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (account != null) 'account': account!, |
| if (redirectUri != null) 'redirectUri': redirectUri!, |
| }; |
| } |
| |
| /// Response message for ProvisionAccountTicket RPC. |
| typedef GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse = |
| $ProvisionAccountTicketResponse; |
| |
| /// The request for a Data Access Record Report. |
| class GoogleAnalyticsAdminV1betaRunAccessReportRequest { |
| /// Date ranges of access records to read. |
| /// |
| /// If multiple date ranges are requested, each response row will contain a |
| /// zero based date range index. If two date ranges overlap, the access |
| /// records for the overlapping days is included in the response rows for both |
| /// date ranges. Requests are allowed up to 2 date ranges. |
| core.List<GoogleAnalyticsAdminV1betaAccessDateRange>? dateRanges; |
| |
| /// Dimension filters let you restrict report response to specific dimension |
| /// values which match the filter. |
| /// |
| /// For example, filtering on access records of a single user. To learn more, |
| /// see |
| /// [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) |
| /// for examples. Metrics cannot be used in this filter. |
| GoogleAnalyticsAdminV1betaAccessFilterExpression? dimensionFilter; |
| |
| /// The dimensions requested and displayed in the response. |
| /// |
| /// Requests are allowed up to 9 dimensions. |
| core.List<GoogleAnalyticsAdminV1betaAccessDimension>? dimensions; |
| |
| /// Decides whether to return the users within user groups. |
| /// |
| /// This field works only when include_all_users is set to true. If true, it |
| /// will return all users with access to the specified property or account. If |
| /// false, only the users with direct access will be returned. |
| /// |
| /// Optional. |
| core.bool? expandGroups; |
| |
| /// Determines whether to include users who have never made an API call in the |
| /// response. |
| /// |
| /// If true, all users with access to the specified property or account are |
| /// included in the response, regardless of whether they have made an API call |
| /// or not. If false, only the users who have made an API call will be |
| /// included. |
| /// |
| /// Optional. |
| core.bool? includeAllUsers; |
| |
| /// The number of rows to return. |
| /// |
| /// If unspecified, 10,000 rows are returned. The API returns a maximum of |
| /// 100,000 rows per request, no matter how many you ask for. `limit` must be |
| /// positive. The API may return fewer rows than the requested `limit`, if |
| /// there aren't as many remaining rows as the `limit`. For instance, there |
| /// are fewer than 300 possible values for the dimension `country`, so when |
| /// reporting on only `country`, you can't get more than 300 rows, even if you |
| /// set `limit` to a higher value. To learn more about this pagination |
| /// parameter, see |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). |
| core.String? limit; |
| |
| /// Metric filters allow you to restrict report response to specific metric |
| /// values which match the filter. |
| /// |
| /// Metric filters are applied after aggregating the report's rows, similar to |
| /// SQL having-clause. Dimensions cannot be used in this filter. |
| GoogleAnalyticsAdminV1betaAccessFilterExpression? metricFilter; |
| |
| /// The metrics requested and displayed in the response. |
| /// |
| /// Requests are allowed up to 10 metrics. |
| core.List<GoogleAnalyticsAdminV1betaAccessMetric>? metrics; |
| |
| /// The row count of the start row. |
| /// |
| /// The first row is counted as row 0. If offset is unspecified, it is treated |
| /// as 0. If offset is zero, then this method will return the first page of |
| /// results with `limit` entries. To learn more about this pagination |
| /// parameter, see |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). |
| core.String? offset; |
| |
| /// Specifies how rows are ordered in the response. |
| core.List<GoogleAnalyticsAdminV1betaAccessOrderBy>? orderBys; |
| |
| /// Toggles whether to return the current state of this Analytics Property's |
| /// quota. |
| /// |
| /// Quota is returned in \[AccessQuota\](#AccessQuota). For account-level |
| /// requests, this field must be false. |
| core.bool? returnEntityQuota; |
| |
| /// This request's time zone if specified. |
| /// |
| /// If unspecified, the property's time zone is used. The request's time zone |
| /// is used to interpret the start & end dates of the report. Formatted as |
| /// strings from the IANA Time Zone database |
| /// (https://www.iana.org/time-zones); for example "America/New_York" or |
| /// "Asia/Tokyo". |
| core.String? timeZone; |
| |
| GoogleAnalyticsAdminV1betaRunAccessReportRequest({ |
| this.dateRanges, |
| this.dimensionFilter, |
| this.dimensions, |
| this.expandGroups, |
| this.includeAllUsers, |
| this.limit, |
| this.metricFilter, |
| this.metrics, |
| this.offset, |
| this.orderBys, |
| this.returnEntityQuota, |
| this.timeZone, |
| }); |
| |
| GoogleAnalyticsAdminV1betaRunAccessReportRequest.fromJson(core.Map json_) |
| : this( |
| dateRanges: |
| (json_['dateRanges'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccessDateRange.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| dimensionFilter: |
| json_.containsKey('dimensionFilter') |
| ? GoogleAnalyticsAdminV1betaAccessFilterExpression.fromJson( |
| json_['dimensionFilter'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| dimensions: |
| (json_['dimensions'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccessDimension.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| expandGroups: json_['expandGroups'] as core.bool?, |
| includeAllUsers: json_['includeAllUsers'] as core.bool?, |
| limit: json_['limit'] as core.String?, |
| metricFilter: |
| json_.containsKey('metricFilter') |
| ? GoogleAnalyticsAdminV1betaAccessFilterExpression.fromJson( |
| json_['metricFilter'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| metrics: |
| (json_['metrics'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccessMetric.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| offset: json_['offset'] as core.String?, |
| orderBys: |
| (json_['orderBys'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccessOrderBy.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| returnEntityQuota: json_['returnEntityQuota'] as core.bool?, |
| timeZone: json_['timeZone'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (dateRanges != null) 'dateRanges': dateRanges!, |
| if (dimensionFilter != null) 'dimensionFilter': dimensionFilter!, |
| if (dimensions != null) 'dimensions': dimensions!, |
| if (expandGroups != null) 'expandGroups': expandGroups!, |
| if (includeAllUsers != null) 'includeAllUsers': includeAllUsers!, |
| if (limit != null) 'limit': limit!, |
| if (metricFilter != null) 'metricFilter': metricFilter!, |
| if (metrics != null) 'metrics': metrics!, |
| if (offset != null) 'offset': offset!, |
| if (orderBys != null) 'orderBys': orderBys!, |
| if (returnEntityQuota != null) 'returnEntityQuota': returnEntityQuota!, |
| if (timeZone != null) 'timeZone': timeZone!, |
| }; |
| } |
| |
| /// The customized Data Access Record Report response. |
| class GoogleAnalyticsAdminV1betaRunAccessReportResponse { |
| /// The header for a column in the report that corresponds to a specific |
| /// dimension. |
| /// |
| /// The number of DimensionHeaders and ordering of DimensionHeaders matches |
| /// the dimensions present in rows. |
| core.List<GoogleAnalyticsAdminV1betaAccessDimensionHeader>? dimensionHeaders; |
| |
| /// The header for a column in the report that corresponds to a specific |
| /// metric. |
| /// |
| /// The number of MetricHeaders and ordering of MetricHeaders matches the |
| /// metrics present in rows. |
| core.List<GoogleAnalyticsAdminV1betaAccessMetricHeader>? metricHeaders; |
| |
| /// The quota state for this Analytics property including this request. |
| /// |
| /// This field doesn't work with account-level requests. |
| GoogleAnalyticsAdminV1betaAccessQuota? quota; |
| |
| /// The total number of rows in the query result. |
| /// |
| /// `rowCount` is independent of the number of rows returned in the response, |
| /// the `limit` request parameter, and the `offset` request parameter. For |
| /// example if a query returns 175 rows and includes `limit` of 50 in the API |
| /// request, the response will contain `rowCount` of 175 but only 50 rows. To |
| /// learn more about this pagination parameter, see |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). |
| core.int? rowCount; |
| |
| /// Rows of dimension value combinations and metric values in the report. |
| core.List<GoogleAnalyticsAdminV1betaAccessRow>? rows; |
| |
| GoogleAnalyticsAdminV1betaRunAccessReportResponse({ |
| this.dimensionHeaders, |
| this.metricHeaders, |
| this.quota, |
| this.rowCount, |
| this.rows, |
| }); |
| |
| GoogleAnalyticsAdminV1betaRunAccessReportResponse.fromJson(core.Map json_) |
| : this( |
| dimensionHeaders: |
| (json_['dimensionHeaders'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaAccessDimensionHeader.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| metricHeaders: |
| (json_['metricHeaders'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaAccessMetricHeader.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| quota: |
| json_.containsKey('quota') |
| ? GoogleAnalyticsAdminV1betaAccessQuota.fromJson( |
| json_['quota'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| rowCount: json_['rowCount'] as core.int?, |
| rows: |
| (json_['rows'] as core.List?) |
| ?.map( |
| (value) => GoogleAnalyticsAdminV1betaAccessRow.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (dimensionHeaders != null) 'dimensionHeaders': dimensionHeaders!, |
| if (metricHeaders != null) 'metricHeaders': metricHeaders!, |
| if (quota != null) 'quota': quota!, |
| if (rowCount != null) 'rowCount': rowCount!, |
| if (rows != null) 'rows': rows!, |
| }; |
| } |
| |
| /// Request message for SearchChangeHistoryEvents RPC. |
| class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest { |
| /// If set, only return changes that match one or more of these types of |
| /// actions. |
| /// |
| /// Optional. |
| core.List<core.String>? action; |
| |
| /// If set, only return changes if they are made by a user in this list. |
| /// |
| /// Optional. |
| core.List<core.String>? actorEmail; |
| |
| /// If set, only return changes made after this time (inclusive). |
| /// |
| /// Optional. |
| core.String? earliestChangeTime; |
| |
| /// If set, only return changes made before this time (inclusive). |
| /// |
| /// Optional. |
| core.String? latestChangeTime; |
| |
| /// The maximum number of ChangeHistoryEvent items to return. |
| /// |
| /// If unspecified, at most 50 items will be returned. The maximum value is |
| /// 200 (higher values will be coerced to the maximum). Note that the service |
| /// may return a page with fewer items than this value specifies (potentially |
| /// even zero), and that there still may be additional pages. If you want a |
| /// particular number of items, you'll need to continue requesting additional |
| /// pages using `page_token` until you get the needed number. |
| /// |
| /// Optional. |
| core.int? pageSize; |
| |
| /// A page token, received from a previous `SearchChangeHistoryEvents` call. |
| /// |
| /// Provide this to retrieve the subsequent page. When paginating, all other |
| /// parameters provided to `SearchChangeHistoryEvents` must match the call |
| /// that provided the page token. |
| /// |
| /// Optional. |
| core.String? pageToken; |
| |
| /// Resource name for a child property. |
| /// |
| /// If set, only return changes made to this property or its child resources. |
| /// Format: properties/{propertyId} Example: `properties/100` |
| /// |
| /// Optional. |
| core.String? property; |
| |
| /// If set, only return changes if they are for a resource that matches at |
| /// least one of these types. |
| /// |
| /// Optional. |
| core.List<core.String>? resourceType; |
| |
| GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest({ |
| this.action, |
| this.actorEmail, |
| this.earliestChangeTime, |
| this.latestChangeTime, |
| this.pageSize, |
| this.pageToken, |
| this.property, |
| this.resourceType, |
| }); |
| |
| GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest.fromJson( |
| core.Map json_, |
| ) : this( |
| action: |
| (json_['action'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| actorEmail: |
| (json_['actorEmail'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| earliestChangeTime: json_['earliestChangeTime'] as core.String?, |
| latestChangeTime: json_['latestChangeTime'] as core.String?, |
| pageSize: json_['pageSize'] as core.int?, |
| pageToken: json_['pageToken'] as core.String?, |
| property: json_['property'] as core.String?, |
| resourceType: |
| (json_['resourceType'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (action != null) 'action': action!, |
| if (actorEmail != null) 'actorEmail': actorEmail!, |
| if (earliestChangeTime != null) 'earliestChangeTime': earliestChangeTime!, |
| if (latestChangeTime != null) 'latestChangeTime': latestChangeTime!, |
| if (pageSize != null) 'pageSize': pageSize!, |
| if (pageToken != null) 'pageToken': pageToken!, |
| if (property != null) 'property': property!, |
| if (resourceType != null) 'resourceType': resourceType!, |
| }; |
| } |
| |
| /// Response message for SearchAccounts RPC. |
| class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse { |
| /// Results that were accessible to the caller. |
| core.List<GoogleAnalyticsAdminV1betaChangeHistoryEvent>? changeHistoryEvents; |
| |
| /// A token, which can be sent as `page_token` to retrieve the next page. |
| /// |
| /// If this field is omitted, there are no subsequent pages. |
| core.String? nextPageToken; |
| |
| GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse({ |
| this.changeHistoryEvents, |
| this.nextPageToken, |
| }); |
| |
| GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse.fromJson( |
| core.Map json_, |
| ) : this( |
| changeHistoryEvents: |
| (json_['changeHistoryEvents'] as core.List?) |
| ?.map( |
| (value) => |
| GoogleAnalyticsAdminV1betaChangeHistoryEvent.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (changeHistoryEvents != null) |
| 'changeHistoryEvents': changeHistoryEvents!, |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| }; |
| } |
| |
| /// A generic empty message that you can re-use to avoid defining duplicated |
| /// empty messages in your APIs. |
| /// |
| /// A typical example is to use it as the request or the response type of an API |
| /// method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns |
| /// (google.protobuf.Empty); } |
| typedef GoogleProtobufEmpty = $Empty; |