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

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

คำขอนี้ต้องได้รับสิทธิ์โดยมีขอบเขตต่อไปนี้อย่างน้อย 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
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
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.segment ที่มีค่ากิจกรรม "ยังคง"

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

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

ลองใช้เลย

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