Show / Hide Table of Contents

Class UsersResource.DataTypesResource.DataPointsResource

The "dataPoints" collection of methods.

Inheritance
object
UsersResource.DataTypesResource.DataPointsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.GoogleHealthAPI.v4
Assembly: Google.Apis.GoogleHealthAPI.v4.dll
Syntax
public class UsersResource.DataTypesResource.DataPointsResource

Constructors

DataPointsResource(IClientService)

Constructs a new resource.

Declaration
public DataPointsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

BatchDelete(BatchDeleteDataPointsRequest, string)

Delete a batch of identifyable data points.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.BatchDeleteRequest BatchDelete(BatchDeleteDataPointsRequest body, string parent)
Parameters
Type Name Description
BatchDeleteDataPointsRequest body

The body of the request.

string parent

Optional. Parent (data type) for the Data Point collection Format: users/me/dataTypes/{data_type}, e.g.: - users/me/dataTypes/steps - users/me/dataTypes/- For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in names must match this field.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.BatchDeleteRequest

Create(DataPoint, string)

Creates a single identifiable data point.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.CreateRequest Create(DataPoint body, string parent)
Parameters
Type Name Description
DataPoint body

The body of the request.

string parent

Required. The parent resource name where the data point will be created. Format: users/{user}/dataTypes/{data_type}

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.CreateRequest

DailyRollUp(DailyRollUpDataPointsRequest, string)

Roll up data points over civil time intervals for supported data types.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.DailyRollUpRequest DailyRollUp(DailyRollUpDataPointsRequest body, string parent)
Parameters
Type Name Description
DailyRollUpDataPointsRequest body

The body of the request.

string parent

Required. Parent data type of the Data Point collection. Format: users/{user}/dataTypes/{data_type}, e.g.: - users/me/dataTypes/steps - users/me/dataTypes/distance For a list of the supported data types see the DailyRollupDataPoint value union field.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.DailyRollUpRequest

ExportExerciseTcx(string)

Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the activity_and_fitness scopes (normal or readonly) AND one of the location scopes (normal or readonly) in their access token to succeed.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.ExportExerciseTcxRequest ExportExerciseTcx(string name)
Parameters
Type Name Description
string name

Required. The resource name of the exercise data point to export. Format: users/{user}/dataTypes/exercise/dataPoints/{data_point} Example: users/me/dataTypes/exercise/dataPoints/2026443605080188808 The {user} is the alias "me" currently. Future versions may support user IDs. The {data_point} ID maps to the exercise ID, which is a long integer.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.ExportExerciseTcxRequest

Get(string)

Get a single identifyable data point.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the data point to retrieve. Format: users/{user}/dataTypes/{data_type}/dataPoints/{data_point} See DataPoint.name for examples and possible values.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.GetRequest

List(string)

Query user health and fitness data points.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Parent data type of the Data Point collection. Format: users/me/dataTypes/{data_type}, e.g.: - users/me/dataTypes/steps - users/me/dataTypes/weight For a list of the supported data types see the DataPoint data union field.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.ListRequest

Patch(DataPoint, string)

Updates a single identifiable data point. If a data point with the specified name is not found, the request will fail.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.PatchRequest Patch(DataPoint body, string name)
Parameters
Type Name Description
DataPoint body

The body of the request.

string name

Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: users/{user}/dataTypes/{data_type}/dataPoints/{data_point} Example: users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef The {user} ID is a system-generated identifier, as described in Identity.health_user_id. The {data_type} ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. total-calories for the total_calories field. The {data_point} ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.PatchRequest

Reconcile(string)

Reconcile data points from multiple data sources into a single data stream.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.ReconcileRequest Reconcile(string parent)
Parameters
Type Name Description
string parent

Required. Parent data type of the Data Point collection. Format: users/me/dataTypes/{data_type}, e.g.: - users/me/dataTypes/steps - users/me/dataTypes/heart-rate For a list of the supported data types see the DataPoint data union field.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.ReconcileRequest

RollUp(RollUpDataPointsRequest, string)

Roll up data points over physical time intervals for supported data types.

Declaration
public virtual UsersResource.DataTypesResource.DataPointsResource.RollUpRequest RollUp(RollUpDataPointsRequest body, string parent)
Parameters
Type Name Description
RollUpDataPointsRequest body

The body of the request.

string parent

Required. Parent data type of the Data Point collection. Format: users/{user}/dataTypes/{data_type}, e.g.: - users/me/dataTypes/steps - users/me/dataTypes/distance For a list of the supported data types see the RollupDataPoint value union field.

Returns
Type Description
UsersResource.DataTypesResource.DataPointsResource.RollUpRequest
In this article
Back to top Generated by DocFX