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