API Reference

Tài liệu tham khảo API này được sắp xếp theo loại tài nguyên. Mỗi loại tài nguyên có một hoặc nhiều cách trình bày dữ liệu và một hoặc nhiều phương thức.

Loại tài nguyên

  1. User.dataSources
  2. User.dataSources.dataPointChanges
  3. User.dataSources.datasets
  4. User.dataset
  5. User.sessions

Người dùng.dataSources

Để biết thông tin chi tiết về tài nguyên của User.dataSources, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI tương ứng với https://www.googleapis.com/fitness/v1/users, trừ khi có lưu ý khác
tạo POST  /userId/dataSources Tạo một nguồn dữ liệu mới duy nhất trên tất cả các nguồn dữ liệu thuộc người dùng này.

Nguồn dữ liệu là nguồn dữ liệu cảm biến duy nhất. Các nguồn dữ liệu có thể tiết lộ dữ liệu thô đến từ cảm biến phần cứng trên các thiết bị cục bộ hoặc đồng hành. Chúng cũng có thể hiển thị dữ liệu phát sinh, được tạo bằng cách biến đổi hoặc hợp nhất các nguồn dữ liệu khác. Có thể tồn tại nhiều nguồn dữ liệu cho cùng một loại dữ liệu. Mọi điểm dữ liệu trong mọi tập dữ liệu được chèn vào hoặc đọc từ API Thể dục đều có nguồn dữ liệu được liên kết.

Mỗi nguồn dữ liệu sẽ tạo ra một luồng cập nhật tập dữ liệu duy nhất, với giá trị nhận dạng riêng biệt của nguồn dữ liệu. Không phải tất cả thay đổi đối với nguồn dữ liệu đều ảnh hưởng đến mã luồng dữ liệu, do đó, dữ liệu được thu thập bởi các phiên bản cập nhật của cùng một ứng dụng/thiết bị vẫn có thể được coi là thuộc về cùng một nguồn dữ liệu.

Nguồn dữ liệu được xác định bằng cách sử dụng một chuỗi do máy chủ tạo, dựa trên nội dung của nguồn đang được tạo. Không được đặt trường dataStreamId khi gọi phương thức này. Thông tin này sẽ được máy chủ tạo tự động ở định dạng chính xác. Nếu bạn đặt dataStreamId, thì dataStreamId phải khớp với định dạng mà máy chủ sẽ tạo. Định dạng này là sự kết hợp của một số trường từ nguồn dữ liệu và có thứ tự cụ thể. Nếu không khớp, yêu cầu sẽ không thành công kèm theo lỗi.

Chỉ định DataType không phải là loại đã biết (bắt đầu bằng "com.google.") sẽ tạo một DataSource với loại dữ liệu tuỳ chỉnh. Chỉ ứng dụng tạo ra loại dữ liệu đó mới có thể đọc được các loại dữ liệu tùy chỉnh. Các loại dữ liệu tuỳ chỉnh sẽ không được dùng nữa; hãy sử dụng các loại dữ liệu chuẩn.

Ngoài các trường nguồn dữ liệu có trong mã nhận dạng nguồn dữ liệu, số dự án dành cho nhà phát triển sẽ được xác thực khi tạo nguồn dữ liệu. Số dự án dành cho nhà phát triển này bị xáo trộn khi được đọc bằng bất kỳ loại dữ liệu công khai nào khác của nhà phát triển.
xóa DELETE  /userId/dataSources/dataSourceId Xoá nguồn dữ liệu được chỉ định. Yêu cầu sẽ không thành công nếu nguồn dữ liệu chứa bất kỳ điểm dữ liệu nào.
tải GET  /userId/dataSources/dataSourceId Trả về nguồn dữ liệu được chỉ định.
list GET  /userId/dataSources Liệt kê tất cả các nguồn dữ liệu mà nhà phát triển có thể nhìn thấy bằng cách sử dụng các phạm vi OAuth được cung cấp. Danh sách này chưa đầy đủ; người dùng có thể có các nguồn dữ liệu riêng tư chỉ hiển thị với các nhà phát triển khác hoặc cuộc gọi sử dụng phạm vi khác.
cập nhật PUT  /userId/dataSources/dataSourceId Cập nhật nguồn dữ liệu đã chỉ định. Bạn không thể sửa đổi các thuộc tính dataStreamId, dataType, type, dataStreamNamedevice, ngoại trừ version.

dataStreamId xác định nguồn dữ liệu.

User.dataSources.dataPointChanges

Để biết thông tin chi tiết về Tài nguyên của người dùng.dataSources.dataPointChanges, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI tương ứng với https://www.googleapis.com/fitness/v1/users, trừ khi có lưu ý khác
list GET  /userId/dataSources/dataSourceId/dataPointChanges Các truy vấn cho điểm dữ liệu của người dùng sẽ thay đổi đối với một nguồn dữ liệu cụ thể.

User.dataSources.datasets

Đối với User.dataSources.datasets Thông tin chi tiết về tài nguyên, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI tương ứng với https://www.googleapis.com/fitness/v1/users, trừ khi có lưu ý khác
xóa DELETE  /userId/dataSources/dataSourceId/datasets/datasetId Thực hiện thao tác xóa toàn bộ tất cả các điểm dữ liệu có thời gian bắt đầu và kết thúc trùng lặp với phạm vi thời gian do mã tập dữ liệu chỉ định. Đối với hầu hết các loại dữ liệu, toàn bộ điểm dữ liệu sẽ bị xoá. Đối với các loại dữ liệu mà khoảng thời gian đại diện cho một giá trị nhất quán (chẳng hạn như com.google.activity.segment) và một điểm dữ liệu trải dài vào một trong hai điểm của tập dữ liệu, thì chỉ phần trùng lặp của điểm dữ liệu sẽ bị xoá.
tải GET  /userId/dataSources/dataSourceId/datasets/datasetId Trả về một tập dữ liệu chứa tất cả các điểm dữ liệu có thời gian bắt đầu và kết thúc trùng lặp với phạm vi thời gian bắt đầu tối thiểu của tập dữ liệu đã chỉ định và thời gian kết thúc tối đa. Cụ thể, mọi điểm dữ liệu có thời gian bắt đầu nhỏ hơn hoặc bằng thời gian kết thúc của tập dữ liệu và thời gian kết thúc lớn hơn hoặc bằng thời gian bắt đầu của tập dữ liệu.
bản vá PATCH  /userId/dataSources/dataSourceId/datasets/datasetId Thêm điểm dữ liệu vào tập dữ liệu. Bạn không cần phải tạo tập dữ liệu trước đây. Tất cả điểm trong tập dữ liệu cho trước sẽ được trả về bằng các lệnh gọi tiếp theo để truy xuất tập dữ liệu này. Các điểm dữ liệu có thể thuộc về nhiều tập dữ liệu.

Phương thức này không sử dụng ngữ nghĩa của bản vá: các điểm dữ liệu được cung cấp chỉ được chèn vào, không có dữ liệu hiện có nào được thay thế.

User.dataset

Để biết thông tin chi tiết về Tài nguyên user.dataset, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI tương ứng với https://www.googleapis.com/fitness/v1/users, trừ khi có lưu ý khác
Tổng hợp POST  /userId/dataset:aggregate Tổng hợp dữ liệu của một loại hoặc luồng nhất định thành các nhóm chia cho một loại ranh giới cụ thể. Bạn có thể tổng hợp nhiều tập dữ liệu thuộc nhiều loại và từ nhiều nguồn thành đúng một loại nhóm cho mỗi yêu cầu.

Phiên hoạt động của người dùng

Để biết thông tin chi tiết về tài nguyên của User.sessions, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI tương ứng với https://www.googleapis.com/fitness/v1/users, trừ khi có lưu ý khác
xóa DELETE  /userId/sessions/sessionId Xoá một phiên hoạt động do mã phiên đã chỉ định.
list GET  /userId/sessions Liệt kê các phiên được tạo trước đó.
cập nhật PUT  /userId/sessions/sessionId Cập nhật hoặc chèn một phiên nhất định.