ההפניה ל-API מסודרת לפי סוג המשאב. לכל סוג משאב יש ייצוג נתונים אחד או יותר ושיטה אחת או יותר.
סוגי משאבים
- User.dataSources
- User.dataSources.dataPointChanges
- User.dataSources.datasets
- User.dataset
- User.sessions
User.dataSources
לפרטים על משאב User.dataSources, יש לעיין בדף ייצוג משאבים.
| שיטה | בקשת HTTP | תיאור |
|---|---|---|
| מזהי URI ביחס ל-https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת | ||
| יצירה |
POST /userId/dataSources
|
יצירת מקור נתונים חדש וייחודי בכל מקורות הנתונים ששייכים למשתמש זה.
מקור נתונים הוא מקור ייחודי של נתוני חיישנים. מקורות נתונים יכולים לחשוף נתונים גולמיים שמגיעים מחיישני חומרה במכשירים מקומיים או נלווים. הם גם יכולים לחשוף נתונים נגזרים, שנוצרו על ידי המרה או מיזוג של מקורות נתונים אחרים. קיימים מספר מקורות נתונים עבור אותו סוג נתונים. לכל נקודה על הגרף בכל מערך נתונים שהוכנס או נקרא מ-כושר API, יש מקור נתונים משויך. כל מקור נתונים מפיק זרם ייחודי של עדכוני מערך נתונים, עם מזהה מקור נתונים ייחודי. לא כל שינוי במקור הנתונים משפיע על מזהה מקור הנתונים, ולכן נתונים שנאספו באמצעות גרסאות מעודכנות של אותו אפליקציה או מכשיר עדיין עשויים להיחשב כשייכים לאותו מקור נתונים. מקורות הנתונים מזוהים באמצעות מחרוזת שהשרת יוצר, על סמך תוכן המקור שנוצר. אין להגדיר את השדה dataStreamId
כשמפעילים את השיטה הזו. הוא ייווצר באופן אוטומטי על ידי השרת בפורמט הנכון. אם מוגדר dataStreamId, הוא צריך להתאים לפורמט שהשרת יפיק. פורמט זה הוא שילוב של שדות מסוימים ממקור הנתונים, עם סדר ספציפי. אם הבקשה לא תואמת, הבקשה תיכשל ותופיע שגיאה.
ציון סוג נתונים שאינו מסוג ידוע (מתחיל ב-"com.google.") ייצור מקור נתונים עם סוג נתונים מותאם אישית. סוגי נתונים מותאמים אישית ניתנים לקריאה רק על ידי האפליקציה שיצרה אותם. סוגי נתונים מותאמים אישית הוצאו משימוש ובמקום זאת השתמשו בסוגי נתונים רגילים. בנוסף לשדות של מקור הנתונים שכלולים במזהה של מקור הנתונים, כלול מספר הפרויקט למפתחים שאומת בעת יצירת מקור הנתונים. מספר הפרויקט הזה מעורפל (obfuscation) כשקוראים על ידי מפתח אחר שקורא את סוגי הנתונים הציבוריים. |
| מחיקה |
DELETE /userId/dataSources/dataSourceId
|
מחיקת מקור הנתונים שצוין. הבקשה תיכשל אם מקור הנתונים מכיל נקודות נתונים. |
| הורדה |
GET /userId/dataSources/dataSourceId
|
מחזירה את מקור הנתונים שצוין. |
| list |
GET /userId/dataSources
|
רשימה של כל מקורות הנתונים שגלויים למפתח, באמצעות היקפי ה-OAuth שסופקו. זוהי רשימה חלקית בלבד. יכול להיות שלמשתמש יש מקורות נתונים פרטיים שגלויים רק למפתחים אחרים, או שמתקשרים להיקפים אחרים. |
| עדכון |
PUT /userId/dataSources/dataSourceId
|
עדכון מקור הנתונים שצוין. לא ניתן לשנות את המאפיינים dataStreamId,
dataType, type, dataStreamName ו-device, מלבד version.
מקורות הנתונים מזוהים לפי dataStreamId שלהם.
|
User.dataSources.dataPointChanges
בדף ייצוג משאבים אפשר למצוא פרטים על המשאב User.dataSources.dataPointChanges.
| שיטה | בקשת HTTP | תיאור |
|---|---|---|
| מזהי URI ביחס ל-https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת | ||
| list |
GET /userId/dataSources/dataSourceId/dataPointChanges
|
שאילתות לגבי שינויים בנקודות נתונים של משתמש עבור מקור נתונים מסוים. |
User.dataSources.datasets
בדף ייצוג משאבים אפשר למצוא פרטים על המשאב User.dataSources.datasets.
| שיטה | בקשת HTTP | תיאור |
|---|---|---|
| מזהי URI ביחס ל-https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת | ||
| מחיקה |
DELETE /userId/dataSources/dataSourceId/datasets/datasetId
|
מבצע מחיקה מקיפה של כל נקודות הנתונים שזמני ההתחלה והסיום שלהן חופפים לטווח התאריכים שצוין במזהה מערך הנתונים. ברוב סוגי הנתונים הנתונים יימחקו באופן מלא. עבור סוגי נתונים שבהם טווח הזמן מייצג ערך עקבי (למשל, com.google.activity.segment) ונקודות נקודה על הגרף של כל אחת מנקודות הקצה יימחק, רק החלק החופף של נקודת הנתונים יימחק.
|
| הורדה |
GET /userId/dataSources/dataSourceId/datasets/datasetId
|
מחזירה מערך נתונים שמכיל את כל נקודות הנתונים שזמני ההתחלה והסיום שלהן חופפים לטווח שצוין של זמן ההתחלה המינימלי של מערך הנתונים ושעת הסיום המקסימלית. באופן ספציפי, כל נקודת נתונים ששעת ההתחלה שלה נמוכה משעת הסיום של מערך הנתונים או שווה לה, ושעת הסיום שלה גדולה משעת ההתחלה של מערך הנתונים או שווה לו. |
| תיקון |
PATCH /userId/dataSources/dataSourceId/datasets/datasetId
|
הוספת נקודות נתונים למערך נתונים. אין צורך ליצור את מערך הנתונים בעבר.
כל הנקודות במערך הנתונים הזה יוחזרו עם קריאות עוקבות כדי לאחזר את מערך הנתונים. נקודות נתונים יכולות להשתייך ליותר ממערך נתונים אחד.
בשיטה הזו לא משתמשים בסמנטיקה של תיקון: הנקודות על הגרף פשוט מתווספות רק ללא שינוי בנתונים הקיימים. |
User.dataset
פרטים על משאב User.dataset מפורטים בדף ייצוג משאבים.
| שיטה | בקשת HTTP | תיאור |
|---|---|---|
| מזהי URI ביחס ל-https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת | ||
| מצטבר |
POST /userId/dataset:aggregate
|
נצברו נתונים מסוג מסוים או מקור נתונים מסוים לקטגוריות המחולקות לפי סוג גבול נתון. אפשר לקבץ כמה קבוצות נתונים מכמה סוגים וממקורות מרובים לסוג אחד של בקשות בלבד. |
User.sessions
לפרטים על משאב User.sessions, עיינו בדף ייצוג משאבים.
| שיטה | בקשת HTTP | תיאור |
|---|---|---|
| מזהי URI ביחס ל-https://www.googleapis.com/fitness/v1/users, אלא אם צוין אחרת | ||
| מחיקה |
DELETE /userId/sessions/sessionId
|
מחיקת פעילות באתר שצוינה במזהה ההפעלה הנתון. |
| list |
GET /userId/sessions
|
הצגת הסשנים שנוצרו בעבר. |
| עדכון |
PUT /userId/sessions/sessionId
|
מתעדכן או מוסיף סשן נתון. |