API Reference

הפניית API הזו מאורגנת לפי סוג המשאב. כל סוג משאב מכיל ייצוג אחד או יותר של נתונים ושיטה אחת או יותר.

סוגי המשאבים

1. Users.dataSources
2. Users.dataSources.dataPointChanges
3. Users.dataSources.datasets
4. Users.dataset
5. Users.sessions

Users.dataSources

לפרטי המשאבים של Users.dataSources, עיינו בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת
יצירה	POST  /userId/dataSources	יצירת מקור נתונים חדש שיהיה ייחודי לכל מקורות הנתונים ששייכים למשתמש הזה. מקור נתונים הוא מקור ייחודי של נתוני חיישנים. מקורות נתונים יכולים לחשוף נתונים גולמיים שמגיעים מחיישני חומרה במכשירים מקומיים או במכשירים נלווים. הם יכולים גם לחשוף נתונים נגזרים שנוצרו על ידי טרנספורמציה או מיזוג של מקורות נתונים אחרים. יכולים להיות כמה מקורות נתונים לאותו סוג נתונים. לכל נקודת נתונים בכל מערך נתונים שמוסיפים ל-Fitness API או שנקראים ממנו, יש מקור נתונים משויך. כל מקור נתונים יוצר זרם ייחודי של עדכונים למערכי נתונים, עם מזהה ייחודי של מקור נתונים. לא כל השינויים במקור הנתונים משפיעים על המזהה של מקור הנתונים, כך שנתונים שנאספו על ידי גרסאות מעודכנות של אותה אפליקציה/מכשיר עדיין יכולים להיחשב כשייכים לאותו מקור נתונים. מקורות נתונים מזוהים באמצעות מחרוזת שנוצרה על ידי השרת על סמך תוכן המקור שנוצר. לא כדאי להגדיר את השדה dataStreamId כשמפעילים את השיטה הזו. הוא ייווצר באופן אוטומטי על ידי השרת בפורמט הנכון. אם מוגדר dataStreamId, הוא צריך להתאים לפורמט שהשרת יוצר. הפורמט הזה הוא שילוב של כמה שדות ממקור הנתונים, ויש לו סדר ספציפי. במקרה שהשם לא תואם, הבקשה תיכשל ותופיע שגיאה. ציון DataType שאינו סוג ידוע (מתחיל ב-"com.google") ייצור מקור DataSource עם סוג נתונים מותאם אישית. רק האפליקציה שיצרה אותם יכולה לקרוא סוגי נתונים מותאמים אישית. סוגי נתונים מותאמים אישית מוציאים משימוש, ובמקום זאת יש להשתמש בסוגי נתונים סטנדרטיים. בנוסף לשדות של מקור הנתונים שכלולים במזהה של מקור הנתונים, נכלל מספר הפרויקט של המפתח שאומת כשיוצרים את מקור הנתונים. מספר פרויקט הפיתוח הזה מעורפל (obfuscation) כשמפתחים אחרים קוראים סוגי נתונים ציבוריים.
מחיקה	DELETE  /userId/dataSources/dataSourceId	מחיקת מקור הנתונים שצוין. הבקשה תיכשל אם מקור הנתונים מכיל נקודות נתונים.
get	GET  /userId/dataSources/dataSourceId	מחזירה את מקור הנתונים שצוין.
list	GET  /userId/dataSources	רשימה של כל מקורות הנתונים שגלויים למפתח, באמצעות היקפי ה-OAuth שסופקו. הרשימה הזו חלקית בלבד. יכול להיות שלמשתמש יש מקורות נתונים פרטיים שגלויים רק למפתחים אחרים, או שיחות בהיקפים אחרים.
עדכון	PUT  /userId/dataSources/dataSourceId	עדכון של מקור הנתונים שצוין. לא ניתן לשנות את המאפיינים dataStreamId, dataType, type, dataStreamName ו-device חוץ מ-version. מקורות נתונים מזוהים לפי dataStreamId.

Users.dataSources.dataPointChanges

אפשר לעיין בפרטי המשאבים של Users.dataSources.dataPointChanges בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת
list	GET  /userId/dataSources/dataSourceId/dataPointChanges	שינויים בשאילתות של משתמש בנקודת הנתונים על מקור נתונים מסוים.

Users.dataSources.datasets

אפשר לעיין בפרטי המשאבים של Users.dataSources.datasets בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת
מחיקה	DELETE  /userId/dataSources/dataSourceId/datasets/datasetId	הפונקציה מבצעת מחיקה כוללת של כל נקודות הנתונים שמועדי ההתחלה והסיום שלהן חופפים לטווח הזמן שצוין במזהה מערך הנתונים. ברוב סוגי הנתונים תימחק כל הנקודה על הגרף. בסוגי נתונים שבהם טווח הזמן מייצג ערך עקבי (כמו com.google.activity.segment) ונקודת נתונים שחופפת לנקודת הקצה של מערך הנתונים, יימחק רק החלק החופף של נקודת הנתונים.
get	GET  /userId/dataSources/dataSourceId/datasets/datasetId	מחזירה מערך נתונים שמכיל את כל נקודות הנתונים שזמני ההתחלה והסיום שלהן חופפים לטווח שצוין של זמן ההתחלה המינימלי וזמן הסיום המקסימלי של מערך הנתונים. באופן ספציפי, כל נקודה על הגרף ששעת ההתחלה שלה קטנה משעת הסיום של מערך הנתונים או שווה לה, ושעת הסיום שלה גדולה משעת ההתחלה של מערך הנתונים או שווה לה.
patch	PATCH  /userId/dataSources/dataSourceId/datasets/datasetId	מחברת נקודות על הגרף למערך נתונים. אין צורך ליצור את מערך הנתונים לפני כן. כל הנקודות במערך הנתונים הזה יוחזרו עם הקריאות הבאות כדי לאחזר את מערך הנתונים. נקודות על הגרף יכולות להשתייך ליותר ממערך נתונים אחד. בשיטה הזו לא משתמשים בסמנטיקה של תיקונים: הנקודות על הגרף רק מוכנסות, ולא מתבצעת החלפה של הנתונים הקיימים.

Users.dataset

לפרטי המשאבים של Users.dataset, אפשר לעיין בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת
צבירה	POST  /userId/dataset:aggregate	נתונים מסוג מסוים או מקור נתונים מסוים נצברים לקטגוריות לפי סוג נתון של תחום. אפשר לקבץ כמה קבוצות נתונים מכמה סוגים וממספר מקורות, כדי ליצור קטגוריה אחת בדיוק לסוג אחד בכל בקשה.

Users.sessions

לפרטי המשאבים של Users.sessions, ניתן לעיין בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת
מחיקה	DELETE  /userId/sessions/sessionId	מוחק סשן שצוין לפי מזהה הסשן הנתון.
list	GET  /userId/sessions	בתיבת הדו-שיח הזו מפורטים סשנים שנוצרו בעבר.
עדכון	PUT  /userId/sessions/sessionId	מעדכנים או מוסיפים סשן נתון.