# Fitness . users . dataset

## Instance Methods

Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request.

### Method Details

`aggregate(userId, body)`

    Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request.

    Args:
      userId: string, Aggregate data for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
      body: object, The request body. (required)
        The object takes the form of:

    {
        "aggregateBy": [ # 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.
          { # The specification of which data to aggregate.
            "dataSourceId": "A String", # 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.
            "dataTypeName": "A String", # 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
          },
        ],
        "bucketByActivitySegment": { # 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.
          "activityDataSourceId": "A String", # The default activity stream will be used if a specific activityDataSourceId is not specified.
          "minDurationMillis": "A String", # Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data.
        },
        "endTimeMillis": "A String", # 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.
        "bucketBySession": { # 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.
          "minDurationMillis": "A String", # Specifies that only sessions of duration longer than minDurationMillis are considered and used as a container for aggregated data.
        },
        "bucketByActivityType": { # 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.
          "activityDataSourceId": "A String", # The default activity stream will be used if a specific activityDataSourceId is not specified.
          "minDurationMillis": "A String", # Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data.
        },
        "startTimeMillis": "A String", # 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.
        "bucketByTime": { # Specifies that data be aggregated by a single time interval. Mutually exclusive of other bucketing specifications.
          "durationMillis": "A String", # 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.
        },
      }

    Returns:
      An object of the form:

        {
        "bucket": [ # A list of buckets containing the aggregated data.
          {
            "endTimeMillis": "A String", # The end time for the aggregated data, in milliseconds since epoch, inclusive.
            "dataset": [ # There will be one dataset per AggregateBy in the request.
              { # 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.
                  "minStartTimeNs": "A String", # 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.
                  "nextPageToken": "A String", # 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.
                  "maxEndTimeNs": "A String", # 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.
                  "dataSourceId": "A String", # The data stream ID of the data source that created the points in this dataset.
                  "point": [ # 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.
                    { # 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.
                      "modifiedTimeMillis": "A String", # 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.
                      "startTimeNanos": "A String", # The start time of the interval represented by this data point, in nanoseconds since epoch.
                      "dataTypeName": "A String", # The data type defining the format of the values in this data point.
                      "endTimeNanos": "A String", # The end time of the interval represented by this data point, in nanoseconds since epoch.
                      "value": [ # 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.
                        { # 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.
                          "mapVal": [ # 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.
                            {
                              "value": { # 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.
                                "fpVal": 3.14, # Floating point value.
                              },
                              "key": "A String",
                            },
                          ],
                          "fpVal": 3.14, # Floating point value. When this is set, other values must not be set.
                          "intVal": 42, # Integer value. When this is set, other values must not be set.
                          "stringVal": "A String", # 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.
                        },
                      ],
                      "computationTimeMillis": "A String", # Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.
                      "originDataSourceId": "A String", # 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.
                      "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.
                    },
                  ],
                },
            ],
            "session": { # Sessions contain metadata, such as a user-friendly name and time interval information. # Available for Bucket.Type.SESSION
              "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
              "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
              "description": "A String", # A description for this session.
              "activityType": 42, # The type of activity this session represents.
              "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # The application that created the session.
                "packageName": "A String", # 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.
                "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
                "name": "A String", # 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.
                "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
              },
              "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
              "activeTimeMillis": "A String", # 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
              "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
              "name": "A String", # A human readable name of the session.
            },
            "activity": 42, # Available for Bucket.Type.ACTIVITY_TYPE, Bucket.Type.ACTIVITY_SEGMENT
            "startTimeMillis": "A String", # The start time for the aggregated data, in milliseconds since epoch, inclusive.
            "type": "A String", # The type of a bucket signifies how the data aggregation is performed in the bucket.
          },
        ],
      }