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

Returns a new instance of FitnessService


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

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 'generated/google/apis/fitness_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


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

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


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 aggreated into exactly one bucket type per request.

Parameters:

  • user_id (String)

    Aggregate data for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • aggregate_request_object (Google::Apis::FitnessV1::AggregateRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


537
538
539
540
541
542
543
544
545
546
547
548
# File 'generated/google/apis/fitness_v1/service.rb', line 537

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

Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into 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.

Parameters:

  • user_id (String)

    Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_object (Google::Apis::FitnessV1::DataSource) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


85
86
87
88
89
90
91
92
93
94
95
96
# File 'generated/google/apis/fitness_v1/service.rb', line 85

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.

Parameters:

  • user_id (String)

    Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


124
125
126
127
128
129
130
131
132
133
134
# File 'generated/google/apis/fitness_v1/service.rb', line 124

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.

Parameters:

  • user_id (String)

    Delete a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source that created the dataset.

  • dataset_id (String)

    Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.

  • current_time_millis (Fixnum)

    The client's current time in milliseconds since epoch.

  • modified_time_millis (Fixnum)

    When the operation was performed on the client.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

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:


385
386
387
388
389
390
391
392
393
394
395
396
# File 'generated/google/apis/fitness_v1/service.rb', line 385

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.

Parameters:

  • user_id (String)

    Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • session_id (String)

    The ID of the session to be deleted.

  • current_time_millis (Fixnum)

    The client's current time in milliseconds since epoch.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

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:


577
578
579
580
581
582
583
584
585
586
# File 'generated/google/apis/fitness_v1/service.rb', line 577

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.

Parameters:

  • user_id (String)

    Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source to retrieve.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


161
162
163
164
165
166
167
168
169
170
171
# File 'generated/google/apis/fitness_v1/service.rb', line 161

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.

Parameters:

  • user_id (String)

    Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source that created the dataset.

  • dataset_id (String)

    Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.

  • limit (Fixnum)

    If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response.

  • page_token (String)

    The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of nextPageToken from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'generated/google/apis/fitness_v1/service.rb', line 442

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.

Parameters:

  • user_id (String)

    List data points for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source that created the dataset.

  • limit (Fixnum)

    If specified, no more than this many data point changes will be included in the response.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'generated/google/apis/fitness_v1/service.rb', line 332

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.

Parameters:

  • user_id (String)

    List data sources for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_type_name (Array<String>, String)

    The names of data types to include in the list. If not specified, all data sources will be returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


201
202
203
204
205
206
207
208
209
210
211
# File 'generated/google/apis/fitness_v1/service.rb', line 201

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

Parameters:

  • user_id (String)

    List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • end_time (String)

    An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.

  • include_deleted (Boolean)

    If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields.

  • page_token (String)

    The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. This token is treated as a timestamp (in millis since epoch) . If specified, the API returns sessions modified since this time. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 7 days are returned.

  • start_time (String)

    An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'generated/google/apis/fitness_v1/service.rb', line 629

def list_user_sessions(user_id, 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['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(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. This method supports patch semantics.

Parameters:

  • user_id (String)

    Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source to update.

  • data_source_object (Google::Apis::FitnessV1::DataSource) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'generated/google/apis/fitness_v1/service.rb', line 243

def patch_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(:patch, '{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

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

Parameters:

  • user_id (String)

    Patch a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source that created the dataset.

  • dataset_id (String)

    Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.

  • dataset_object (Google::Apis::FitnessV1::Dataset) (defaults to: nil)
  • current_time_millis (Fixnum)

    The client's current time in milliseconds since epoch. Note that the minStartTimeNs and maxEndTimeNs properties in the request body are in nanoseconds instead of milliseconds.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'generated/google/apis/fitness_v1/service.rb', line 495

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.

Parameters:

  • user_id (String)

    Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • data_source_id (String)

    The data stream ID of the data source to update.

  • data_source_object (Google::Apis::FitnessV1::DataSource) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'generated/google/apis/fitness_v1/service.rb', line 286

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.

Parameters:

  • user_id (String)

    Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

  • session_id (String)

    The ID of the session to be created.

  • session_object (Google::Apis::FitnessV1::Session) (defaults to: nil)
  • current_time_millis (Fixnum)

    The client's current time in milliseconds since epoch.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'generated/google/apis/fitness_v1/service.rb', line 672

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