Class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/analyticsadmin_v1beta/service.rb

Overview

Google Analytics Admin API

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.

Examples:

require 'google/apis/analyticsadmin_v1beta'

Analyticsadmin = Google::Apis::AnalyticsadminV1beta # Alias the module
service = Analyticsadmin::GoogleAnalyticsAdminService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GoogleAnalyticsAdminService

Returns a new instance of GoogleAnalyticsAdminService.



50
51
52
53
54
55
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 50

def initialize
  super('https://analyticsadmin.googleapis.com/', '',
        client_name: 'google-apis-analyticsadmin_v1beta',
        client_version: Google::Apis::AnalyticsadminV1beta::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



43
44
45
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 43

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



48
49
50
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 48

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_property_user_data_collection(property, google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse

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.

Parameters:

  • property (String) —

    Required. The property for which to acknowledge user data collection.

  • google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 414

def acknowledge_property_user_data_collection(property, google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:acknowledgeUserDataCollection', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest::Representation
  command.request_object = google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#archive_property_custom_dimension(name, google_analytics_admin_v1beta_archive_custom_dimension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Archives a CustomDimension on a property.

Parameters:

  • name (String) —

    Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

  • google_analytics_admin_v1beta_archive_custom_dimension_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 900

def archive_property_custom_dimension(name, google_analytics_admin_v1beta_archive_custom_dimension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+name}:archive', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest::Representation
  command.request_object = google_analytics_admin_v1beta_archive_custom_dimension_request_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#archive_property_custom_metric(name, google_analytics_admin_v1beta_archive_custom_metric_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Archives a CustomMetric on a property.

Parameters:

  • name (String) —

    Required. The name of the CustomMetric to archive. Example format: properties/ 1234/customMetrics/5678

  • google_analytics_admin_v1beta_archive_custom_metric_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1078

def archive_property_custom_metric(name, google_analytics_admin_v1beta_archive_custom_metric_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+name}:archive', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest::Representation
  command.request_object = google_analytics_admin_v1beta_archive_custom_metric_request_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property(google_analytics_admin_v1beta_property_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty

Creates an "GA4" property with the specified location and attributes.

Parameters:

  • google_analytics_admin_v1beta_property_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



445
446
447
448
449
450
451
452
453
454
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 445

def create_property(google_analytics_admin_v1beta_property_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/properties', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
  command.request_object = google_analytics_admin_v1beta_property_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_conversion_event(parent, google_analytics_admin_v1beta_conversion_event_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent

Creates a conversion event with the specified attributes.

Parameters:

  • parent (String) —

    Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

  • google_analytics_admin_v1beta_conversion_event_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 760

def create_property_conversion_event(parent, google_analytics_admin_v1beta_conversion_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/conversionEvents', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent::Representation
  command.request_object = google_analytics_admin_v1beta_conversion_event_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_custom_dimension(parent, google_analytics_admin_v1beta_custom_dimension_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension

Creates a CustomDimension.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • google_analytics_admin_v1beta_custom_dimension_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 933

def create_property_custom_dimension(parent, google_analytics_admin_v1beta_custom_dimension_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/customDimensions', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
  command.request_object = google_analytics_admin_v1beta_custom_dimension_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_custom_metric(parent, google_analytics_admin_v1beta_custom_metric_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric

Creates a CustomMetric.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • google_analytics_admin_v1beta_custom_metric_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1111

def create_property_custom_metric(parent, google_analytics_admin_v1beta_custom_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/customMetrics', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
  command.request_object = google_analytics_admin_v1beta_custom_metric_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_data_stream(parent, google_analytics_admin_v1beta_data_stream_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream

Creates a DataStream.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • google_analytics_admin_v1beta_data_stream_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1255

def create_property_data_stream(parent, google_analytics_admin_v1beta_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/dataStreams', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
  command.request_object = google_analytics_admin_v1beta_data_stream_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1beta_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret

Creates a measurement protocol secret.

Parameters:

  • parent (String) —

    Required. The parent resource where this secret will be created. Format: properties/property/dataStreams/dataStream

  • google_analytics_admin_v1beta_measurement_protocol_secret_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1431

def create_property_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1beta_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/measurementProtocolSecrets', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
  command.request_object = google_analytics_admin_v1beta_measurement_protocol_secret_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_firebase_link(parent, google_analytics_admin_v1beta_firebase_link_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

Parameters:

  • parent (String) —

    Required. Format: properties/property_id Example: properties/1234

  • google_analytics_admin_v1beta_firebase_link_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1608

def create_property_firebase_link(parent, google_analytics_admin_v1beta_firebase_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/firebaseLinks', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink::Representation
  command.request_object = google_analytics_admin_v1beta_firebase_link_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_property_google_ads_link(parent, google_analytics_admin_v1beta_google_ads_link_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink

Creates a GoogleAdsLink.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • google_analytics_admin_v1beta_google_ads_link_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1715

def create_property_google_ads_link(parent, google_analytics_admin_v1beta_google_ads_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/googleAdsLinks', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
  command.request_object = google_analytics_admin_v1beta_google_ads_link_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_account(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

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, UserLinks) will be permanently purged. https:// support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

Parameters:

  • name (String) —

    Required. The name of the Account to soft-delete. Format: accounts/account Example: "accounts/100"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



123
124
125
126
127
128
129
130
131
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 123

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_property(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty

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, UserLinks) will be permanently purged. https://support.google.com/ analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.

Parameters:

  • name (String) —

    Required. The name of the Property to soft-delete. Format: properties/ property_id Example: "properties/1000"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



483
484
485
486
487
488
489
490
491
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 483

def delete_property(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_property_conversion_event(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Deletes a conversion event in a property.

Parameters:

  • name (String) —

    Required. The resource name of the conversion event to delete. Format: properties/property/conversionEvents/conversion_event Example: "properties/ 123/conversionEvents/456"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



794
795
796
797
798
799
800
801
802
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 794

def delete_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_property_data_stream(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Deletes a DataStream on a property.

Parameters:

  • name (String) —

    Required. The name of the DataStream to delete. Example format: properties/ 1234/dataStreams/5678

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1288
1289
1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1288

def delete_property_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Deletes target MeasurementProtocolSecret.

Parameters:

  • name (String) —

    Required. The name of the MeasurementProtocolSecret to delete. Format: properties/property/dataStreams/dataStream/measurementProtocolSecrets/ measurementProtocolSecret

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1465
1466
1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1465

def delete_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_property_firebase_link(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Deletes a FirebaseLink on a property

Parameters:

  • name (String) —

    Required. Format: properties/property_id/firebaseLinks/firebase_link_id Example: properties/1234/firebaseLinks/5678

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1641
1642
1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1641

def delete_property_firebase_link(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_property_google_ads_link(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty

Deletes a GoogleAdsLink on a property

Parameters:

  • name (String) —

    Required. Example format: properties/1234/googleAdsLinks/5678

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1747

def delete_property_google_ads_link(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount

Lookup for a single Account.

Parameters:

  • name (String) —

    Required. The name of the account to lookup. Format: accounts/account Example: "accounts/100"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



154
155
156
157
158
159
160
161
162
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 154

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_data_sharing_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings

Get data sharing settings on an account. Data sharing settings are singletons.

Parameters:

  • name (String) —

    Required. The name of the settings to lookup. Format: accounts/account/ dataSharingSettings Example: "accounts/1000/dataSharingSettings"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



185
186
187
188
189
190
191
192
193
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 185

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty

Lookup for a single "GA4" Property.

Parameters:

  • name (String) —

    Required. The name of the property to lookup. Format: properties/property_id Example: "properties/1000"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



514
515
516
517
518
519
520
521
522
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 514

def get_property(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_conversion_event(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent

Retrieve a single conversion event.

Parameters:

  • name (String) —

    Required. The resource name of the conversion event to retrieve. Format: properties/property/conversionEvents/conversion_event Example: "properties/ 123/conversionEvents/456"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



826
827
828
829
830
831
832
833
834
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 826

def get_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_custom_dimension(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension

Lookup for a single CustomDimension.

Parameters:

  • name (String) —

    Required. The name of the CustomDimension to get. Example format: properties/ 1234/customDimensions/5678

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



966
967
968
969
970
971
972
973
974
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 966

def get_property_custom_dimension(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_custom_metric(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric

Lookup for a single CustomMetric.

Parameters:

  • name (String) —

    Required. The name of the CustomMetric to get. Example format: properties/1234/ customMetrics/5678

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1144

def get_property_custom_metric(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_data_retention_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings

Returns the singleton data retention settings for this property.

Parameters:

  • name (String) —

    Required. The name of the settings to lookup. Format: properties/property/ dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



545
546
547
548
549
550
551
552
553
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 545

def get_property_data_retention_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_data_stream(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream

Lookup for a single DataStream.

Parameters:

  • name (String) —

    Required. The name of the DataStream to get. Example format: properties/1234/ dataStreams/5678

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1319
1320
1321
1322
1323
1324
1325
1326
1327
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1319

def get_property_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameters:

  • name (String) —

    Required. The name of the measurement protocol secret to lookup. Format: properties/property/dataStreams/dataStream/measurementProtocolSecrets/ measurementProtocolSecret

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1497
1498
1499
1500
1501
1502
1503
1504
1505
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1497

def get_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_summaries(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse

Returns summaries of all accounts accessible by the caller.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    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)

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 85

def (page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/accountSummaries', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_accounts(page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    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)

  • page_token (String) (defaults to: nil) —

    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.

  • show_deleted (Boolean) (defaults to: nil) —

    Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 227

def list_accounts(page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/accounts', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse

Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. 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.

Parameters:

  • filter (String) (defaults to: nil) —

    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. |

  • page_size (Fixnum) (defaults to: nil) —

    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)

  • page_token (String) (defaults to: nil) —

    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.

  • show_deleted (Boolean) (defaults to: nil) —

    Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 599

def list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/properties', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_conversion_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse

Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

Parameters:

  • parent (String) —

    Required. The resource name of the parent property. Example: 'properties/123'

  • page_size (Fixnum) (defaults to: nil) —

    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)

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 866

def list_property_conversion_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/conversionEvents', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_custom_dimensions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse

Lists CustomDimensions on a property.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • page_size (Fixnum) (defaults to: nil) —

    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).

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1005

def list_property_custom_dimensions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/customDimensions', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_custom_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse

Lists CustomMetrics on a property.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • page_size (Fixnum) (defaults to: nil) —

    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).

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1183

def list_property_custom_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/customMetrics', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameters:

  • parent (String) —

    Required. The resource name of the parent stream. Format: properties/property /dataStreams/dataStream/measurementProtocolSecrets

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1537

def list_property_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/measurementProtocolSecrets', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse

Lists DataStreams on a property.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • page_size (Fixnum) (defaults to: nil) —

    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).

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1357

def list_property_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/dataStreams', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_firebase_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Parameters:

  • parent (String) —

    Required. Format: properties/property_id Example: properties/1234

  • page_size (Fixnum) (defaults to: nil) —

    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)

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1682

def list_property_firebase_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/firebaseLinks', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_property_google_ads_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse

Lists GoogleAdsLinks on a property.

Parameters:

  • parent (String) —

    Required. Example format: properties/1234

  • page_size (Fixnum) (defaults to: nil) —

    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).

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1786

def list_property_google_ads_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/googleAdsLinks', options)
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_account(name, google_analytics_admin_v1beta_account_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount

Updates an account.

Parameters:

  • name (String) —

    Output only. Resource name of this account. Format: accounts/account Example: "accounts/100"

  • google_analytics_admin_v1beta_account_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 266

def (name,  = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_property(name, google_analytics_admin_v1beta_property_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty

Updates a property.

Parameters:

  • name (String) —

    Output only. Resource name of this property. Format: properties/property_id Example: "properties/1000"

  • google_analytics_admin_v1beta_property_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 638

def patch_property(name, google_analytics_admin_v1beta_property_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
  command.request_object = google_analytics_admin_v1beta_property_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_property_custom_dimension(name, google_analytics_admin_v1beta_custom_dimension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension

Updates a CustomDimension on a property.

Parameters:

  • name (String) —

    Output only. Resource name for this CustomDimension resource. Format: properties/property/customDimensions/customDimension

  • google_analytics_admin_v1beta_custom_dimension_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1043

def patch_property_custom_dimension(name, google_analytics_admin_v1beta_custom_dimension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
  command.request_object = google_analytics_admin_v1beta_custom_dimension_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_property_custom_metric(name, google_analytics_admin_v1beta_custom_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric

Updates a CustomMetric on a property.

Parameters:

  • name (String) —

    Output only. Resource name for this CustomMetric resource. Format: properties/ property/customMetrics/customMetric

  • google_analytics_admin_v1beta_custom_metric_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1221

def patch_property_custom_metric(name, google_analytics_admin_v1beta_custom_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
  command.request_object = google_analytics_admin_v1beta_custom_metric_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_property_data_stream(name, google_analytics_admin_v1beta_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream

Updates a DataStream on a property.

Parameters:

  • name (String) —

    Output only. Resource name of this Data Stream. Format: properties/ property_id/dataStreams/stream_id Example: "properties/1000/dataStreams/ 2000"

  • google_analytics_admin_v1beta_data_stream_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1396

def patch_property_data_stream(name, google_analytics_admin_v1beta_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
  command.request_object = google_analytics_admin_v1beta_data_stream_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_property_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1beta_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret

Updates a measurement protocol secret.

Parameters:

  • name (String) —

    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

  • google_analytics_admin_v1beta_measurement_protocol_secret_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated. Omitted fields will not be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1574

def patch_property_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1beta_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
  command.request_object = google_analytics_admin_v1beta_measurement_protocol_secret_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_property_google_ads_link(name, google_analytics_admin_v1beta_google_ads_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink

Updates a GoogleAdsLink on a property

Parameters:

  • name (String) —

    Output only. Format: properties/propertyId/googleAdsLinks/googleAdsLinkId Note: googleAdsLinkId is not the Google Ads customer ID.

  • google_analytics_admin_v1beta_google_ads_link_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 1824

def patch_property_google_ads_link(name, google_analytics_admin_v1beta_google_ads_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
  command.request_object = google_analytics_admin_v1beta_google_ads_link_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#provision_account_account_ticket(google_analytics_admin_v1beta_provision_account_ticket_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse

Requests a ticket for creating an account.

Parameters:

  • google_analytics_admin_v1beta_provision_account_ticket_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



298
299
300
301
302
303
304
305
306
307
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 298

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/accounts:provisionAccountTicket', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_account_access_report(entity, google_analytics_admin_v1beta_run_access_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse

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. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 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.

Parameters:

  • entity (String) —

    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 GA4 property ID. To request at the account level, entity should be for example 'accounts/ 1234' if "1234" is your GA4 Account ID.

  • google_analytics_admin_v1beta_run_access_report_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 345

def (entity, google_analytics_admin_v1beta_run_access_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+entity}:runAccessReport', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest::Representation
  command.request_object = google_analytics_admin_v1beta_run_access_report_request_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse
  command.params['entity'] = entity unless entity.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_property_access_report(entity, google_analytics_admin_v1beta_run_access_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse

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. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 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.

Parameters:

  • entity (String) —

    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 GA4 property ID. To request at the account level, entity should be for example 'accounts/ 1234' if "1234" is your GA4 Account ID.

  • google_analytics_admin_v1beta_run_access_report_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 687

def run_property_access_report(entity, google_analytics_admin_v1beta_run_access_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+entity}:runAccessReport', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest::Representation
  command.request_object = google_analytics_admin_v1beta_run_access_report_request_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportResponse
  command.params['entity'] = entity unless entity.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_account_change_history_events(account, google_analytics_admin_v1beta_search_change_history_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse

Searches through all changes to an account or its children given the specified set of filters.

Parameters:

  • account (String) —

    Required. The account resource for which to return change history resources.

  • google_analytics_admin_v1beta_search_change_history_events_request_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 379

def (, google_analytics_admin_v1beta_search_change_history_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+account}:searchChangeHistoryEvents', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest::Representation
  command.request_object = google_analytics_admin_v1beta_search_change_history_events_request_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse
  command.params['account'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_property_data_retention_settings(name, google_analytics_admin_v1beta_data_retention_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings

Updates the singleton data retention settings for this property.

Parameters:

  • name (String) —

    Output only. Resource name for this DataRetentionSetting resource. Format: properties/property/dataRetentionSettings

  • google_analytics_admin_v1beta_data_retention_settings_object (Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/google/apis/analyticsadmin_v1beta/service.rb', line 725

def update_property_data_retention_settings(name, google_analytics_admin_v1beta_data_retention_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings::Representation
  command.request_object = google_analytics_admin_v1beta_data_retention_settings_object
  command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings::Representation
  command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end