更新或插入指定工作階段。立即試用。
要求
HTTP 要求
PUT https://www.googleapis.com/fitness/v1/users/userId/sessions/sessionId
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
sessionId |
string |
待建立工作階段的 ID。 |
userId |
string |
為指定的使用者建立工作階段。使用 me 表示已驗證的使用者。目前僅支援 me 。
|
授權
這項要求需要下列範圍的授權:
範圍 |
---|
https://www.googleapis.com/auth/fitness.activity.write |
詳情請參閱驗證與授權頁面。
要求主體
在要求內容中,請按照下列結構提供資料:
{ "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 }
資源名稱 | 值 | 說明 | 附註 |
---|---|---|---|
id |
string |
用戶端產生的 ID,在特定使用者擁有的所有工作階段中都不會重複。 | |
name |
string |
使用者可理解的工作階段名稱。 | |
description |
string |
工作階段說明。 | |
startTimeMillis |
long |
開始時間,以毫秒為單位 (自 Epoch 起算), | |
endTimeMillis |
long |
結束時間 (以毫秒為單位,自 Epoch 起算,含首尾)。 | |
modifiedTimeMillis |
long |
表示工作階段上次修改時間的時間戳記。 | |
application |
nested object |
建立工作階段的應用程式。 | |
application.packageName |
string |
這個應用程式的套件名稱。建立 Android 應用程式時會用來當做專屬 ID,但 REST 用戶端無法指定。REST 用戶端的開發人員 ID 號碼會反映在資料來源資料串流 (而非 packageName) 中。 | |
application.version |
string |
應用程式的版本。只要應用程式變更了會影響資料運算的方式,您就應該更新這個欄位。 | |
application.detailsUrl |
string |
選用的 URI 可用來連結應用程式。 | |
application.name |
string |
這個應用程式的名稱。對 REST 用戶端來說,這是必要步驟,但我們不會強制使用這個名稱。它可供其他開發人員辨識,以便找出哪個 REST 建立應用程式或資料來源。 | |
activityType |
integer |
這個工作階段代表的活動類型。 | |
activeTimeMillis |
long |
工作階段有效時間。雖然 start_time_millis 和 end_time_millis 定義了整個工作階段時間,但活動時間可以較短,而 Active_time_millis 有效。如果已知工作階段期間的閒置時間,系統也應透過 com.google.activity.Segment 資料點與 STILL 活動值插入 |
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "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 }
屬性名稱 | 值 | 說明 | 附註 |
---|---|---|---|
id |
string |
用戶端產生的 ID,在特定使用者擁有的所有工作階段中都不會重複。 | |
name |
string |
使用者可理解的工作階段名稱。 | |
description |
string |
工作階段說明。 | |
startTimeMillis |
long |
開始時間,以毫秒為單位 (自 Epoch 起算), | |
endTimeMillis |
long |
結束時間 (以毫秒為單位,自 Epoch 起算,含首尾)。 | |
modifiedTimeMillis |
long |
表示工作階段上次修改時間的時間戳記。 | |
application |
nested object |
建立工作階段的應用程式。 | |
application.packageName |
string |
這個應用程式的套件名稱。建立 Android 應用程式時會用來當做專屬 ID,但 REST 用戶端無法指定。REST 用戶端的開發人員 ID 號碼會反映在資料來源資料串流 (而非 packageName) 中。 | |
application.version |
string |
應用程式的版本。只要應用程式變更了會影響資料運算的方式,您就應該更新這個欄位。 | |
application.detailsUrl |
string |
選用的 URI 可用來連結應用程式。 | |
application.name |
string |
這個應用程式的名稱。對 REST 用戶端來說,這是必要步驟,但我們不會強制使用這個名稱。它可供其他開發人員辨識,以便找出哪個 REST 建立應用程式或資料來源。 | |
activityType |
integer |
這個工作階段代表的活動類型。 | |
activeTimeMillis |
long |
工作階段有效時間。雖然 start_time_millis 和 end_time_millis 定義了整個工作階段時間,但活動時間可以較短,而 Active_time_millis 有效。如果已知工作階段期間的閒置時間,系統也應透過 com.google.activity.Segment 資料點與 STILL 活動值插入 |
試試看!
使用 APIs Explorer 針對即時資料呼叫這個方法,並查看回應。