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 اگر درست باشد، و اگر هر دو startTime و endTime حذف شوند، حذف‌های جلسه برگردانده می‌شوند.
pageToken string توکن Continuation که برای همگام سازی افزایشی استفاده می شود. برای دریافت دسته بعدی تغییرات، این پارامتر را روی مقدار 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 زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.