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 מזהה שנוצר על ידי הלקוח וייחודי בכל הסשנים שבבעלות המשתמש המסוים הזה.
session[].name string שם קריא (לבני אדם) של הסשן.
session[].description string תיאור של הסשן הזה.
session[].startTimeMillis long שעת התחלה, באלפיות שנייה מאז נקודת ההתחלה, כולל.
session[].endTimeMillis long שעת סיום, באלפיות שנייה מתחילת התקופה, כולל.
session[].modifiedTimeMillis long חותמת זמן שמציינת מתי הסשן השתנה לאחרונה.
session[].application nested object האפליקציה שיצרה את הסשן.
session[].application.packageName string שם החבילה של האפליקציה הזו. המזהה הזה משמש כמזהה ייחודי באפליקציות ל-Android, אבל לקוחות REST לא יכולים לציין אותו. בלקוחות REST מספר פרויקט המפתח שלהם ישתקף במזהים של מקורות הנתונים של מקור הנתונים, במקום ב-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 מזהה שנוצר על ידי הלקוח וייחודי בכל הסשנים שבבעלות המשתמש המסוים הזה.
deletedSession[].name string שם קריא (לבני אדם) של הסשן.
deletedSession[].description string תיאור של הסשן הזה.
deletedSession[].startTimeMillis long שעת התחלה, באלפיות שנייה מאז נקודת ההתחלה, כולל.
deletedSession[].endTimeMillis long שעת סיום, באלפיות שנייה מתחילת התקופה, כולל.
deletedSession[].modifiedTimeMillis long חותמת זמן שמציינת מתי הסשן השתנה לאחרונה.
deletedSession[].application nested object האפליקציה שיצרה את הסשן.
deletedSession[].application.packageName string שם החבילה של האפליקציה הזו. המזהה הזה משמש כמזהה ייחודי באפליקציות ל-Android, אבל לקוחות REST לא יכולים לציין אותו. בלקוחות REST מספר פרויקט המפתח שלהם ישתקף במזהים של מקורות הנתונים של מקור הנתונים, במקום ב-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 עם ערך פעילות STILL

deletedSession[].activeTimeMillis long משך הפעילות של הסשן. הפרמטרים start_time_millis ו-end_time_millis מגדירים את משך הסשן המלא, אבל משך הפעילות יכול להיות קצר יותר ולציין אותו ב-Active_time_millis. אם משך הזמן הלא פעיל במהלך הסשן ידוע, צריך להוסיף אותו גם דרך נקודה על הגרף com.google.activity.segment עם ערך פעילות STILL

hasMoreData boolean סימון שמציין שלשרת יש יותר נתונים להעברה. אין להשתמש בשדה הזה. הוא אף פעם לא מאוכלס בתגובות מהשרת.

נסה בעצמך!

אפשר להשתמש ב-APIs Explorer שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.