Class: Google::Apis::FitnessV1::FitnessService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/fitness_v1/service.rb

Overview

Fitness

Stores and accesses user data in the fitness store from apps on any platform.

Examples:

require 'google/apis/fitness_v1'

Fitness = Google::Apis::FitnessV1 # Alias the module
service = Fitness::FitnessService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeFitnessService


49
50
51
52
# File 'generated/google/apis/fitness_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'fitness/v1/users/')
  @batch_path = 'batch/fitness/v1'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/fitness_v1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/fitness_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString


47
48
49
# File 'generated/google/apis/fitness_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#aggregate_dataset(user_id, aggregate_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::AggregateResponse

Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggregated into exactly one bucket type per request.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


508
509
510
511
512
513
514
515
516
517
518
519
# File 'generated/google/apis/fitness_v1/service.rb', line 508

def aggregate_dataset(user_id, aggregate_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{userId}/dataset:aggregate', options)
  command.request_representation = Google::Apis::FitnessV1::AggregateRequest::Representation
  command.request_object = aggregate_request_object
  command.response_representation = Google::Apis::FitnessV1::AggregateResponse::Representation
  command.response_class = Google::Apis::FitnessV1::AggregateResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_user_data_source(user_id, data_source_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::DataSource

A data source is a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point in every dataset inserted into or read from the Fitness API has an associated data source. Each data source produces a unique stream of dataset updates, with a unique data source identifier. Not all changes to data source affect the data stream ID, so that data collected by updated versions of the same application/device can still be considered to belong to the same data source. Data sources are addressed using a string generated by the server, based on the contents of the source being created. Creates a new data source that is unique across all data sources belonging to this user. The dataStreamId field should be excluded. This will be automatically generated by the server with the correct format. If a dataStreamId is included, it must match the format that the server would generate. This format is a combination of some fields from the data source, and has a specific order. If it doesn't match, the request will fail with an error. In addition to the data source fields included in the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


100
101
102
103
104
105
106
107
108
109
110
111
# File 'generated/google/apis/fitness_v1/service.rb', line 100

def create_user_data_source(user_id, data_source_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{userId}/dataSources', options)
  command.request_representation = Google::Apis::FitnessV1::DataSource::Representation
  command.request_object = data_source_object
  command.response_representation = Google::Apis::FitnessV1::DataSource::Representation
  command.response_class = Google::Apis::FitnessV1::DataSource
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::DataSource

Deletes the specified data source. The request will fail if the data source contains any data points.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


139
140
141
142
143
144
145
146
147
148
149
# File 'generated/google/apis/fitness_v1/service.rb', line 139

def delete_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{userId}/dataSources/{dataSourceId}', options)
  command.response_representation = Google::Apis::FitnessV1::DataSource::Representation
  command.response_class = Google::Apis::FitnessV1::DataSource
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_data_source_dataset(user_id, data_source_id, dataset_id, current_time_millis: nil, modified_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID. For most data types, the entire data point will be deleted. For data types where the time span represents a consistent value (such as com.google.activity.segment), and a data point straddles either end point of the dataset, only the overlapping portion of the data point will be deleted.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


356
357
358
359
360
361
362
363
364
365
366
367
# File 'generated/google/apis/fitness_v1/service.rb', line 356

def delete_user_data_source_dataset(user_id, data_source_id, dataset_id, current_time_millis: nil, modified_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil?
  command.query['modifiedTimeMillis'] = modified_time_millis unless modified_time_millis.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_session(user_id, session_id, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a session specified by the given session ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


548
549
550
551
552
553
554
555
556
557
# File 'generated/google/apis/fitness_v1/service.rb', line 548

def delete_user_session(user_id, session_id, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{userId}/sessions/{sessionId}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sessionId'] = session_id unless session_id.nil?
  command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::DataSource

Returns the specified data source.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


176
177
178
179
180
181
182
183
184
185
186
# File 'generated/google/apis/fitness_v1/service.rb', line 176

def get_user_data_source(user_id, data_source_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{userId}/dataSources/{dataSourceId}', options)
  command.response_representation = Google::Apis::FitnessV1::DataSource::Representation
  command.response_class = Google::Apis::FitnessV1::DataSource
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_data_source_dataset(user_id, data_source_id, dataset_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::Dataset

Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time. Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'generated/google/apis/fitness_v1/service.rb', line 413

def get_user_data_source_dataset(user_id, data_source_id, dataset_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options)
  command.response_representation = Google::Apis::FitnessV1::Dataset::Representation
  command.response_class = Google::Apis::FitnessV1::Dataset
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['limit'] = limit unless limit.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_data_source_data_point_changes(user_id, data_source_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::ListDataPointChangesResponse

Queries for user's data point changes for a particular data source.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'generated/google/apis/fitness_v1/service.rb', line 303

def list_user_data_source_data_point_changes(user_id, data_source_id, limit: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{userId}/dataSources/{dataSourceId}/dataPointChanges', options)
  command.response_representation = Google::Apis::FitnessV1::ListDataPointChangesResponse::Representation
  command.response_class = Google::Apis::FitnessV1::ListDataPointChangesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.query['limit'] = limit unless limit.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_data_sources(user_id, data_type_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::ListDataSourcesResponse

Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


216
217
218
219
220
221
222
223
224
225
226
# File 'generated/google/apis/fitness_v1/service.rb', line 216

def list_user_data_sources(user_id, data_type_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{userId}/dataSources', options)
  command.response_representation = Google::Apis::FitnessV1::ListDataSourcesResponse::Representation
  command.response_class = Google::Apis::FitnessV1::ListDataSourcesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['dataTypeName'] = data_type_name unless data_type_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_user_sessions(user_id, activity_type: nil, end_time: nil, include_deleted: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::ListSessionsResponse

Lists sessions previously created.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'generated/google/apis/fitness_v1/service.rb', line 602

def list_user_sessions(user_id, activity_type: nil, end_time: nil, include_deleted: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{userId}/sessions', options)
  command.response_representation = Google::Apis::FitnessV1::ListSessionsResponse::Representation
  command.response_class = Google::Apis::FitnessV1::ListSessionsResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['activityType'] = activity_type unless activity_type.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startTime'] = start_time unless start_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_data_source_dataset(user_id, data_source_id, dataset_id, dataset_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::Dataset

Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'generated/google/apis/fitness_v1/service.rb', line 466

def patch_user_data_source_dataset(user_id, data_source_id, dataset_id, dataset_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{userId}/dataSources/{dataSourceId}/datasets/{datasetId}', options)
  command.request_representation = Google::Apis::FitnessV1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::FitnessV1::Dataset::Representation
  command.response_class = Google::Apis::FitnessV1::Dataset
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_user_data_source(user_id, data_source_id, data_source_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::DataSource

Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified. Data sources are identified by their dataStreamId.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'generated/google/apis/fitness_v1/service.rb', line 257

def update_user_data_source(user_id, data_source_id, data_source_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, '{userId}/dataSources/{dataSourceId}', options)
  command.request_representation = Google::Apis::FitnessV1::DataSource::Representation
  command.request_object = data_source_object
  command.response_representation = Google::Apis::FitnessV1::DataSource::Representation
  command.response_class = Google::Apis::FitnessV1::DataSource
  command.params['userId'] = user_id unless user_id.nil?
  command.params['dataSourceId'] = data_source_id unless data_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_user_session(user_id, session_id, session_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FitnessV1::Session

Updates or insert a given session.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


646
647
648
649
650
651
652
653
654
655
656
657
658
659
# File 'generated/google/apis/fitness_v1/service.rb', line 646

def update_user_session(user_id, session_id, session_object = nil, current_time_millis: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, '{userId}/sessions/{sessionId}', options)
  command.request_representation = Google::Apis::FitnessV1::Session::Representation
  command.request_object = session_object
  command.response_representation = Google::Apis::FitnessV1::Session::Representation
  command.response_class = Google::Apis::FitnessV1::Session
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sessionId'] = session_id unless session_id.nil?
  command.query['currentTimeMillis'] = current_time_millis unless current_time_millis.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end