Documentation

Google_Service_Fitness_Resource_UsersDataSourcesDatasets extends Google_Service_Resource
in package

The "datasets" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
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.
get()  : Google_Service_Fitness_Dataset
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)
patch()  : Google_Service_Fitness_Dataset
Adds data points to a dataset. The dataset need not be previously created.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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.

public delete(string $userId, string $dataSourceId, string $datasetId[, array<string|int, mixed> $optParams = array() ]) : mixed

(datasets.delete)

Parameters
$userId : string

Delete a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

$dataSourceId : string

The data stream ID of the data source that created the dataset.

$datasetId : string

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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

Return values
mixed —

get()

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)

public get(string $userId, string $dataSourceId, string $datasetId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Fitness_Dataset
Parameters
$userId : string

Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

$dataSourceId : string

The data stream ID of the data source that created the dataset.

$datasetId : string

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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

opt_param

int limit If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response.

Return values
Google_Service_Fitness_Dataset —

patch()

Adds data points to a dataset. The dataset need not be previously created.

public patch(string $userId, string $dataSourceId, string $datasetId, Google_Service_Fitness_Dataset $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Fitness_Dataset

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
$userId : string

Patch a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

$dataSourceId : string

The data stream ID of the data source that created the dataset.

$datasetId : string

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.

$postBody : Google_Service_Fitness_Dataset
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results