API Reference

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

資源類型

  1. Users.dataSources
  2. Users.dataSources.dataPointChanges
  3. Users.dataSources.資料集
  4. Users.dataset
  5. Users.sessions

Users.dataSources

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

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI,除非另有註明
建立 POST  /userId/dataSources 建立新的使用者資料來源,並確保其所屬的所有資料來源都不重複。

資料來源是感應器資料的唯一來源,資料來源可能會揭露本機或隨附裝置的硬體感應器的原始資料。此外,也可以公開轉換或合併其他資料來源產生的衍生資料。相同資料類型可能會有多個資料來源。每個從 Fitness API 插入或讀取的每個資料集裡,每個資料點都有相關聯的資料來源。

每個資料來源都會產生一組不重複的資料集更新,其中包含專屬資料來源 ID。並非所有資料來源的變更都會影響資料串流 ID,因此由相同應用程式/裝置更新版本收集的資料仍可視為同一個資料來源。

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

指定非已知類型 DataType (開頭為 com.google.") 將建立具有自訂資料類型的 DataSource。自訂資料類型僅供建立的應用程式讀取。自訂資料類型已淘汰,請改用標準資料類型。

除了資料來源 ID 中包含的資料來源欄位之外,開發人員建立號碼時也會完成驗證的開發人員專案編號。其他開發人員讀取公開資料類型時,對這個開發人員專案編號進行模糊處理。
刪除 DELETE  /userId/dataSources/dataSourceId 刪除指定的資料來源。如果資料來源包含任何資料點,要求就會失敗。
get GET  /userId/dataSources/dataSourceId 傳回指定的資料來源。
清單 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,除非另有註明
清單 GET  /userId/dataSources/dataSourceId/dataPointChanges 查詢特定資料來源的使用者資料點變更。

Users.dataSources.datasets

如要進一步瞭解 Users.dataSources. dataset 資源詳細資料,請參閱資源表示法

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/fitness/v1/users 的 URI,除非另有註明
刪除 DELETE  /userId/dataSources/dataSourceId/datasets/datasetId 針對開始和結束時間與資料集 ID 指定時間範圍重疊的所有資料點,執行具包容性的刪除作業。針對大多數資料類型,系統會刪除整個資料點。如果時間範圍橫跨一致的值 (例如 com.google.activity.segment),且資料點橫跨於資料集的兩端,系統只會刪除資料點的重疊部分。
get GET  /userId/dataSources/dataSourceId/datasets/datasetId 傳回含有所有資料點的資料集,其中開始時間和結束時間與指定資料集最小開始時間和最大結束時間重疊。具體來說,任何資料點的開始時間小於或等於資料集結束時間,以及結束時間大於或等於資料集開始時間的資料點。
patch 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  /userId/sessions/sessionId 刪除指定工作階段 ID 指定的工作階段。
清單 GET  /userId/sessions 列出先前建立的工作階段。
更新 PUT  /userId/sessions/sessionId 更新或插入指定工作階段。