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

#initialize ⇒ FitnessService

Returns a new instance of FitnessService



51
52
53
54
 
# File 'generated/google/apis/fitness_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'fitness/v1/users/')
  @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 'generated/google/apis/fitness_v1/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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



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

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'generated/google/apis/fitness_v1/service.rb', line 513

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'generated/google/apis/fitness_v1/service.rb', line 89

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



130
131
132
133
134
135
136
137
138
139
140
 
# File 'generated/google/apis/fitness_v1/service.rb', line 130

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



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

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



555
556
557
558
559
560
561
562
563
564
 
# File 'generated/google/apis/fitness_v1/service.rb', line 555

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



169
170
171
172
173
174
175
176
177
178
179
 
# File 'generated/google/apis/fitness_v1/service.rb', line 169

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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_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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/fitness_v1/service.rb', line 211

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

  • 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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'generated/google/apis/fitness_v1/service.rb', line 300

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

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'generated/google/apis/fitness_v1/service.rb', line 650

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