gogol-fitness-0.0.1: Google Fitness SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Fitness.Types

Contents

Description

 

Synopsis

Service Configuration

fitnessService :: Service Source

Default request referring to version v1 of the Fitness. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

fitnessBodyReadScope :: OAuthScope Source

View body sensor information in Google Fit

fitnessActivityReadScope :: OAuthScope Source

View your activity information in Google Fit

fitnessActivityWriteScope :: OAuthScope Source

View and store your activity information in Google Fit

fitnessLocationReadScope :: OAuthScope Source

View your stored location data in Google Fit

fitnessLocationWriteScope :: OAuthScope Source

View and store your location data in Google Fit

fitnessBodyWriteScope :: OAuthScope Source

View and store body sensor data in Google Fit

AggregateBucketType

DataSet

data DataSet Source

A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset.

See: dataSet smart constructor.

dataSet :: DataSet Source

Creates a value of DataSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsNextPageToken :: Lens' DataSet (Maybe Text) Source

This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset.

dsDataSourceId :: Lens' DataSet (Maybe Text) Source

The data stream ID of the data source that created the points in this dataset.

dsPoint :: Lens' DataSet [DataPoint] Source

A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response.

dsMinStartTimeNs :: Lens' DataSet (Maybe Int64) Source

The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.

dsMaxEndTimeNs :: Lens' DataSet (Maybe Int64) Source

The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.

Application

data Application Source

See: google3/java/com/google/android/apps/heart/platform/api/Application.java

See: application smart constructor.

application :: Application Source

Creates a value of Application with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aPackageName :: Lens' Application (Maybe Text) Source

Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.

aName :: Lens' Application (Maybe Text) Source

The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.

aVersion :: Lens' Application (Maybe Text) Source

Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.

aDetailsURL :: Lens' Application (Maybe Text) Source

An optional URI that can be used to link back to the application.

AggregateResponse

aggregateResponse :: AggregateResponse Source

Creates a value of AggregateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

arBucket :: Lens' AggregateResponse [AggregateBucket] Source

A list of buckets containing the aggregated data.

AggregateBy

aggregateBy :: AggregateBy Source

Creates a value of AggregateBy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

abDataTypeName :: Lens' AggregateBy (Maybe Text) Source

The data type to aggregate. All data sources providing this data type will contribute data to the aggregation. The response will contain a single dataset for this data type name. The dataset will have a data source ID of derived:com.google.:com.google.android.gms:aggregated

abDataSourceId :: Lens' AggregateBy (Maybe Text) Source

A data source ID to aggregate. Mutually exclusive of dataTypeName. Only data from the specified data source ID will be included in the aggregation. The dataset in the response will have the same data source ID.

DataSourceType

BucketByActivity

bucketByActivity :: BucketByActivity Source

Creates a value of BucketByActivity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bbaMinDurationMillis :: Lens' BucketByActivity (Maybe Int64) Source

Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data.

bbaActivityDataSourceId :: Lens' BucketByActivity (Maybe Text) Source

The default activity stream will be used if a specific activityDataSourceId is not specified.

AggregateRequest

aggregateRequest :: AggregateRequest Source

Creates a value of AggregateRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

arEndTimeMillis :: Lens' AggregateRequest (Maybe Int64) Source

The end of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive.

arAggregateBy :: Lens' AggregateRequest [AggregateBy] Source

The specification of data to be aggregated. At least one aggregateBy spec must be provided. All data that is specified will be aggregated using the same bucketing criteria. There will be one dataset in the response for every aggregateBy spec.

arBucketBySession :: Lens' AggregateRequest (Maybe BucketBySession) Source

Specifies that data be aggregated by user sessions. Data that does not fall within the time range of a session will not be included in the response. Mutually exclusive of other bucketing specifications.

arBucketByActivityType :: Lens' AggregateRequest (Maybe BucketByActivity) Source

Specifies that data be aggregated by the type of activity being performed when the data was recorded. All data that was recorded during a certain activity type (for the given time range) will be aggregated into the same bucket. Data that was recorded while the user was not active will not be included in the response. Mutually exclusive of other bucketing specifications.

arBucketByTime :: Lens' AggregateRequest (Maybe BucketByTime) Source

Specifies that data be aggregated by a single time interval. Mutually exclusive of other bucketing specifications.

arStartTimeMillis :: Lens' AggregateRequest (Maybe Int64) Source

The start of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive.

arBucketByActivitySegment :: Lens' AggregateRequest (Maybe BucketByActivity) Source

Specifies that data be aggregated each activity segment recored for a user. Similar to bucketByActivitySegment, but bucketing is done for each activity segment rather than all segments of the same type. Mutually exclusive of other bucketing specifications.

Device

data Device Source

Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including: - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance) - Display the source of data to the user (by using the device make / model) - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone) - Build different analysis models for each device/version.

See: device smart constructor.

device :: Device Source

Creates a value of Device with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dManufacturer :: Lens' Device (Maybe Text) Source

Manufacturer of the product/hardware.

dUid :: Lens' Device (Maybe Text) Source

The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.

dModel :: Lens' Device (Maybe Text) Source

End-user visible model name for the device.

dVersion :: Lens' Device (Maybe Text) Source

Version string for the device hardware/software.

dType :: Lens' Device (Maybe DeviceType) Source

A constant representing the type of the device.

Value

data Value Source

Holder object for the value of a single field in a data point. A field value has a particular format and is only ever set to one of an integer or a floating point value.

See: value smart constructor.

value :: Value Source

Creates a value of Value with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vMapVal :: Lens' Value [ValueMapValEntry] Source

Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.

vFpVal :: Lens' Value (Maybe Double) Source

Floating point value. When this is set, other values must not be set.

vIntVal :: Lens' Value (Maybe Int32) Source

Integer value. When this is set, other values must not be set.

vStringVal :: Lens' Value (Maybe Text) Source

String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.

BucketBySession

bucketBySession :: BucketBySession Source

Creates a value of BucketBySession with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bbsMinDurationMillis :: Lens' BucketBySession (Maybe Int64) Source

Specifies that only sessions of duration longer than minDurationMillis are considered and used as a container for aggregated data.

DataPoint

data DataPoint Source

Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type. A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type. Data points always contain one value for each field of the data type.

See: dataPoint smart constructor.

dataPoint :: DataPoint Source

Creates a value of DataPoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dpOriginDataSourceId :: Lens' DataPoint (Maybe Text) Source

If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.

dpRawTimestampNanos :: Lens' DataPoint (Maybe Int64) Source

The raw timestamp from the original SensorEvent.

dpDataTypeName :: Lens' DataPoint (Maybe Text) Source

The data type defining the format of the values in this data point.

dpValue :: Lens' DataPoint [Value] Source

Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source. Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field.

dpComputationTimeMillis :: Lens' DataPoint (Maybe Int64) Source

Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.

dpEndTimeNanos :: Lens' DataPoint (Maybe Int64) Source

The end time of the interval represented by this data point, in nanoseconds since epoch.

dpModifiedTimeMillis :: Lens' DataPoint (Maybe Int64) Source

Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.

dpStartTimeNanos :: Lens' DataPoint (Maybe Int64) Source

The start time of the interval represented by this data point, in nanoseconds since epoch.

ListSessionsResponse

listSessionsResponse :: ListSessionsResponse Source

Creates a value of ListSessionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lsrNextPageToken :: Lens' ListSessionsResponse (Maybe Text) Source

The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

lsrDeletedSession :: Lens' ListSessionsResponse [Session] Source

If includeDeleted is set to true in the request, this list will contain sessions deleted with original end times that are within the startTime and endTime frame.

lsrSession :: Lens' ListSessionsResponse [Session] Source

Sessions with an end time that is between startTime and endTime of the request.

AggregateBucket

aggregateBucket :: AggregateBucket Source

Creates a value of AggregateBucket with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

abEndTimeMillis :: Lens' AggregateBucket (Maybe Int64) Source

The end time for the aggregated data, in milliseconds since epoch, inclusive.

abDataSet :: Lens' AggregateBucket [DataSet] Source

There will be one dataset per AggregateBy in the request.

abActivity :: Lens' AggregateBucket (Maybe Int32) Source

Available for Bucket.Type.ACTIVITY_TYPE, Bucket.Type.ACTIVITY_SEGMENT

abType :: Lens' AggregateBucket (Maybe AggregateBucketType) Source

The type of a bucket signifies how the data aggregation is performed in the bucket.

abStartTimeMillis :: Lens' AggregateBucket (Maybe Int64) Source

The start time for the aggregated data, in milliseconds since epoch, inclusive.

abSession :: Lens' AggregateBucket (Maybe Session) Source

Available for Bucket.Type.SESSION

MapValue

data MapValue Source

Holder object for the value of an entry in a map field of a data point. A map value supports a subset of the formats that the regular Value supports.

See: mapValue smart constructor.

mapValue :: MapValue Source

Creates a value of MapValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mvFpVal :: Lens' MapValue (Maybe Double) Source

Floating point value.

ListDataSourcesResponse

listDataSourcesResponse :: ListDataSourcesResponse Source

Creates a value of ListDataSourcesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ldsrDataSource :: Lens' ListDataSourcesResponse [DataSource] Source

A previously created data source.

DataTypeField

data DataTypeField Source

In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.). This message is only instantiated in code and not used for wire comms or stored in any way.

See: dataTypeField smart constructor.

dataTypeField :: DataTypeField Source

Creates a value of DataTypeField with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtfFormat :: Lens' DataTypeField (Maybe DataTypeFieldFormat) Source

The different supported formats for each field in a data type.

dtfName :: Lens' DataTypeField (Maybe Text) Source

Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.

DataSource

data DataSource Source

Definition of 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 inserted into or read from this service has an associated data source. The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type. Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.

See: dataSource smart constructor.

dataSource :: DataSource Source

Creates a value of DataSource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsApplication :: Lens' DataSource (Maybe Application) Source

Information about an application which feeds sensor data into the platform.

dsDevice :: Lens' DataSource (Maybe Device) Source

Representation of an integrated device (such as a phone or a wearable) that can hold sensors.

dsName :: Lens' DataSource (Maybe Text) Source

An end-user visible name for this data source.

dsDataType :: Lens' DataSource (Maybe DataType) Source

The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.

dsType :: Lens' DataSource (Maybe DataSourceType) Source

A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.

dsDataStreamName :: Lens' DataSource (Maybe Text) Source

The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.

dsDataStreamId :: Lens' DataSource (Maybe Text) Source

A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.

DeviceType

ValueMapValEntry

valueMapValEntry :: ValueMapValEntry Source

Creates a value of ValueMapValEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

BucketByTime

bucketByTime :: BucketByTime Source

Creates a value of BucketByTime with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bbtDurationMillis :: Lens' BucketByTime (Maybe Int64) Source

Specifies that result buckets aggregate data by exactly durationMillis time frames. Time frames that contain no data will be included in the response with an empty dataset.

DataType

data DataType Source

See: google3/java/com/google/android/apps/heart/platform/api/DataType.java

See: dataType smart constructor.

dataType :: DataType Source

Creates a value of DataType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtField :: Lens' DataType [DataTypeField] Source

A field represents one dimension of a data type.

dtName :: Lens' DataType (Maybe Text) Source

Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.

Session

data Session Source

Sessions contain metadata, such as a user-friendly name and time interval information.

See: session smart constructor.

session :: Session Source

Creates a value of Session with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sEndTimeMillis :: Lens' Session (Maybe Int64) Source

An end time, in milliseconds since epoch, inclusive.

sActiveTimeMillis :: Lens' Session (Maybe Int64) Source

Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value

sApplication :: Lens' Session (Maybe Application) Source

The application that created the session.

sActivityType :: Lens' Session (Maybe Int32) Source

The type of activity this session represents.

sName :: Lens' Session (Maybe Text) Source

A human readable name of the session.

sModifiedTimeMillis :: Lens' Session (Maybe Int64) Source

A timestamp that indicates when the session was last modified.

sId :: Lens' Session (Maybe Text) Source

A client-generated identifier that is unique across all sessions owned by this particular user.

sStartTimeMillis :: Lens' Session (Maybe Int64) Source

A start time, in milliseconds since epoch, inclusive.

sDescription :: Lens' Session (Maybe Text) Source

A description for this session.

DataTypeFieldFormat