API Reference

本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法,以及一或多種方法。

資源類型

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

Users.dataSources

如要進一步瞭解 Users.dataSources 資源,請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI (除非另有註明)
create POST  /userId/dataSources 建立在這位使用者所有資料來源中不重複的新資料來源。

資料來源是感應器的不重複資料來源。資料來源可能會公開來自本機或隨附裝置硬體感應器的原始資料。也可以公開衍生資料,也就是轉換或合併其他資料來源而建立的資料。同一資料類型可以有多個資料來源。從 Fitness API 插入或讀取的每個資料集的每個資料點都具有關聯的資料來源。

每個資料來源都會產生一組有專屬資料來源 ID 的專屬更新資料集更新。資料來源的變更不一定會影響資料串流 ID,因此相同應用程式/裝置的更新版本收集的資料仍會視為屬於同一資料來源。

系統會根據建立的來源內容,使用伺服器產生的字串來識別資料來源。叫用這個方法時,不應設定 dataStreamId 欄位。伺服器將會以正確的格式自動產生憑證。如果設定了 dataStreamId,就必須與伺服器產生的格式相符。這種格式是資料來源中部分欄位的組合,且具有特定順序。如果不相符,要求就會失敗,並顯示錯誤。

指定非已知類型的 DataType (以「com.google.」開頭) 將透過自訂資料類型建立 DataSource。只有建立自訂資料類型的應用程式可以讀取這些類型。自訂資料類型已淘汰,請改用標準資料類型。

除了資料來源 ID 包含的資料來源欄位外,也包含在建立資料來源時驗證的開發人員專案編號。當任何其他讀取公開資料類型的開發人員讀取時,這個開發人員專案編號會經過模糊處理。
delete DELETE  /userId/dataSources/dataSourceId 刪除指定的資料來源。如果資料來源包含任何資料點,要求就會失敗。
get GET  /userId/dataSources/dataSourceId 傳回指定的資料來源。
list GET  /userId/dataSources 使用提供的 OAuth 範圍,列出開發人員可見的所有資料來源。該清單僅列舉部分項目;使用者可能有隻有其他開發人員能查看的私人資料來源,或使用其他範圍的呼叫。
更新 PUT  /userId/dataSources/dataSourceId 更新指定的資料來源。dataStreamIddataTypetypedataStreamNamedevice 屬性 (version 除外) 無法修改。

資料來源由其dataStreamId識別。

Users.dataSources.dataPointChanges

如要進一步瞭解 Users.dataSources.dataPointChanges 資源,請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI (除非另有註明)
list GET  /userId/dataSources/dataSourceId/dataPointChanges 特定資料來源的使用者資料點查詢量發生變化。

Users.dataSources.datasets

如要進一步瞭解 Users.dataSources.datasets 資源,請參閱資源表示法頁面。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI (除非另有註明)
delete DELETE  /userId/dataSources/dataSourceId/datasets/datasetId 針對開始時間和結束時間與資料集 ID 指定時間範圍重疊的所有資料點執行納入包容性刪除。大部分資料類型都會刪除整個資料點。如果資料類型表示時間範圍代表一致的值 (例如 com.google.activity.segment),而資料點則橫跨資料集任一端點,則系統只會刪除資料點的重疊部分。
get GET  /userId/dataSources/dataSourceId/datasets/datasetId 傳回含有所有資料點的資料集,這些資料點的起點和結束時間與資料集的最小開始時間和結束時間之間的指定範圍重疊。具體來說,開始時間小於或等於資料集結束時間,且結束時間大於或等於資料集開始時間的任何資料點。
修補 PATCH  /userId/dataSources/dataSourceId/datasets/datasetId 在資料集中新增資料點。先前不一定要建立資料集。 系統將傳回指定資料集內的所有點,同時發出子呼叫來擷取這個資料集。資料點可以屬於多個資料集。

這個方法不使用修補語意:系統只會插入提供的資料點,不會取代現有資料。

Users.dataset

如要進一步瞭解 Users.dataset 資源,請參閱資源表示法頁面。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI (除非另有註明)
匯總 POST  /userId/dataset:aggregate 可將特定類型的或串流的資料匯總成值區,除以指定邊界類型。系統可能會將來自多個來源的多個資料類型和多個來源的資料集匯總至每個要求一個值區類型。

Users.sessions

如要進一步瞭解 Users.sessions 資源,請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI (除非另有註明)
delete DELETE  /userId/sessions/sessionId 刪除指定工作階段 ID 指定的工作階段。
list GET  /userId/sessions 列出先前建立的工作階段。
更新 PUT  /userId/sessions/sessionId 更新或插入指定工作階段。