Class RollUpDataPointsRequest

Request to roll up data points by physical time intervals.

Inheritance

object

RollUpDataPointsRequest

Implements

IMessage<RollUpDataPointsRequest>

IEquatable<RollUpDataPointsRequest>

IDeepCloneable<RollUpDataPointsRequest>

IBufferMessage

IMessage

IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public sealed class RollUpDataPointsRequest : IMessage<RollUpDataPointsRequest>, IEquatable<RollUpDataPointsRequest>, IDeepCloneable<RollUpDataPointsRequest>, IBufferMessage, IMessage, IPageRequest

Constructors

RollUpDataPointsRequest()

Declaration

public RollUpDataPointsRequest()

RollUpDataPointsRequest(RollUpDataPointsRequest)

Declaration

public RollUpDataPointsRequest(RollUpDataPointsRequest other)

Parameters

Type	Name	Description
RollUpDataPointsRequest	other

Properties

DataSourceFamily

Optional. The data source family name to roll up.

If empty, data points from all available data sources will be rolled up.

Format: users/me/dataSourceFamilies/{data_source_family}

The supported values are:

• users/me/dataSourceFamilies/all-sources - Default value. Includes data from all available data sources.
• users/me/dataSourceFamilies/google-wearables - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data.
• users/me/dataSourceFamilies/google-sources - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.
• users/me/dataSourceFamilies/self-sources - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller.

Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to self-sources, and requesting any other data source family fails with PERMISSION_DENIED.

If no data point matches the requested data source family, the response is an empty list rather than an error.

Declaration

public string DataSourceFamily { get; set; }

Property Value

Type	Description
string

PageSize

Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
int

Implements

IPageRequest.PageSize

PageToken

Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.

Declaration

public string PageToken { get; set; }

Property Value

Type	Description
string

Implements

IPageRequest.PageToken

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][google.devicesandservices.health.v4.RollupDataPoint] union field.

Declaration

public string Parent { get; set; }

Property Value

Type	Description
string

ParentAsDataTypeName

DataTypeName-typed view over the Parent resource name property.

Declaration

public DataTypeName ParentAsDataTypeName { get; set; }

Property Value

Type	Description
DataTypeName

Range

Required. Closed-open range of data points that will be rolled up. The maximum range for calories-in-heart-rate-zone, heart-rate, active-minutes and total-calories is 14 days. The maximum range for all other data types is 90 days.

Declaration

public Interval Range { get; set; }

Property Value

Type	Description
Interval

WindowSize

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

Declaration

public Duration WindowSize { get; set; }

Property Value

Type	Description
Duration