Users.sessions: update

מעדכנים או מוסיפים סשן נתון. רוצים לנסות עכשיו?

בקשה

בקשת 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 שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.