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 השם של האפליקציה. זו דרישה ללקוחות Google 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 השם של האפליקציה. זו דרישה ללקוחות Google 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.