API Reference

Этот справочник API организован по типу ресурса. Каждый тип ресурса имеет одно или несколько представлений данных и один или несколько методов.

Типы ресурсов

  1. Пользователи.dataSources
  2. Пользователи.dataSources.dataPointChanges
  3. Пользователи.dataSources.наборы данных
  4. Users.dataset
  5. Пользователи.сессии

Пользователи.dataSources

Сведения о ресурсе Users.dataSources см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/fitness/v1/users, если не указано иное.
Создайте POST / userId /dataSources Создает новый источник данных, уникальный среди всех источников данных, принадлежащих этому пользователю.

Источник данных — это уникальный источник данных датчика. Источники данных могут предоставлять необработанные данные, поступающие от аппаратных датчиков на локальных или сопутствующих устройствах. Они также могут предоставлять производные данные, созданные путем преобразования или слияния других источников данных. Для одного и того же типа данных может существовать несколько источников данных. Каждая точка данных в каждом наборе данных, вставленном или прочитанном из Fitness API, имеет связанный с ним источник данных.

Каждый источник данных создает уникальный поток обновлений набора данных с уникальным идентификатором источника данных. Не все изменения в источнике данных влияют на идентификатор потока данных, поэтому данные, собранные обновленными версиями одного и того же приложения/устройства, можно по-прежнему считать принадлежащими одному и тому же источнику данных.

Источники данных идентифицируются с помощью строки, сгенерированной сервером на основе содержимого создаваемого источника. Поле dataStreamId не должно быть установлено при вызове этого метода. Он будет автоматически сгенерирован сервером в правильном формате. Если dataStreamId , он должен соответствовать формату, который будет генерировать сервер. Этот формат представляет собой комбинацию некоторых полей из источника данных и имеет определенный порядок. Если он не совпадает, запрос завершится с ошибкой.

Указание DataType неизвестного типа (начинающегося с "com.google.") приведет к созданию DataSource с пользовательским типом данных . Пользовательские типы данных доступны для чтения только тому приложению, которое их создало. Пользовательские типы данных устарели ; вместо этого используйте стандартные типы данных.

В дополнение к полям источника данных, включенным в идентификатор источника данных, включается номер проекта разработчика, который проходит проверку подлинности при создании источника данных. Этот номер проекта разработчика запутывается при чтении любым другим разработчиком, читающим общедоступные типы данных.
Удалить DELETE / userId /dataSources/ dataSourceId Удаляет указанный источник данных. Запрос завершится ошибкой, если источник данных содержит какие-либо точки данных.
получить GET / userId /dataSources/ dataSourceId Возвращает указанный источник данных.
список GET / userId /dataSources Список всех источников данных, видимых разработчику, с использованием предоставленных областей действия OAuth. Список не является исчерпывающим; у пользователя могут быть частные источники данных, которые видны только другим разработчикам, или вызовы с использованием других областей.
Обновить PUT / userId /dataSources/ dataSourceId Обновляет указанный источник данных. dataStreamId , dataType , type , dataStreamName и свойства device за исключением version не могут быть изменены.

Источники данных идентифицируются по их dataStreamId .

Пользователи.dataSources.dataPointChanges

Сведения о ресурсе Users.dataSources.dataPointChanges см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/fitness/v1/users, если не указано иное.
список GET / userId /dataSources/ dataSourceId /dataPointChanges Запросы на изменение точки данных пользователя для определенного источника данных.

Пользователи.dataSources.наборы данных

Сведения о ресурсах Users.dataSources.datasets см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/fitness/v1/users, если не указано иное.
Удалить DELETE / userId /dataSources/ dataSourceId /datasets/ datasetId Выполняет полное удаление всех точек данных, время начала и окончания которых пересекаются с диапазоном времени, заданным идентификатором набора данных. Для большинства типов данных вся точка данных будет удалена. Для типов данных, в которых временной интервал представляет собой согласованное значение (например, com.google.activity.segment ), а точка данных охватывает любую конечную точку набора данных, будет удалена только перекрывающаяся часть точки данных.
получить GET / userId /dataSources/ dataSourceId /datasets/ datasetId Возвращает набор данных, содержащий все точки данных, время начала и окончания которых перекрываются с указанным диапазоном минимального времени начала и максимального времени окончания набора данных. В частности, любая точка данных, время начала которой меньше или равно времени окончания набора данных и время окончания которого больше или равно времени начала набора данных.
пластырь PATCH / userId /dataSources/ dataSourceId /datasets/ datasetId Добавляет точки данных в набор данных. Набор данных не нужно предварительно создавать. Все точки в данном наборе данных будут возвращены с последующими вызовами для извлечения этого набора данных. Точки данных могут принадлежать более чем одному набору данных.

Этот метод не использует семантику исправления: предоставленные точки данных просто вставляются без замены существующих данных.

Users.dataset

Сведения о ресурсе Users.dataset см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/fitness/v1/users, если не указано иное.
агрегат POST / userId /dataset:aggregate Агрегирует данные определенного типа или потока в сегменты, разделенные границами заданного типа. Несколько наборов данных разных типов и из разных источников могут быть агрегированы ровно в один тип корзины для каждого запроса.

Пользователи.сессии

Сведения о ресурсе Users.sessions см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/fitness/v1/users, если не указано иное.
Удалить DELETE / userId /sessions/ sessionId Удаляет сеанс, указанный данным идентификатором сеанса.
список GET / userId /sessions Список сеансов, созданных ранее.
Обновить PUT / userId /sessions/ sessionId Обновляет или вставляет данный сеанс.