Class UsersResource.DataTypesResource.DataPointsResource.ListRequest

Query user health and fitness data points.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListDataPointsResponse>
GoogleHealthAPIBaseServiceRequest<ListDataPointsResponse>
UsersResource.DataTypesResource.DataPointsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.GoogleHealthAPI.v4
Assembly: Google.Apis.GoogleHealthAPI.v4.dll
Syntax
public class UsersResource.DataTypesResource.DataPointsResource.ListRequest : GoogleHealthAPIBaseServiceRequest<ListDataPointsResponse>, IClientServiceRequest<ListDataPointsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

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: &gt;=, &lt; - Timestamp literal expected in RFC-3339 format - Supported logical operators: AND

  • Example: - steps.interval.start_time &gt;= "2023-11-24T00:00:00Z" AND steps.interval.start_time &lt; "2023-11-25T00:00:00Z" - distance.interval.start_time &gt;= "2024-08-14T12:34:56Z" - Interval civil start time: - Pattern: {interval_data_type}.interval.civil_start_time - Supported comparison operators: &gt;=, &lt; - 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 &gt;= "2023-11-24" AND steps.interval.civil_start_time &lt; "2023-11-25" - distance.interval.civil_start_time &gt;= "2024-08-14T12:34:56" - Sample observation physical time: - Pattern: {sample_data_type}.sample_time.physical_time - Supported comparison operators: &gt;=, &lt; - Timestamp literal expected in RFC-3339 format - Supported logical operators: AND - Example: - weight.sample_time.physical_time &gt;= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time &lt; "2023-11-25T00:00:00Z" - weight.sample_time.physical_time &gt;= "2024-08-14T12:34:56Z" - Sample observation civil time: - Pattern: {sample_data_type}.sample_time.civil_time - Supported comparison operators: &gt;=, &lt; - 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 &gt;= "2023-11-24" AND weight.sample_time.civil_time &lt; "2023-11-25" - weight.sample_time.civil_time &gt;= "2024-08-14T12:34:56" - Daily summary date: - Pattern: {daily_summary_data_type}.date - Supported comparison operators: &gt;=, &lt; - Date literal expected in ISO 8601 YYYY-MM-DD format - Supported logical operators: AND - Example: - daily_resting_heart_rate.date &gt;= "2024-08-14" - daily_heart_rate_variability.date &lt; "2024-08-15" - Session civil start time (Excluding Sleep): - Pattern: {session_data_type}.interval.civil_start_time - Supported comparison operators: &gt;=, &lt; - 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 &gt;= "2023-11-24" AND exercise.interval.civil_start_time &lt; "2023-11-25" - exercise.interval.civil_start_time &gt;= "2024-08-14T12:34:56" - Session end time (Sleep specific): - Pattern: sleep.interval.end_time - Supported comparison operators: &gt;=, &lt; - Timestamp literal expected in RFC-3339 format - Supported logical operators: AND, OR - Example: - sleep.interval.end_time &gt;= "2023-11-24T00:00:00Z" AND sleep.interval.end_time &lt; "2023-11-25T00:00:00Z" - Session civil end time (Sleep specific): - Pattern: sleep.interval.civil_end_time - Supported comparison operators: &gt;=, &lt; - 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 &gt;= "2023-11-24" AND sleep.interval.civil_end_time &lt; "2023-11-25" Data points in the response will be ordered by the interval start time in descending order.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

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
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type 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.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements