Google_Service_Fitness_UsersDataSourcesDatasets_Resource Class Reference

The "datasets" collection of methods. More...

Inheritance diagram for Google_Service_Fitness_UsersDataSourcesDatasets_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($userId, $dataSourceId, $datasetId, $optParams=array())
	Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID.
	get ($userId, $dataSourceId, $datasetId, $optParams=array())
	Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time.
	patch ($userId, $dataSourceId, $datasetId, Google_Service_Fitness_Dataset $postBody, $optParams=array())
	Adds data points to a dataset.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "datasets" collection of methods.

Typical usage is: $fitnessService = new Google_Service_Fitness(...); $datasets = $fitnessService->datasets;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

delete()

Google_Service_Fitness_UsersDataSourcesDatasets_Resource::delete	(		$userId,
			$dataSourceId,
			$datasetId,
			$optParams = array() )

Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID.

For most data types, the entire data point will be deleted. For data types where the time span represents a consistent value (such as com.google.activity.segment), and a data point straddles either end point of the dataset, only the overlapping portion of the data point will be deleted. (datasets.delete)

Parameters

string	$userId	Delete a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.
string	$dataSourceId	The data stream ID of the data source that created the dataset.
string	$datasetId	Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.
array	$optParams	Optional parameters.

@opt_param string modifiedTimeMillis When the operation was performed on the client. @opt_param string currentTimeMillis The client's current time in milliseconds since epoch.

get()

Google_Service_Fitness_UsersDataSourcesDatasets_Resource::get	(		$userId,
			$dataSourceId,
			$datasetId,
			$optParams = array() )

Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time.

Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time. (datasets.get)

Parameters

string	$userId	Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.
string	$dataSourceId	The data stream ID of the data source that created the dataset.
string	$datasetId	Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.
array	$optParams	Optional parameters.

@opt_param int limit If specified, no more than this many data points will be included in the dataset. If the there are more data points in the dataset, nextPageToken will be set in the dataset response. @opt_param string pageToken The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of nextPageToken from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response.

Return values

Google_Service_Fitness_Dataset

patch()

Google_Service_Fitness_UsersDataSourcesDatasets_Resource::patch	(		$userId,
			$dataSourceId,
			$datasetId,
		Google_Service_Fitness_Dataset	$postBody,
			$optParams = array() )

Adds data points to a dataset.

The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics. (datasets.patch)

Parameters

string	$userId	Patch a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.
string	$dataSourceId	The data stream ID of the data source that created the dataset.
string	$datasetId	Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.
Google_Dataset	$postBody
array	$optParams	Optional parameters.

@opt_param string currentTimeMillis The client's current time in milliseconds since epoch. Note that the minStartTimeNs and maxEndTimeNs properties in the request body are in nanoseconds instead of milliseconds.

Return values

Google_Service_Fitness_Dataset

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Fitness.php