GoogleApi.Fitness.V1.Api.Users (google_api_fitness v0.23.1) View Source
API calls for all endpoints tagged Users
.
Link to this section Summary
Functions
Creates a new data source that is unique across all data sources belonging to this user. 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 identified using a string generated by the server, based on the contents of the source being created. The dataStreamId field should not be set when invoking this method. It will be automatically generated by the server with the correct format. If a dataStreamId is set, 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. Specifying a DataType which is not a known type (beginning with "com.google.") will create a DataSource with a custom data type. Custom data types are only readable by the application that created them. Custom data types are deprecated; use standard data types instead. 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.
Queries for user's data point changes for a particular data source.
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.
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.
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.
Deletes the specified data source. The request will fail if the data source contains any data points.
Returns the specified data source.
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.
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.
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.
Deletes a session specified by the given session ID.
Lists sessions previously created.
Updates or insert a given session.
Link to this section Functions
fitness_users_data_sources_create(connection, user_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a new data source that is unique across all data sources belonging to this user. 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 identified using a string generated by the server, based on the contents of the source being created. The dataStreamId field should not be set when invoking this method. It will be automatically generated by the server with the correct format. If a dataStreamId is set, 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. Specifying a DataType which is not a known type (beginning with "com.google.") will create a DataSource with a custom data type. Custom data types are only readable by the application that created them. Custom data types are deprecated; use standard data types instead. 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.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Fitness.V1.Model.DataSource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_data_point_changes_list(connection, user_id, data_source_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_data_point_changes_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.ListDataPointChangesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Queries for user's data point changes for a particular data source.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - List data points for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
data_source_id
(type:String.t
) - The data stream ID of the data source that created the dataset. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:limit
(type:integer()
) - If specified, no more than this many data point changes will be included in the response. -
:pageToken
(type:String.t
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.ListDataPointChangesResponse{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_datasets_delete(connection, user_id, data_source_id, dataset_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_datasets_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
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
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Delete a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
data_source_id
(type:String.t
) - The data stream ID of the data source that created the dataset. -
dataset_id
(type:String.t
) - 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. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:currentTimeMillis
(type:String.t
) - The client's current time in milliseconds since epoch. -
:modifiedTimeMillis
(type:String.t
) - When the operation was performed on the client.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_datasets_get(connection, user_id, data_source_id, dataset_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_datasets_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.Dataset.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
data_source_id
(type:String.t
) - The data stream ID of the data source that created the dataset. -
dataset_id
(type:String.t
) - 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. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:limit
(type:integer()
) - 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. The limit is applied from the end of the time range. That is, if pageToken is absent, the limit most recent data points will be returned. -
:pageToken
(type:String.t
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.Dataset{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_datasets_patch(connection, user_id, data_source_id, dataset_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_datasets_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.Dataset.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Patch a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
data_source_id
(type:String.t
) - The data stream ID of the data source that created the dataset. -
dataset_id
(type:String.t
) - 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. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:currentTimeMillis
(type:String.t
) - 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. -
:body
(type:GoogleApi.Fitness.V1.Model.Dataset.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.Dataset{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_delete(connection, user_id, data_source_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes the specified data source. The request will fail if the data source contains any data points.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - 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
(type:String.t
) - The data stream ID of the data source to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_get(connection, user_id, data_source_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns the specified data source.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - 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
(type:String.t
) - The data stream ID of the data source to retrieve. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_list(connection, user_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.ListDataSourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - List data sources for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:dataTypeName
(type:list(String.t)
) - The names of data types to include in the list. If not specified, all data sources will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.ListDataSourcesResponse{}}
on success -
{:error, info}
on failure
fitness_users_data_sources_update(connection, user_id, data_source_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_data_sources_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - 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
(type:String.t
) - The data stream ID of the data source to update. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Fitness.V1.Model.DataSource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}
on success -
{:error, info}
on failure
fitness_users_dataset_aggregate(connection, user_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_dataset_aggregate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.AggregateResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Aggregate data for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Fitness.V1.Model.AggregateRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.AggregateResponse{}}
on success -
{:error, info}
on failure
fitness_users_sessions_delete(connection, user_id, session_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_sessions_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a session specified by the given session ID.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
session_id
(type:String.t
) - The ID of the session to be deleted. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:currentTimeMillis
(type:String.t
) - The client's current time in milliseconds since epoch.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
fitness_users_sessions_list(connection, user_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_sessions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.ListSessionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists sessions previously created.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:activityType
(type:list(integer())
) - If non-empty, only sessions with these activity types should be returned. -
:endTime
(type:String.t
) - An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but startTime is specified, all sessions from startTime to the end of time will be returned. -
:includeDeleted
(type:boolean()
) - If true, and if both startTime and endTime are omitted, session deletions will be returned. -
:pageToken
(type:String.t
) - 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. 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 30 days are returned. -
:startTime
(type:String.t
) - An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but endTime is specified, all sessions from the start of time up to endTime will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.ListSessionsResponse{}}
on success -
{:error, info}
on failure
fitness_users_sessions_update(connection, user_id, session_id, optional_params \\ [], opts \\ [])
View SourceSpecs
fitness_users_sessions_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Fitness.V1.Model.Session.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates or insert a given session.
Parameters
-
connection
(type:GoogleApi.Fitness.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. -
session_id
(type:String.t
) - The ID of the session to be created. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:currentTimeMillis
(type:String.t
) - The client's current time in milliseconds since epoch. -
:body
(type:GoogleApi.Fitness.V1.Model.Session.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Fitness.V1.Model.Session{}}
on success -
{:error, info}
on failure