Class: Google::Apis::PlaydeveloperreportingV1beta1::PlaydeveloperreportingService

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

Overview

Google Play Developer Reporting API

Examples:

require 'google/apis/playdeveloperreporting_v1beta1'

Playdeveloperreporting = Google::Apis::PlaydeveloperreportingV1beta1 # Alias the module
service = Playdeveloperreporting::PlaydeveloperreportingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PlaydeveloperreportingService

Returns a new instance of PlaydeveloperreportingService.



45
46
47
48
49
50
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 45

def initialize
  super('https://playdeveloperreporting.googleapis.com/', '',
        client_name: 'google-apis-playdeveloperreporting_v1beta1',
        client_version: Google::Apis::PlaydeveloperreportingV1beta1::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.



38
39
40
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 38

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.



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

def quota_user
  @quota_user
end

Instance Method Details

#get_vital_anrrate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1AnrRateMetricSet

Describes the properties of the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/anrRateMetricSet

  • 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



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

def get_vital_anrrate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1AnrRateMetricSet::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1AnrRateMetricSet
  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_vital_crashrate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1CrashRateMetricSet

Describes the properties of the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/crashRateMetricSet

  • 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



187
188
189
190
191
192
193
194
195
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 187

def get_vital_crashrate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1CrashRateMetricSet::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1CrashRateMetricSet
  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_vital_excessivewakeuprate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1ExcessiveWakeupRateMetricSet

Describes the properties of the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/excessiveWakeupRateMetricSet

  • 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



250
251
252
253
254
255
256
257
258
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 250

def get_vital_excessivewakeuprate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1ExcessiveWakeupRateMetricSet::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1ExcessiveWakeupRateMetricSet
  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_vital_stuckbackgroundwakelockrate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1StuckBackgroundWakelockRateMetricSet

Describes the properties of the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/ stuckBackgroundWakelockRateMetricSet

  • 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



314
315
316
317
318
319
320
321
322
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 314

def get_vital_stuckbackgroundwakelockrate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1StuckBackgroundWakelockRateMetricSet::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1StuckBackgroundWakelockRateMetricSet
  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_anomalies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1ListAnomaliesResponse

Lists anomalies in any of the datasets.

Parameters:

  • parent (String) —

    Required. Parent app for which anomalies were detected. Format: apps/app

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

    Filtering criteria for anomalies. For basic filter guidance, please check: https://google.aip.dev/160. Supported functions: * activeBetween( startTime, endTime): If specified, only list anomalies that were active in between startTime (inclusive) and endTime (exclusive). Both parameters are expected to conform to an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00- 04:00). UTC offsets are supported. Both startTime and endTime accept the special value UNBOUNDED, to signify intervals with no lower or upper bound, respectively. Examples: * activeBetween("2021-04-21T11:30:00Z", "2021-07- 21T00:00:00Z") * activeBetween(UNBOUNDED, "2021-11-21T00:00:00-04:00") * activeBetween("2021-07-21T00:00:00-04:00", UNBOUNDED)

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

    Maximum size of the returned data. If unspecified, at most 10 anomalies will be returned. The maximum value is 100; values above 100 will be coerced to 100.

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

    A page token, received from a previous ListErrorReports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListErrorReports 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



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 91

def list_anomalies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/anomalies', options)
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1ListAnomaliesResponse::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1ListAnomaliesResponse
  command.params['parent'] = parent unless parent.nil?
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_vital_anrrate(name, google_play_developer_reporting_v1beta1_query_anr_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryAnrRateMetricSetResponse

Queries the metrics in the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/anrRateMetricSet

  • google_play_developer_reporting_v1beta1_query_anr_rate_metric_set_request_object (Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryAnrRateMetricSetRequest) (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



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 155

def query_vital_anrrate(name, google_play_developer_reporting_v1beta1_query_anr_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:query', options)
  command.request_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryAnrRateMetricSetRequest::Representation
  command.request_object = google_play_developer_reporting_v1beta1_query_anr_rate_metric_set_request_object
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryAnrRateMetricSetResponse::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryAnrRateMetricSetResponse
  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

#query_vital_crashrate(name, google_play_developer_reporting_v1beta1_query_crash_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryCrashRateMetricSetResponse

Queries the metrics in the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/crashRateMetricSet

  • google_play_developer_reporting_v1beta1_query_crash_rate_metric_set_request_object (Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryCrashRateMetricSetRequest) (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



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 218

def query_vital_crashrate(name, google_play_developer_reporting_v1beta1_query_crash_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:query', options)
  command.request_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryCrashRateMetricSetRequest::Representation
  command.request_object = google_play_developer_reporting_v1beta1_query_crash_rate_metric_set_request_object
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryCrashRateMetricSetResponse::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryCrashRateMetricSetResponse
  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

#query_vital_excessivewakeuprate(name, google_play_developer_reporting_v1beta1_query_excessive_wakeup_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetResponse

Queries the metrics in the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/excessiveWakeupRateMetricSet

  • google_play_developer_reporting_v1beta1_query_excessive_wakeup_rate_metric_set_request_object (Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetRequest) (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



281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/apis/playdeveloperreporting_v1beta1/service.rb', line 281

def query_vital_excessivewakeuprate(name, google_play_developer_reporting_v1beta1_query_excessive_wakeup_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:query', options)
  command.request_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetRequest::Representation
  command.request_object = google_play_developer_reporting_v1beta1_query_excessive_wakeup_rate_metric_set_request_object
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetResponse::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetResponse
  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

#query_vital_stuckbackgroundwakelockrate(name, google_play_developer_reporting_v1beta1_query_stuck_background_wakelock_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryStuckBackgroundWakelockRateMetricSetResponse

Queries the metrics in the metric set.

Parameters:

  • name (String) —

    Required. The resource name. Format: apps/app/ stuckBackgroundWakelockRateMetricSet

  • google_play_developer_reporting_v1beta1_query_stuck_background_wakelock_rate_metric_set_request_object (Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryStuckBackgroundWakelockRateMetricSetRequest) (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



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

def query_vital_stuckbackgroundwakelockrate(name, google_play_developer_reporting_v1beta1_query_stuck_background_wakelock_rate_metric_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:query', options)
  command.request_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryStuckBackgroundWakelockRateMetricSetRequest::Representation
  command.request_object = google_play_developer_reporting_v1beta1_query_stuck_background_wakelock_rate_metric_set_request_object
  command.response_representation = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryStuckBackgroundWakelockRateMetricSetResponse::Representation
  command.response_class = Google::Apis::PlaydeveloperreportingV1beta1::GooglePlayDeveloperReportingV1beta1QueryStuckBackgroundWakelockRateMetricSetResponse
  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