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 โทเค็นความต่อเนื่องที่ใช้สําหรับการซิงค์ที่เพิ่มขึ้น หากต้องการรับการเปลี่ยนแปลงชุดถัดไป ให้ตั้งค่าพารามิเตอร์นี้เป็นค่า nextPageToken จากการตอบกลับก่อนหน้า ระบบจะละเว้นโทเค็นหน้าเว็บหากมีการระบุเวลาเริ่มต้นหรือเวลาสิ้นสุด หากไม่ได้ระบุเวลาเริ่มต้น เวลาสิ้นสุด และโทเค็นของหน้าเว็บไว้ เซสชันที่มีการแก้ไขในช่วง 30 วันที่ผ่านมาจะถูกส่งคืน
startTime string การประทับเวลา RFC3339 ระบบจะรวมเฉพาะเซสชันที่สิ้นสุดระหว่างเวลาเริ่มต้นและเวลาสิ้นสุดไว้ในคําตอบเสมอ หากไม่ระบุเวลานี้แต่ระบุ endTime ไว้ ระบบจะแสดงเซสชันทั้งหมดตั้งแต่เริ่มต้นจนถึง endTime

การให้สิทธิ์

คําขอนี้ต้องให้สิทธิ์ขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต

ขอบเขต
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 เวลาเริ่มต้นหน่วยเป็นมิลลิวินาทีนับตั้งแต่ Epoch โดยรวม
session[].endTimeMillis long เวลาสิ้นสุดหน่วยเป็นมิลลิวินาทีนับตั้งแต่ Epoch โดยรวม
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 เป็น "จริง" ในคําขอ และไม่สนใจ startTime และ endTime ก็จะรวมเซสชันที่ลบทิ้งตั้งแต่การซิงค์ครั้งล่าสุดไว้ด้วย
deletedSession[].id string ตัวระบุที่ลูกค้าสร้างขึ้นและไม่ซ้ํากันในเซสชันทั้งหมดที่เป็นของผู้ใช้รายนี้
deletedSession[].name string ชื่อเซสชันที่มนุษย์อ่านได้
deletedSession[].description string คําอธิบายเซสชันนี้
deletedSession[].startTimeMillis long เวลาเริ่มต้นหน่วยเป็นมิลลิวินาทีนับตั้งแต่ Epoch โดยรวม
deletedSession[].endTimeMillis long เวลาสิ้นสุดหน่วยเป็นมิลลิวินาทีนับตั้งแต่ Epoch โดยรวม
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.groups ที่มีค่ากิจกรรมว่าง

deletedSession[].activeTimeMillis long เซสชันที่มีการใช้งาน ขณะที่ start_time_millis และ end_time_millis จะกําหนดเวลาทั้งหมดของเซสชัน แต่เวลาที่ใช้งานอาจสั้นลงและระบุด้วย Active_time_millis หากคุณทราบเวลาที่ไม่มีการใช้งานระหว่างเซสชัน ระบบจะแทรกเวลาผ่านจุดข้อมูล com.google.activity.groups ที่มีค่ากิจกรรมว่าง

hasMoreData boolean แจ้งเพื่อระบุว่าเซิร์ฟเวอร์มีข้อมูลที่จะโอนมากขึ้น อย่าใช้ช่องนี้ และจะไม่สร้างในการตอบกลับจากเซิร์ฟเวอร์

ลองใช้เลย

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลสดและดูคําตอบ