מעדכנים או מוסיפים סשן נתון. רוצים לנסות עכשיו?
בקשה
בקשת HTTP
PUT https://www.googleapis.com/fitness/v1/users/userId/sessions/sessionId
פרמטרים
שם הפרמטר | ערך | תיאור |
---|---|---|
פרמטרים של נתיב | ||
sessionId |
string |
מזהה הסשן שברצונכם ליצור. |
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 |
מזהה שנוצר על ידי הלקוח והוא ייחודי בכל הסשנים שבבעלות המשתמש הספציפי הזה. | |
name |
string |
שם של הסשן שקריא לבני-אדם. | |
description |
string |
תיאור של הסשן הזה. | |
startTimeMillis |
long |
שעת התחלה, באלפיות שנייה מתקופה של זמן, כולל. | |
endTimeMillis |
long |
שעת סיום, באלפיות שנייה מתקופה של זמן, כולל. | |
modifiedTimeMillis |
long |
חותמת זמן שמציינת מתי השינוי האחרון של הסשן. | |
application |
nested object |
האפליקציה שיצרה את הסשן. | |
application.packageName |
string |
שם החבילה של האפליקציה הזו. ערך זה משמש כמזהה ייחודי כאשר הוא נוצר על ידי אפליקציות ל-Android, אבל לקוחות REST לא יכולים לציין אותו. מספר פרויקט הפיתוח של לקוחות REST ישתקף במזהים של מקורות הנתונים של מקור הנתונים, במקום ב-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 |
מזהה שנוצר על ידי הלקוח והוא ייחודי בכל הסשנים שבבעלות המשתמש הספציפי הזה. | |
name |
string |
שם של הסשן שקריא לבני-אדם. | |
description |
string |
תיאור של הסשן הזה. | |
startTimeMillis |
long |
שעת התחלה, באלפיות שנייה מתקופה של זמן, כולל. | |
endTimeMillis |
long |
שעת סיום, באלפיות שנייה מתקופה של זמן, כולל. | |
modifiedTimeMillis |
long |
חותמת זמן שמציינת מתי השינוי האחרון של הסשן. | |
application |
nested object |
האפליקציה שיצרה את הסשן. | |
application.packageName |
string |
שם החבילה של האפליקציה הזו. ערך זה משמש כמזהה ייחודי כאשר הוא נוצר על ידי אפליקציות ל-Android, אבל לקוחות REST לא יכולים לציין אותו. מספר פרויקט הפיתוח של לקוחות REST ישתקף במזהים של מקורות הנתונים של מקור הנתונים, במקום ב-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 שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.