Class ListDataPointsRequest

Request for listing raw data points

Inheritance
object
ListDataPointsRequest
Implements
Inherited Members
Namespace: Google.DevicesAndServices.Health.V4
Assembly: Google.DevicesAndServices.Health.V4.dll
Syntax
public sealed class ListDataPointsRequest : IMessage<ListDataPointsRequest>, IEquatable<ListDataPointsRequest>, IDeepCloneable<ListDataPointsRequest>, IBufferMessage, IMessage, IPageRequest

Constructors

ListDataPointsRequest()

Declaration
public ListDataPointsRequest()

ListDataPointsRequest(ListDataPointsRequest)

Declaration
public ListDataPointsRequest(ListDataPointsRequest other)
Parameters
Type Name Description
ListDataPointsRequest other

Properties

Filter

Optional. Filter expression following https://google.aip.dev/160.

A time range (either physical or civil) can be specified.

The supported filter fields are:

  • Interval start time:

    • Pattern: {interval_data_type}.interval.start_time
    • Supported comparison operators: >=, <
    • Timestamp literal expected in RFC-3339 format
    • Supported logical operators: AND
    • Example:
      • steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"
      • distance.interval.start_time >= "2024-08-14T12:34:56Z"

  • Interval civil start time:

    • Pattern: {interval_data_type}.interval.civil_start_time
    • Supported comparison operators: >=, <
    • Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
    • Supported logical operators: AND
    • Example:
      • steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"
      • distance.interval.civil_start_time >= "2024-08-14T12:34:56"

  • Sample observation physical time:

    • Pattern: {sample_data_type}.sample_time.physical_time
    • Supported comparison operators: >=, <
    • Timestamp literal expected in RFC-3339 format
    • Supported logical operators: AND
    • Example:
      • weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"
      • weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"

  • Sample observation civil time:

    • Pattern: {sample_data_type}.sample_time.civil_time
    • Supported comparison operators: >=, <
    • Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
    • Supported logical operators: AND
    • Example:
      • weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"
      • weight.sample_time.civil_time >= "2024-08-14T12:34:56"

  • Daily summary date:

    • Pattern: {daily_summary_data_type}.date
    • Supported comparison operators: >=, <
    • Date literal expected in ISO 8601 YYYY-MM-DD format
    • Supported logical operators: AND
    • Example:
      • daily_resting_heart_rate.date >= "2024-08-14"
      • daily_heart_rate_variability.date < "2024-08-15"

  • Session civil start time (Excluding Sleep):

    • Pattern: {session_data_type}.interval.civil_start_time
    • Supported comparison operators: >=, <
    • Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
    • Supported logical operators: AND
    • Example:
      • exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"
      • exercise.interval.civil_start_time >= "2024-08-14T12:34:56"

  • Session end time (Sleep specific):

    • Pattern: sleep.interval.end_time
    • Supported comparison operators: >=, <
    • Timestamp literal expected in RFC-3339 format
    • Supported logical operators: AND, OR
    • Example:
      • sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"

  • Session civil end time (Sleep specific):

    • Pattern: sleep.interval.civil_end_time
    • Supported comparison operators: >=, <
    • Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
    • Supported logical operators: AND, OR
    • Example:
      • sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"

Data points in the response will be ordered by the interval start time in descending order.

Declaration
public string Filter { 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. For exercise and sleep the default page size is 25. The maximum page size for exercise and sleep is 25.

Declaration
public int PageSize { get; set; }
Property Value
Type Description
int
Implements

PageToken

Optional. The next_page_token from a previous request, if any.

Declaration
public string PageToken { get; set; }
Property Value
Type Description
string
Implements

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][google.devicesandservices.health.v4.DataPoint] 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