Users.sessions: list

列出先前建立的工作階段。 立即試用。

要求

HTTP 要求

GET https://www.googleapis.com/fitness/v1/users/userId/sessions

參數

參數名稱 值 說明
路徑參數
userId string 列出識別對象的時段。使用 me 來表示已驗證的使用者。目前僅支援 me。
選用查詢參數
activityType integer 如果非空白，系統只應傳回包含這些活動類型的工作階段。
endTime string RFC3339 時間戳記。只有在開始和結束時間之間結束的工作階段才會納入回應中。如果省略這個時間但已指定 startTime，系統會傳回 startTime 到結束時間的所有工作階段。
includeDeleted boolean 如果值為 true，且省略 startTime 和 endTime，則系統會傳回工作階段刪除。
pageToken string 用於漸進式同步處理的接續權杖。如要取得下一批變更，請將此參數設為前一個回應的 nextPageToken 值。如果指定開始或結束時間，系統就會忽略頁面權杖。如果沒有指定開始時間、結束時間和網頁符記，系統會傳回過去 30 天內修改的工作階段。
startTime string RFC3339 時間戳記。只有在開始和結束時間之間結束的工作階段才會納入回應中。如果省略這個時間但已指定 endTime，系統會傳回從開始到 endTime 前的所有工作階段。

授權

這項要求至少需要取得下列其中一個範圍的授權：

內容範圍
https://www.googleapis.com/auth/fitness.activity.read
https://www.googleapis.com/auth/fitness.activity.write
https://www.googleapis.com/auth/fitness.location.read
https://www.googleapis.com/auth/fitness.location.write
https://www.googleapis.com/auth/fitness.body.read
https://www.googleapis.com/auth/fitness.body.write
https://www.googleapis.com/auth/fitness.nutrition.read
https://www.googleapis.com/auth/fitness.nutrition.write
https://www.googleapis.com/auth/fitness.blood_pressure.read
https://www.googleapis.com/auth/fitness.blood_pressure.write
https://www.googleapis.com/auth/fitness.blood_glucose.read
https://www.googleapis.com/auth/fitness.blood_glucose.write
https://www.googleapis.com/auth/fitness.oxygen_saturation.read
https://www.googleapis.com/auth/fitness.oxygen_saturation.write
https://www.googleapis.com/auth/fitness.body_temperature.read
https://www.googleapis.com/auth/fitness.body_temperature.write
https://www.googleapis.com/auth/fitness.reproductive_health.read
https://www.googleapis.com/auth/fitness.reproductive_health.write

詳情請參閱「驗證和授權」網頁。

要求主體

請勿使用這個方法提供要求主體。

回覆

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "session": [
    {
      "id": string,
      "name": string,
      "description": string,
      "startTimeMillis": long,
      "endTimeMillis": long,
      "modifiedTimeMillis": long,
      "application": {
        "packageName": string,
        "version": string,
        "detailsUrl": string,
        "name": string
      },
      "activityType": integer,
      "activeTimeMillis": long
    }
  ],
  "deletedSession": [
    {
      "id": string,
      "name": string,
      "description": string,
      "startTimeMillis": long,
      "endTimeMillis": long,
      "modifiedTimeMillis": long,
      "application": {
        "packageName": string,
        "version": string,
        "detailsUrl": string,
        "name": string
      },
      "activityType": integer,
      "activeTimeMillis": long
    }
  ],
  "nextPageToken": string,
  "hasMoreData": boolean
}
屬性名稱 值 說明 附註
session[] list 結束時間落在要求的 startTime 至 endTime 之間。
session[].id string 用戶端產生的 ID，在這位使用者擁有的所有工作階段專屬。
session[].name string 人類可讀的工作階段名稱。
session[].description string 此時段的說明。
session[].startTimeMillis long 開始時間，以 Epoch 紀元時間起算的毫秒為單位 (含首尾)。
session[].endTimeMillis long 結束時間，以 Epoch 紀元時間起算的毫秒為單位 (含 Epoch 紀元時間起算)。
session[].modifiedTimeMillis long 時間戳記，指出工作階段的上次修改時間。
session[].application nested object 建立工作階段的應用程式。
session[].application.packageName string 此應用程式的套件名稱。由 Android 應用程式建立時，這會做為專屬 ID，但 REST 用戶端無法指定。REST 用戶端的開發人員專案編號會反映在資料來源資料串流 ID，而非 packageName。
session[].application.version string 應用程式的版本。每當應用程式變更會影響資料計算的方式，您就應該更新這個欄位。
session[].application.detailsUrl string 選用的 URI，可用來連結回應用程式。
session[].application.name string 這個應用程式的名稱。此為 REST 用戶端的必要欄位，不過我們不會強制規定此名稱是否重複。方便其他開發人員找出哪個 REST 建立了應用程式或資料來源，方便他們查看上述資料。
session[].activityType integer 這個工作階段代表的活動類型。
deletedSession[] list 如果在要求中將 includeDeleted 設為 True，且省略 startTime 和 endTime，這就會包含自上次同步處理後遭刪除的工作階段。
deletedSession[].id string 用戶端產生的 ID，在這位使用者擁有的所有工作階段專屬。
deletedSession[].name string 人類可讀的工作階段名稱。
deletedSession[].description string 此時段的說明。
deletedSession[].startTimeMillis long 開始時間，以 Epoch 紀元時間起算的毫秒為單位 (含首尾)。
deletedSession[].endTimeMillis long 結束時間，以 Epoch 紀元時間起算的毫秒為單位 (含 Epoch 紀元時間起算)。
deletedSession[].modifiedTimeMillis long 時間戳記，指出工作階段的上次修改時間。
deletedSession[].application nested object 建立工作階段的應用程式。
deletedSession[].application.packageName string 此應用程式的套件名稱。由 Android 應用程式建立時，這會做為專屬 ID，但 REST 用戶端無法指定。REST 用戶端的開發人員專案編號會反映在資料來源資料串流 ID，而非 packageName。
deletedSession[].application.version string 應用程式的版本。每當應用程式變更會影響資料計算的方式，您就應該更新這個欄位。
deletedSession[].application.detailsUrl string 選用的 URI，可用來連結回應用程式。
deletedSession[].application.name string 這個應用程式的名稱。此為 REST 用戶端的必要欄位，不過我們不會強制規定此名稱是否重複。方便其他開發人員找出哪個 REST 建立了應用程式或資料來源，方便他們查看上述資料。
deletedSession[].activityType integer 這個工作階段代表的活動類型。
nextPageToken string 用來同步處理後續變更的同步權杖。只有在要求中同時省略 startTime 和 endTime 時，才會提供這個項目。
session[].activeTimeMillis long 工作階段活動時間。雖然 start_time_millis 和 end_time_millis 會定義完整工作階段時間，但活動時間可以較短，可使用 activity_time_millis 來指定。如果知道工作階段期間的閒置時間，也應透過含有 STILL 活動值的 com.google.activity.segment 資料點插入

deletedSession[].activeTimeMillis long 工作階段活動時間。雖然 start_time_millis 和 end_time_millis 會定義完整工作階段時間，但活動時間可以較短，可使用 activity_time_millis 來指定。如果知道工作階段期間的閒置時間，也應透過含有 STILL 活動值的 com.google.activity.segment 資料點插入

hasMoreData boolean 此標記用於指出伺服器還有其他資料要轉移。請勿使用此欄位。伺服器的回應則一律不會填入這個值。

試試看！

使用下方的 APIs Explorer，針對有效資料呼叫這個方法，然後查看回應。