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 با یک نوع داده سفارشی ایجاد می کند. انواع داده های سفارشی فقط توسط برنامه ای که آنها را ایجاد کرده قابل خواندن هستند. انواع داده های سفارشی منسوخ شده اند. به جای آن از انواع داده های استاندارد استفاده کنید. علاوه بر فیلدهای منبع داده موجود در شناسه منبع داده، شماره پروژه توسعه دهنده که هنگام ایجاد منبع داده احراز هویت می شود نیز گنجانده شده است. این شماره پروژه توسعه‌دهنده هنگام خواندن توسط هر توسعه‌دهنده دیگری که انواع داده‌های عمومی را می‌خواند مبهم می‌شود.
حذف	DELETE / userId /dataSources/ dataSourceId	منبع داده مشخص شده را حذف می کند. اگر منبع داده حاوی نقاط داده باشد، درخواست با شکست مواجه خواهد شد.
گرفتن	GET / userId /dataSources/ dataSourceId	منبع داده مشخص شده را برمی گرداند.
فهرست	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، مگر اینکه غیر از این ذکر شده باشد
فهرست	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 / userId /dataSources/ dataSourceId /datasets/ datasetId	مجموعه داده ای حاوی تمام نقاط داده را برمی گرداند که زمان شروع و پایان آنها با محدوده مشخص شده حداقل زمان شروع و حداکثر زمان پایان مجموعه داده همپوشانی دارند. به طور خاص، هر نقطه داده ای که زمان شروع آن کمتر یا مساوی با زمان پایان مجموعه داده باشد و زمان پایان آن بزرگتر یا مساوی با زمان شروع مجموعه داده باشد.
پچ	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	یک جلسه مشخص شده توسط شناسه جلسه داده شده را حذف می کند.
فهرست	GET / userId /sessions	جلساتی را که قبلا ایجاد شده اند فهرست می کند.
به روز رسانی	PUT / userId /sessions/ sessionId	به روز رسانی یا درج یک جلسه معین.