列出先前建立的工作階段。 立即試用。
要求
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 紀元時間 (含) 起算。 | |
session[].modifiedTimeMillis |
long |
指出上次修改工作階段的時間戳記。 | |
session[].application |
nested object |
建立工作階段的應用程式。 | |
session[].application.packageName |
string |
這個應用程式的套件名稱。在 Android 應用程式建立時,這個 ID 會用來當做專屬 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 紀元時間 (含) 起算。 | |
deletedSession[].modifiedTimeMillis |
long |
指出上次修改工作階段的時間戳記。 | |
deletedSession[].application |
nested object |
建立工作階段的應用程式。 | |
deletedSession[].application.packageName |
string |
這個應用程式的套件名稱。在 Android 應用程式建立時,這個 ID 會用來當做專屬 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 可以定義完整工作階段時間,但活動時間可以較短,並且由 Active_time_millis 指定。如果已知工作階段的閒置時間,應該透過 com.google.activity.segment 資料點,並加入「持續」活動值 |
|
deletedSession[].activeTimeMillis |
long |
工作階段持續時間。start_time_millis 和 end_time_millis 可以定義完整工作階段時間,但活動時間可以較短,並且由 Active_time_millis 指定。如果已知工作階段的閒置時間,應該透過 com.google.activity.segment 資料點,並加入「持續」活動值 |
|
hasMoreData |
boolean |
標記伺服器可移轉更多資料的旗標。請勿使用這個欄位。從伺服器回應時,則一律不會填入任何內容。 |
試試看!
使用下方的 APIs Explorer,針對即時資料呼叫這個方法,看看會有什麼結果。